com.esri.arcgis.location.ESRIGen2AddressLocatorStyle
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class ESRIGen2AddressLocatorStyle
An address locator style that uses the Esri geocoding engine introduced in ArcGIS version 10.0.
An ESRIGen2AddressLocatorStyle is an address locator style that can be used to create locators that use the ESRI geocoding engine introduced in ArcGIS version 10.0.
| Constructor Summary | |
|---|---|
ESRIGen2AddressLocatorStyle(Object obj)
Construct a ESRIGen2AddressLocatorStyle using a reference to such an object returned from ArcGIS Engine or Server. |
|
| Method Summary | |
|---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
IFields |
getAddressFields()
Fields needed to geocode a table of addresses. |
String |
getAliasField()
Name of the alias field. |
Object |
getBuildTime()
The date and time the locator was built. |
String |
getCategory()
Category of the locator. |
Object |
getDefaultAliasFieldNames()
Recognized names for the address fields in the place name alias table. |
Object |
getDefaultInputFieldNames()
Recognized names for the single line input field. |
Object |
getDefaultInputFieldNames(String addressField)
Recognized names for an input field. |
String |
getDescription()
Description of the locator. |
int |
getEndOffset()
End offset percentage. |
double |
getEndOffsetDistance()
End offset using either distance or percentage. |
int |
getEndOffsetDistanceUnits()
Units used for the end offset. |
String |
getGDBVersionName()
The name of the GDB version the locator is built against. |
String |
getIntersectionConnectors()
Connector strings used to designate intersections. |
IFields |
getMatchFields()
Fields contained in the geocoding result. |
int |
getMinimumCandidateScore()
Minimum candidate score setting. |
int |
getMinimumMatchScore()
Minimum match score setting. |
String |
getName()
Name of the locator. |
String |
getRelease()
The description of locator release. |
double |
getSearchDistance()
Search distance. |
int |
getSearchDistanceUnits()
Units used for the search distance. |
double |
getSideOffset()
Side offset distance. |
int |
getSideOffsetUnits()
Units used for the side offset. |
IFields |
getSimpleStandardizeFields()
Fields contained in a standardized address. |
IField |
getSingleLineAddressField()
Field needed to geocode a single line address. |
int |
getSpellingSensitivity()
Spelling sensitivity setting. |
ITableName |
getTable()
Name object for the place name alias table. |
IEnumReferenceDataTable |
getTables()
The reference data tables used by the locator. |
ILocatorUI |
getUserInterface()
User interface for the locator. |
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
String |
IPlaceNameAlias_getAddressFields()
Names of the address fields. |
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 |
isEmbedGeocodingRules()
Indicates if the locator should contain a copy of geocoding rules it uses. |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isHasEnoughInfo()
Indicates if the locator has sufficient reference data in order to geocode. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isMatchIfScoresTie()
Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score. |
boolean |
isStoreStandardizedRefData()
Indicates if the locator should store information extracted from the reference data in a standardized form. |
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 |
setAddressFields(String fieldList)
Names of the address fields. |
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 |
setAliasField(String name)
Name of the alias field. |
void |
setDefaultAliasFieldNames(Object names)
Recognized names for the address fields in the place name alias table. |
void |
setDefaultInputFieldNames(String addressField,
Object rhs2)
Recognized names for a required input field. |
void |
setDescription(String description)
Description of the locator. |
void |
setEmbedGeocodingRules(boolean rhs1)
Indicates if the locator should contain a copy of geocoding rules it uses. |
void |
setEndOffset(int endOffset)
End offset percentage. |
void |
setEndOffsetDistance(double endOffset)
End offset using either distance or percentage. |
void |
setEndOffsetDistanceUnits(int endOffsetDistanceUnits)
Units used for the end offset. |
void |
setGDBVersionName(String rhs1)
The name of the GDB version the locator is built against. |
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 |
setSearchDistance(double searchDistance)
Search distance. |
void |
setSearchDistanceUnits(int searchDistanceUnits)
Units used for the search distance. |
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 |
setStoreStandardizedRefData(boolean rhs1)
Indicates if the locator should store information extracted from the reference data in a standardized form. |
void |
setTableByRef(ITableName name)
Name object for the place name alias table. |
void |
setUseRelativePaths(boolean bUseRelativePaths)
Indicates if the paths to the reference data should be stored relative to the locator. |
IPropertySet |
simpleStandardizeAddress(String address)
Standardize a single address. |
void |
simpleStandardizeTable(ITable inputTable,
String inputFieldsToConcatinate,
String whereClause,
ITable outputTable,
String outputFieldNames,
IPropertySet fieldsToCopy,
ITrackCancel cancelTracker)
Standardize a table of addresses. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public ESRIGen2AddressLocatorStyle(Object obj)
throws IOException
obj to ESRIGen2AddressLocatorStyle. *
ESRIGen2AddressLocatorStyle o = (ESRIGen2AddressLocatorStyle)obj; // will not work
ESRIGen2AddressLocatorStyle o = new ESRIGen2AddressLocatorStyle(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
IOException - if there are interop problems
ESRIGen2AddressLocatorStyle theESRIGen2AddressLocatorStyle = (ESRIGen2AddressLocatorStyle) obj;| Method Detail |
|---|
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public String getName()
throws IOException,
AutomationException
Locators and locator styles stored in an ArcSDE locator workspace are prefixed by the name of the ArcSDE user that owns the locator styles, as in "SDE.US Streets with Zone".
getName in interface ILocatorIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDescription()
throws IOException,
AutomationException
getDescription in interface ILocatorIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDescription(String description)
throws IOException,
AutomationException
setDescription in interface ILocatordescription - The description (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCategory()
throws IOException,
AutomationException
The Category property returns a string indicating the category to which the locator belongs. There are two categories that are defined for locators provided with ArcGIS:
getCategory in interface ILocatorIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILocatorUI getUserInterface()
throws IOException,
AutomationException
The UserInterface property returns an object that you can use to display the user interfaces for the locator.
getUserInterface in interface ILocatorIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getBuildTime()
throws IOException,
AutomationException
The BulidTime property returns the date and time the locator was built.
getBuildTime in interface ILocator2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getAddressFields()
throws IOException,
AutomationException
The AddressFields property returns a Fields object that specifies the fields that the locator uses to geocode addresses. The IField::Name property of each Field object in the collection is the internal field name used by the locator.
The IField::Required property of each Field indicates whether or not the locator requires this field to geocode addresses. Fields with a Required value of False are not required by the Locator, but may improve the match scores of the addresses.
You can use the Fields returned by this property to determine which fields in a table contain address information using the DefaultInputFieldNames property.
getAddressFields in interface IAddressInputsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getDefaultInputFieldNames(String addressField)
throws IOException,
AutomationException
getDefaultInputFieldNames in interface IAddressInputsaddressField - The addressField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws IOException,
AutomationException
esri_clone in interface ICloneIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws IOException,
AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws IOException,
AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setStoreStandardizedRefData(boolean rhs1)
throws IOException,
AutomationException
setStoreStandardizedRefData in interface IESRILocatorBuildOptionsEditrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEmbedGeocodingRules(boolean rhs1)
throws IOException,
AutomationException
setEmbedGeocodingRules in interface IESRILocatorBuildOptionsEditrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setGDBVersionName(String rhs1)
throws IOException,
AutomationException
setGDBVersionName in interface IESRILocatorBuildOptionsEditrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isStoreStandardizedRefData()
throws IOException,
AutomationException
isStoreStandardizedRefData in interface IESRILocatorBuildOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEmbedGeocodingRules()
throws IOException,
AutomationException
isEmbedGeocodingRules in interface IESRILocatorBuildOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getGDBVersionName()
throws IOException,
AutomationException
getGDBVersionName in interface IESRILocatorBuildOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getMinimumMatchScore in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMinimumMatchScore(int minimumMatchScore)
throws IOException,
AutomationException
setMinimumMatchScore in interface IGeocodingPropertiesminimumMatchScore - The minimumMatchScore (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getMinimumCandidateScore in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMinimumCandidateScore(int minimumCandidateScore)
throws IOException,
AutomationException
setMinimumCandidateScore in interface IGeocodingPropertiesminimumCandidateScore - The minimumCandidateScore (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getSpellingSensitivity in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSpellingSensitivity(int spellingSensitivity)
throws IOException,
AutomationException
setSpellingSensitivity in interface IGeocodingPropertiesspellingSensitivity - The spellingSensitivity (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getEndOffset in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEndOffset(int endOffset)
throws IOException,
AutomationException
setEndOffset in interface IGeocodingPropertiesendOffset - The endOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getSideOffset in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSideOffset(double sideOffset)
throws IOException,
AutomationException
setSideOffset in interface IGeocodingPropertiessideOffset - The sideOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getSideOffsetUnits in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSideOffsetUnits(int sideOffsetUnits)
throws IOException,
AutomationException
setSideOffsetUnits in interface IGeocodingPropertiessideOffsetUnits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
isAddXYCoordsToMatchFields in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields)
throws IOException,
AutomationException
setAddXYCoordsToMatchFields in interface IGeocodingPropertiesbAddXYCoordsToMatchFields - The bAddXYCoordsToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
isAddStandardizeStringToMatchFields in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields)
throws IOException,
AutomationException
setAddStandardizeStringToMatchFields in interface IGeocodingPropertiesbAddStandardizeStringToMatchFields - The bAddStandardizeStringToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
isAddReferenceIDToMatchFields in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields)
throws IOException,
AutomationException
setAddReferenceIDToMatchFields in interface IGeocodingPropertiesbAddReferenceIDToMatchFields - The bAddReferenceIDToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
isAddPercentAlongToMatchFields in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields)
throws IOException,
AutomationException
setAddPercentAlongToMatchFields in interface IGeocodingPropertiesbAddPercentAlongToMatchFields - The bAddPercentAlongToMatchFields (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
isMatchIfScoresTie in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMatchIfScoresTie(boolean bMatchIfScoresTie)
throws IOException,
AutomationException
setMatchIfScoresTie in interface IGeocodingPropertiesbMatchIfScoresTie - The bMatchIfScoresTie (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultInputFieldNames(String addressField,
Object rhs2)
throws IOException,
AutomationException
setDefaultInputFieldNames in interface IGeocodingPropertiesaddressField - The addressField (in)rhs2 - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
getIntersectionConnectors in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setIntersectionConnectors(String intersectionConnectors)
throws IOException,
AutomationException
setIntersectionConnectors in interface IGeocodingPropertiesintersectionConnectors - The intersectionConnectors (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public 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.
isUseRelativePaths in interface IGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseRelativePaths(boolean bUseRelativePaths)
throws IOException,
AutomationException
setUseRelativePaths in interface IGeocodingPropertiesbUseRelativePaths - The bUseRelativePaths (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getEndOffsetDistance()
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 EndOffsetDistance property specifies by what amount to offset geocoded locations from the end of reference data features, and is expressed as either a percentage of the length of the reference feature, between 0.0 percent and 50.0 percent, or as a set distance.
getEndOffsetDistance in interface IGeocodingProperties2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEndOffsetDistance(double endOffset)
throws IOException,
AutomationException
setEndOffsetDistance in interface IGeocodingProperties2endOffset - The endOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getEndOffsetDistanceUnits()
throws IOException,
AutomationException
Locators that use polyline features as reference data interpolate positions along reference data features for geocoded addresses. For those locators, you can specify an end offset using the EndOffsetDistance property, which specifies by what amount to offset geocoded locations from the end of reference data features. The EndOffsetDistanceUnits property specifies the units for the end offset.
You can use these properties 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). By default, the value of the EndOffsetDistanceUnits property is esriUnknownUnits, which indicates to use the reference data’s units.
getEndOffsetDistanceUnits in interface IGeocodingProperties2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEndOffsetDistanceUnits(int endOffsetDistanceUnits)
throws IOException,
AutomationException
setEndOffsetDistanceUnits in interface IGeocodingProperties2endOffsetDistanceUnits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getMatchFields()
throws IOException,
AutomationException
getMatchFields in interface IGeocodingOutputsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITableName getTable()
throws IOException,
AutomationException
Locators can use place name alias tables during the geocoding process. A place name alias table is a table that contains place names (for example, "City Hall"), and the addresses for those places. When geocoding, the locator searches the place name alias table for matches to the input address. If a match is found, then locator replaces the input address with the corresponding address from the place name alias table. In this way, you can geocode addresses by place name, without having to know the proper street address for those places.
The Table property returns a reference to a TableName object representing the place name alias table.
When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.
getTable in interface IPlaceNameAliasIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTableByRef(ITableName name)
throws IOException,
AutomationException
setTableByRef in interface IPlaceNameAliasname - A reference to a com.esri.arcgis.geodatabase.ITableName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getAliasField()
throws IOException,
AutomationException
The AliasField property returns the name of the field in the place name alias table that contains the place name aliases.
When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.
getAliasField in interface IPlaceNameAliasIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAliasField(String name)
throws IOException,
AutomationException
setAliasField in interface IPlaceNameAliasname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String IPlaceNameAlias_getAddressFields()
throws IOException,
AutomationException
IPlaceNameAlias_getAddressFields in interface IPlaceNameAliasIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAddressFields(String fieldList)
throws IOException,
AutomationException
setAddressFields in interface IPlaceNameAliasfieldList - The fieldList (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getDefaultAliasFieldNames()
throws IOException,
AutomationException
The DefaultAliasFieldNames property is an array of strings containing recognized field names for the alias field in a place name alias table. You can use the contents of this array to search through your place name alias table to determine which field contains the place name alias information. If the locator contains no default alias field names, calling this property returns an error.
When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.
getDefaultAliasFieldNames in interface IPlaceNameAliasIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultAliasFieldNames(Object names)
throws IOException,
AutomationException
setDefaultAliasFieldNames in interface IPlaceNameAliasnames - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getRelease()
throws IOException,
AutomationException
getRelease in interface IESRILocatorReleaseInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumReferenceDataTable getTables()
throws IOException,
AutomationException
The Tables property returns an enumeration of reference data tables that you can use to specify the feature-data-object data sources that the locator uses as reference data.
getTables in interface IReferenceDataTablesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ReferenceDataIndex,
IReferenceDataFieldEdit,
ReferenceDataFieldsEnumerator,
ReferenceDataTableEnumerator,
IReferenceDataField,
IReferenceDataTableEdit,
ESRIFDOAddressLocator,
IReferenceDataFile.getPathName(),
StreetMapAddressLocator,
IEnumReferenceDataField,
IReferenceDataFile,
IReferenceDataTable,
IReferenceDataTables,
IReferenceDataTables.getTables(),
ReferenceDataField,
IReferenceDataFile.getFilters(),
IEnumReferenceDataTable,
ReferenceDataTable,
IAddressGeocoding.validate(),
ReferenceDataIndexEnumerator,
IEnumReferenceDataIndex
public boolean isHasEnoughInfo()
throws IOException,
AutomationException
Use the HasEnoughInfo property to determine if all of the required information has been specified for the locator's reference data. After you have specified the reference data information for the locator using the Tables property, check the HasEnoughInfo property before adding the locator to a locator workspace.
isHasEnoughInfo in interface IReferenceDataTablesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ReferenceDataIndex,
IReferenceDataFieldEdit,
ReferenceDataFieldsEnumerator,
ReferenceDataTableEnumerator,
IReferenceDataField,
IReferenceDataTableEdit,
ESRIFDOAddressLocator,
IReferenceDataFile.getPathName(),
StreetMapAddressLocator,
IEnumReferenceDataField,
IReferenceDataFile,
IReferenceDataTable,
IReferenceDataTables,
IReferenceDataTables.getTables(),
ReferenceDataField,
IReferenceDataFile.getFilters(),
IEnumReferenceDataTable,
ReferenceDataTable,
IAddressGeocoding.validate(),
ReferenceDataIndexEnumerator,
IEnumReferenceDataIndex
public double getSearchDistance()
throws IOException,
AutomationException
getSearchDistance in interface IReverseGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSearchDistance(double searchDistance)
throws IOException,
AutomationException
setSearchDistance in interface IReverseGeocodingPropertiessearchDistance - The searchDistance (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSearchDistanceUnits()
throws IOException,
AutomationException
getSearchDistanceUnits in interface IReverseGeocodingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSearchDistanceUnits(int searchDistanceUnits)
throws IOException,
AutomationException
setSearchDistanceUnits in interface IReverseGeocodingPropertiessearchDistanceUnits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void simpleStandardizeTable(ITable inputTable,
String inputFieldsToConcatinate,
String whereClause,
ITable outputTable,
String outputFieldNames,
IPropertySet fieldsToCopy,
ITrackCancel cancelTracker)
throws IOException,
AutomationException
simpleStandardizeTable in interface ISimpleStandardizationinputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)inputFieldsToConcatinate - The inputFieldsToConcatinate (in)whereClause - The whereClause (in)outputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)outputFieldNames - The outputFieldNames (in)fieldsToCopy - A reference to a com.esri.arcgis.system.IPropertySet (in)cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getSimpleStandardizeFields()
throws IOException,
AutomationException
getSimpleStandardizeFields in interface ISimpleStandardizationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet simpleStandardizeAddress(String address)
throws IOException,
AutomationException
simpleStandardizeAddress in interface ISimpleStandardizationaddress - The address (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IField getSingleLineAddressField()
throws IOException,
AutomationException
The SingleLineAddressField property returns a Field object that specifies the field that the locator uses to geocode addresses in a single line format. The IField::Name property is the internal field name used by the locator.
You can use the Field returned by this property to determine which field in a table contains address information using the DefaultInputFieldNames property.
getSingleLineAddressField in interface ISingleLineAddressInputIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getDefaultInputFieldNames()
throws IOException,
AutomationException
The DefaultInputFieldNames property returns an Array of field names that you can use to determine which field in an address table contains the full address for single line geocoding.
getDefaultInputFieldNames in interface ISingleLineAddressInputIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws IOException,
AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (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 | ||||||||