|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IGeocodingProperties
Provides access to members that control geocoding settings.
Use the IGeocodingProperties interface to inspect and set properties specific to address locators that use the ESRI geocoding engine.
| Method Summary | |
|---|---|
int |
getEndOffset()
End offset percentage. |
String |
getIntersectionConnectors()
Connector strings used to designate intersections. |
int |
getMinimumCandidateScore()
Minimum candidate score setting. |
int |
getMinimumMatchScore()
Minimum match score setting. |
double |
getSideOffset()
Side offset distance. |
int |
getSideOffsetUnits()
Units used for the side offset. |
int |
getSpellingSensitivity()
Spelling sensitivity setting. |
boolean |
isAddPercentAlongToMatchFields()
Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result. |
boolean |
isAddReferenceIDToMatchFields()
Indicates if the feature ID of the matched feature is included in the geocoding result. |
boolean |
isAddStandardizeStringToMatchFields()
Indicates if the standardized address is included in the geocoding result. |
boolean |
isAddXYCoordsToMatchFields()
Indicates if the x and y coordinates of the address location are included in the geocoding result. |
boolean |
isMatchIfScoresTie()
Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score. |
boolean |
isUseRelativePaths()
Indicates if the paths to the reference data should be stored relative to the locator. |
void |
setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields)
Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result. |
void |
setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields)
Indicates if the feature ID of the matched feature is included in the geocoding result. |
void |
setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields)
Indicates if the standardized address is included in the geocoding result. |
void |
setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields)
Indicates if the x and y coordinates of the address location are included in the geocoding result. |
void |
setDefaultInputFieldNames(String addressField,
Object rhs2)
Recognized names for a required input field. |
void |
setEndOffset(int endOffset)
End offset percentage. |
void |
setIntersectionConnectors(String intersectionConnectors)
Connector strings used to designate intersections. |
void |
setMatchIfScoresTie(boolean bMatchIfScoresTie)
Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score. |
void |
setMinimumCandidateScore(int minimumCandidateScore)
Minimum candidate score setting. |
void |
setMinimumMatchScore(int minimumMatchScore)
Minimum match score setting. |
void |
setSideOffset(double sideOffset)
Side offset distance. |
void |
setSideOffsetUnits(int sideOffsetUnits)
Units used for the side offset. |
void |
setSpellingSensitivity(int spellingSensitivity)
Spelling sensitivity setting. |
void |
setUseRelativePaths(boolean bUseRelativePaths)
Indicates if the paths to the reference data should be stored relative to the locator. |
| Methods inherited from interface com.esri.arcgis.location.IAddressInputs |
|---|
getAddressFields, getDefaultInputFieldNames |
| Method Detail |
|---|
int getMinimumMatchScore()
throws IOException,
AutomationException
The MinimumMatchScore property specifies how well addresses have to match their most likely candidate in the reference data in order to be considered matched. A perfect match yields a score of 100. A match score between 75 and 100 can generally be considered a good match, depending upon the quality of your reference and address data. An address with no candidates with scores euqal to or greater than the minimum match score will not be matched.
The MinimumMatchScore property can have values between 0 and 100. If your application demands that addresses be located with a high level of confidence, you should specify a high value. If you want to maximize the number of addresses that can be matched and don’t mind if some addresses are potentially matched incorrectly, you can use a lower value.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMinimumMatchScore(int minimumMatchScore)
throws IOException,
AutomationException
minimumMatchScore - The minimumMatchScore (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getMinimumCandidateScore()
throws IOException,
AutomationException
Locators use the MinimumCandidateScore setting to filter the set of candidates that are returned by the IAddressCandidates::FindAddressCandidates, IAdvancedGeocoding::FindStandardizedAddressCandidates, and IAdvancedIntersectionGeocoding::FindStandardizedIntersectionCandidates methods. Only candidates with a score greater than the minimum candidate score will be returned by these methods.
The minimum candidate score for a locator can have values between 0 and 100. If the Locator is unable to come up with any likely candidates for an address that you want to geocode, you can specify a lower value so that candidates with very low scores are considered.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMinimumCandidateScore(int minimumCandidateScore)
throws IOException,
AutomationException
minimumCandidateScore - The minimumCandidateScore (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getSpellingSensitivity()
throws IOException,
AutomationException
The SpellingSensitivity property controls how much variation the locator will allow when it searches for likely candidates in the reference data. A low value for spelling sensitivity will allow “Mane”, “Maine”, and “Man” to be treated as match candidates for “Main”. A higher value will restrict candidates to exact matches. The spelling sensitivity does not affect the match score of each candidate; it only controls how many candidates the locator considers. The locator then computes the match score of each candidate and ranks the candidates by score.
The SpellingSensitivity property can have values between 0 and 100. If you are sure that your addresses are spelled correctly, you can specify a higher value for the SpellingSensitivity. However, if you think that your addresses may contain spelling errors, then you should specify a lower value.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSpellingSensitivity(int spellingSensitivity)
throws IOException,
AutomationException
spellingSensitivity - The spellingSensitivity (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getEndOffset()
throws IOException,
AutomationException
Locators that use polyline features as reference data interpolate positions along reference data features for geocoded addresses. In order to prevent features that are located at the end of a reference data feature from falling on top of other features (for example, a cross street), the locator can apply a “squeeze factor”, or end offset, to the location of a geocoded address.
The EndOffset property specifies by what amount to offset geocoded locations from the end of reference data features, and is expressed as a percentage of the length of the reference feature, between 0 percent and 50 percent. An EndOffset value of 0 will not offset features from the end of the reference feature. An EndOffset value of 50 percent will locate all geocoded addresses at the middle of the reference feature.
Warning: Do not use EndOffset in combination with EndOffsetDistanceUnits from IGeocodingProperties2 because it may produce some unexpected results. Use EndOffsetDistance in combination with EndOffsetDistanceUnits instead.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setEndOffset(int endOffset)
throws IOException,
AutomationException
endOffset - The endOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getSideOffset()
throws IOException,
AutomationException
Some locators support geocoding addresses to a particular side of a street. For those locators, you can specify a side offset using the SideOffset property, which specifies how far from the correct side of the street geocoded addresses should be offset. The SideOffsetUnits property specifies the units for the side offset.
You can use these properties to improve the cartographic appearance of your geocoded feature classes. By default, the value of the SideOffsetUnits property is esriUnknownUnits, which indicates to use the reference data’s units.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSideOffset(double sideOffset)
throws IOException,
AutomationException
sideOffset - The sideOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getSideOffsetUnits()
throws IOException,
AutomationException
Some locators support geocoding addresses to a particular side of a street. For those locators, you can specify a side offset using the SideOffset property, which specifies how far from the correct side of the street geocoded addresses should be offset. The SideOffsetUnits property specifies the units for the side offset.
You can use these properties to improve the cartographic appearance of your geocoded feature classes. By default, the value of the SideOffsetUnits property is esriUnknownUnits, which indicates to use the reference data’s units.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSideOffsetUnits(int sideOffsetUnits)
throws IOException,
AutomationException
sideOffsetUnits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isAddXYCoordsToMatchFields()
throws IOException,
AutomationException
The AddXYCoordsToMatchFields property indicates if the matches returned by the locator have attributes representing the x and y coordinates of the geocoded locations. If this property has a value of True, then the locator will return two additional attributes for matches — one each for the x and y coordinates of the geocoded features. These attributes will be included in the match fields for the locator.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields)
throws IOException,
AutomationException
bAddXYCoordsToMatchFields - The bAddXYCoordsToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isAddStandardizeStringToMatchFields()
throws IOException,
AutomationException
The AddStandardizeStringToMatchFields property indicates if the matches returned by the locator have an attribute containing a string representing the standardization of the address. The standardization string is a string with each component of the standardized address separated by pipe ("|") characters. If this property has a value of True, then this attribute will be included in the match fields for the locator.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields)
throws IOException,
AutomationException
bAddStandardizeStringToMatchFields - The bAddStandardizeStringToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isAddReferenceIDToMatchFields()
throws IOException,
AutomationException
The AddReferenceIDToMatchFields property indicates if the matches returned by the locator have an attribute containing the FeatureID of the reference data feature to which the address was matched. If this property has a value of True, then this attribute will be included in the match fields for the locator.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields)
throws IOException,
AutomationException
bAddReferenceIDToMatchFields - The bAddReferenceIDToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isAddPercentAlongToMatchFields()
throws IOException,
AutomationException
For locators that interpolate geocoded locations along polyline reference data features, the AddPercentAlongToMatchFields property indicates if the matches returned by the locator have an attribute containing the percentage along the reference data feature at which the address was located, with values between 0 and 100. If this property has a value of True, then this attribute will be included in the match fields for the locator.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields)
throws IOException,
AutomationException
bAddPercentAlongToMatchFields - The bAddPercentAlongToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isMatchIfScoresTie()
throws IOException,
AutomationException
If the locator finds two or more candidates with the same best candidate score, and that score is greater than the minimum match score, then you can use the MatchIfCandidatesTie property to specify whether or not the locator should arbitrarily match the address to one of those candidates. If so, the locator will match the address to the first of these candidates that
it encounters.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMatchIfScoresTie(boolean bMatchIfScoresTie)
throws IOException,
AutomationException
bMatchIfScoresTie - The bMatchIfScoresTie (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setDefaultInputFieldNames(String addressField,
Object rhs2)
throws IOException,
AutomationException
addressField - The addressField (in)rhs2 - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
String getIntersectionConnectors()
throws IOException,
AutomationException
The IntersectionConnectors property lets you specify strings that are used to delimit intersection addresses. Some address locators can geocode intersection addresses such as "New York St. & W. Redlands Blvd.". This property is a string containing all of the strings that can be used to delimit intersections (such as "&", "AND", or "AT"). Each intersection connector is separated by a space in this string.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setIntersectionConnectors(String intersectionConnectors)
throws IOException,
AutomationException
intersectionConnectors - The intersectionConnectors (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isUseRelativePaths()
throws IOException,
AutomationException
The UseRelativePaths property indicates if the locator stores paths to reference data sources as relative path names. Storing paths to reference data sources as relative paths names allows users to copy a locator and its reference data between folders in ArcCatalog without invalidating the locator. It also allows users to access the same locator from a shared network directory.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setUseRelativePaths(boolean bUseRelativePaths)
throws IOException,
AutomationException
bUseRelativePaths - The bUseRelativePaths (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||