com.esri.arcgis.location
Class ESRIFDOAddressLocatorStyle

java.lang.Object
  com.esri.arcgis.location.ESRIFDOAddressLocatorStyle

All Implemented Interfaces:

ILocator, ILocatorStyle, com.esri.arcgis.interop.RemoteObjRef, IAddressInputs, IESRILocatorBuildOptions, IESRILocatorBuildOptionsEdit, IESRILocatorReleaseInfo, IGeocodingOutputs, IGeocodingProperties, ILocator2, IPlaceNameAlias, IReferenceDataTables, IReverseGeocodingProperties, ISimpleStandardization, IClone, ISupportErrorInfo, Serializable

public class ESRIFDOAddressLocatorStyle
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IAddressInputs, IGeocodingProperties, IReferenceDataTables, ILocator2, ILocatorStyle, IPlaceNameAlias, ISimpleStandardization, ISupportErrorInfo, IReverseGeocodingProperties, IGeocodingOutputs, IESRILocatorReleaseInfo, IESRILocatorBuildOptionsEdit

An address locator style for locators that use the ESRI geocoding engine developed prior to ArcGIS version 10.0.

Description

An ESRIFDOAddressLocatorStyle is an address locator style that can be used to create locators that use the ESRI geocoding engine and Feature-Data-Object reference data sources to geocode addresses.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), ILocatorStyle, StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), ILocator, ESRIFDOAddressLocator, StreetMapAddressLocator, com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.locationui.IGxNewLocator, ILocatorWorkspace.getLocatorStyle(String), com.esri.arcgis.catalogUI.IGxLocator, Serialized Form

Constructor Summary

ESRIFDOAddressLocatorStyle(Object obj)
Construct a ESRIFDOAddressLocatorStyle 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(String addressField) Recognized names for an input field.
String	getDescription() Description of the locator.
int	getEndOffset() End offset percentage.
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.
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	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

ESRIFDOAddressLocatorStyle

public ESRIFDOAddressLocatorStyle(Object obj)
                           throws IOException

Construct a ESRIFDOAddressLocatorStyle using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ESRIFDOAddressLocatorStyle.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ESRIFDOAddressLocatorStyle o = (ESRIFDOAddressLocatorStyle)obj; // will not work

ESRIFDOAddressLocatorStyle o = new ESRIFDOAddressLocatorStyle(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ESRIFDOAddressLocatorStyle theESRIFDOAddressLocatorStyle = (ESRIFDOAddressLocatorStyle) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddressFields

public IFields getAddressFields()
                         throws IOException,
                                AutomationException

Fields needed to geocode a table of addresses.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAddressFields in interface IAddressInputs

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

public Object getDefaultInputFieldNames(String addressField)
                                 throws IOException,
                                        AutomationException

Recognized names for an input field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDefaultInputFieldNames in interface IAddressInputs

Parameters:

addressField - The addressField (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumMatchScore

public int getMinimumMatchScore()
                         throws IOException,
                                AutomationException

Minimum match score setting.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumMatchScore in interface IGeocodingProperties

Returns:

The minimumMatchScore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumMatchScore

public void setMinimumMatchScore(int minimumMatchScore)
                          throws IOException,
                                 AutomationException

Minimum match score setting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumMatchScore in interface IGeocodingProperties

Parameters:

minimumMatchScore - The minimumMatchScore (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumCandidateScore

public int getMinimumCandidateScore()
                             throws IOException,
                                    AutomationException

Minimum candidate score setting.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumCandidateScore in interface IGeocodingProperties

Returns:

The minimumCandidateScore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCandidateScore

public void setMinimumCandidateScore(int minimumCandidateScore)
                              throws IOException,
                                     AutomationException

Minimum candidate score setting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumCandidateScore in interface IGeocodingProperties

Parameters:

minimumCandidateScore - The minimumCandidateScore (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpellingSensitivity

public int getSpellingSensitivity()
                           throws IOException,
                                  AutomationException

Spelling sensitivity setting.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpellingSensitivity in interface IGeocodingProperties

Returns:

The spellingSensitivity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpellingSensitivity

public void setSpellingSensitivity(int spellingSensitivity)
                            throws IOException,
                                   AutomationException

Spelling sensitivity setting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpellingSensitivity in interface IGeocodingProperties

Parameters:

spellingSensitivity - The spellingSensitivity (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffset

public int getEndOffset()
                 throws IOException,
                        AutomationException

End offset percentage.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEndOffset in interface IGeocodingProperties

Returns:

The endOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffset

public void setEndOffset(int endOffset)
                  throws IOException,
                         AutomationException

End offset percentage.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEndOffset in interface IGeocodingProperties

Parameters:

endOffset - The endOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideOffset

public double getSideOffset()
                     throws IOException,
                            AutomationException

Side offset distance.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSideOffset in interface IGeocodingProperties

Returns:

The sideOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideOffset

public void setSideOffset(double sideOffset)
                   throws IOException,
                          AutomationException

Side offset distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSideOffset in interface IGeocodingProperties

Parameters:

sideOffset - The sideOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideOffsetUnits

public int getSideOffsetUnits()
                       throws IOException,
                              AutomationException

Units used for the side offset.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSideOffsetUnits in interface IGeocodingProperties

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideOffsetUnits

public void setSideOffsetUnits(int sideOffsetUnits)
                        throws IOException,
                               AutomationException

Units used for the side offset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSideOffsetUnits in interface IGeocodingProperties

Parameters:

sideOffsetUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddXYCoordsToMatchFields

public boolean isAddXYCoordsToMatchFields()
                                   throws IOException,
                                          AutomationException

Indicates if the x and y coordinates of the address location are included in the geocoding result.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddXYCoordsToMatchFields in interface IGeocodingProperties

Returns:

The bAddXYCoordsToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddXYCoordsToMatchFields

public void setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields)
                                 throws IOException,
                                        AutomationException

Indicates if the x and y coordinates of the address location are included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddXYCoordsToMatchFields in interface IGeocodingProperties

Parameters:

bAddXYCoordsToMatchFields - The bAddXYCoordsToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddStandardizeStringToMatchFields

public boolean isAddStandardizeStringToMatchFields()
                                            throws IOException,
                                                   AutomationException

Indicates if the standardized address is included in the geocoding result.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddStandardizeStringToMatchFields in interface IGeocodingProperties

Returns:

The bAddStandardizeStringToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddStandardizeStringToMatchFields

public void setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields)
                                          throws IOException,
                                                 AutomationException

Indicates if the standardized address is included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddStandardizeStringToMatchFields in interface IGeocodingProperties

Parameters:

bAddStandardizeStringToMatchFields - The bAddStandardizeStringToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddReferenceIDToMatchFields

public boolean isAddReferenceIDToMatchFields()
                                      throws IOException,
                                             AutomationException

Indicates if the feature ID of the matched feature is included in the geocoding result.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddReferenceIDToMatchFields in interface IGeocodingProperties

Returns:

The bAddReferenceIDToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddReferenceIDToMatchFields

public void setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields)
                                    throws IOException,
                                           AutomationException

Indicates if the feature ID of the matched feature is included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddReferenceIDToMatchFields in interface IGeocodingProperties

Parameters:

bAddReferenceIDToMatchFields - The bAddReferenceIDToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddPercentAlongToMatchFields

public boolean isAddPercentAlongToMatchFields()
                                       throws IOException,
                                              AutomationException

Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddPercentAlongToMatchFields in interface IGeocodingProperties

Returns:

The bAddPercentAlongToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddPercentAlongToMatchFields

public void setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields)
                                     throws IOException,
                                            AutomationException

Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddPercentAlongToMatchFields in interface IGeocodingProperties

Parameters:

bAddPercentAlongToMatchFields - The bAddPercentAlongToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMatchIfScoresTie

public boolean isMatchIfScoresTie()
                           throws IOException,
                                  AutomationException

Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMatchIfScoresTie in interface IGeocodingProperties

Returns:

The bMatchIfScoresTie

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMatchIfScoresTie

public void setMatchIfScoresTie(boolean bMatchIfScoresTie)
                         throws IOException,
                                AutomationException

Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMatchIfScoresTie in interface IGeocodingProperties

Parameters:

bMatchIfScoresTie - The bMatchIfScoresTie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

public void setDefaultInputFieldNames(String addressField,
                                      Object rhs2)
                               throws IOException,
                                      AutomationException

Recognized names for a required input field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDefaultInputFieldNames in interface IGeocodingProperties

Parameters:

addressField - The addressField (in)

rhs2 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntersectionConnectors

public String getIntersectionConnectors()
                                 throws IOException,
                                        AutomationException

Connector strings used to designate intersections.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIntersectionConnectors in interface IGeocodingProperties

Returns:

The intersectionConnectors

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIntersectionConnectors

public void setIntersectionConnectors(String intersectionConnectors)
                               throws IOException,
                                      AutomationException

Connector strings used to designate intersections.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIntersectionConnectors in interface IGeocodingProperties

Parameters:

intersectionConnectors - The intersectionConnectors (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRelativePaths

public boolean isUseRelativePaths()
                           throws IOException,
                                  AutomationException

Indicates if the paths to the reference data should be stored relative to the locator.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseRelativePaths in interface IGeocodingProperties

Returns:

The bUseRelativePaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseRelativePaths

public void setUseRelativePaths(boolean bUseRelativePaths)
                         throws IOException,
                                AutomationException

Indicates if the paths to the reference data should be stored relative to the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseRelativePaths in interface IGeocodingProperties

Parameters:

bUseRelativePaths - The bUseRelativePaths (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTables

public IEnumReferenceDataTable getTables()
                                  throws IOException,
                                         AutomationException

The reference data tables used by the locator.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTables in interface IReferenceDataTables

Returns:

A reference to a com.esri.arcgis.location.IEnumReferenceDataTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

isHasEnoughInfo

public boolean isHasEnoughInfo()
                        throws IOException,
                               AutomationException

Indicates if the locator has sufficient reference data in order to geocode.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasEnoughInfo in interface IReferenceDataTables

Returns:

The bHasEnough

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

getBuildTime

public Object getBuildTime()
                    throws IOException,
                           AutomationException

The date and time the locator was built.

Remarks

The BulidTime property returns the date and time the locator was built.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getBuildTime in interface ILocator2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the locator.

Remarks

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".

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILocator

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface ILocator

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String description)
                    throws IOException,
                           AutomationException

Description of the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescription in interface ILocator

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

Category of the locator.

Remarks

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:

• Address - Locators that are used to geocode addresses
• RouteEvent - Locators that are used for linear referencing

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface ILocator

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserInterface

public ILocatorUI getUserInterface()
                            throws IOException,
                                   AutomationException

User interface for the locator.

Description

The UserInterface property returns an object that you can use to display the user interfaces for the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserInterface in interface ILocator

Returns:

A reference to a com.esri.arcgis.geodatabase.ILocatorUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITableName getTable()
                    throws IOException,
                           AutomationException

Name object for the place name alias table.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTable in interface IPlaceNameAlias

Returns:

A reference to a com.esri.arcgis.geodatabase.ITableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITableName name)
                   throws IOException,
                          AutomationException

Name object for the place name alias table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTableByRef in interface IPlaceNameAlias

Parameters:

name - A reference to a com.esri.arcgis.geodatabase.ITableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliasField

public String getAliasField()
                     throws IOException,
                            AutomationException

Name of the alias field.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAliasField in interface IPlaceNameAlias

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasField

public void setAliasField(String name)
                   throws IOException,
                          AutomationException

Name of the alias field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAliasField in interface IPlaceNameAlias

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IPlaceNameAlias_getAddressFields

public String IPlaceNameAlias_getAddressFields()
                                        throws IOException,
                                               AutomationException

Names of the address fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

IPlaceNameAlias_getAddressFields in interface IPlaceNameAlias

Returns:

The fieldList

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddressFields

public void setAddressFields(String fieldList)
                      throws IOException,
                             AutomationException

Names of the address fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddressFields in interface IPlaceNameAlias

Parameters:

fieldList - The fieldList (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultAliasFieldNames

public Object getDefaultAliasFieldNames()
                                 throws IOException,
                                        AutomationException

Recognized names for the address fields in the place name alias table.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultAliasFieldNames in interface IPlaceNameAlias

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultAliasFieldNames

public void setDefaultAliasFieldNames(Object names)
                               throws IOException,
                                      AutomationException

Recognized names for the address fields in the place name alias table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultAliasFieldNames in interface IPlaceNameAlias

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simpleStandardizeTable

public void simpleStandardizeTable(ITable inputTable,
                                   String inputFieldsToConcatinate,
                                   String whereClause,
                                   ITable outputTable,
                                   String outputFieldNames,
                                   IPropertySet fieldsToCopy,
                                   ITrackCancel cancelTracker)
                            throws IOException,
                                   AutomationException

Standardize a table of addresses.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

simpleStandardizeTable in interface ISimpleStandardization

Parameters:

inputTable - 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)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSimpleStandardizeFields

public IFields getSimpleStandardizeFields()
                                   throws IOException,
                                          AutomationException

Fields contained in a standardized address.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSimpleStandardizeFields in interface ISimpleStandardization

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simpleStandardizeAddress

public IPropertySet simpleStandardizeAddress(String address)
                                      throws IOException,
                                             AutomationException

Standardize a single address.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

simpleStandardizeAddress in interface ISimpleStandardization

Parameters:

address - The address (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchDistance

public double getSearchDistance()
                         throws IOException,
                                AutomationException

Search distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSearchDistance in interface IReverseGeocodingProperties

Returns:

The searchDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchDistance

public void setSearchDistance(double searchDistance)
                       throws IOException,
                              AutomationException

Search distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSearchDistance in interface IReverseGeocodingProperties

Parameters:

searchDistance - The searchDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchDistanceUnits

public int getSearchDistanceUnits()
                           throws IOException,
                                  AutomationException

Units used for the search distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSearchDistanceUnits in interface IReverseGeocodingProperties

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchDistanceUnits

public void setSearchDistanceUnits(int searchDistanceUnits)
                            throws IOException,
                                   AutomationException

Units used for the search distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSearchDistanceUnits in interface IReverseGeocodingProperties

Parameters:

searchDistanceUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMatchFields

public IFields getMatchFields()
                       throws IOException,
                              AutomationException

Fields contained in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMatchFields in interface IGeocodingOutputs

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelease

public String getRelease()
                  throws IOException,
                         AutomationException

The description of locator release.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getRelease in interface IESRILocatorReleaseInfo

Returns:

The esri_release

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStoreStandardizedRefData

public void setStoreStandardizedRefData(boolean rhs1)
                                 throws IOException,
                                        AutomationException

Indicates if the locator should store information extracted from the reference data in a standardized form.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setStoreStandardizedRefData in interface IESRILocatorBuildOptionsEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmbedGeocodingRules

public void setEmbedGeocodingRules(boolean rhs1)
                            throws IOException,
                                   AutomationException

Indicates if the locator should contain a copy of geocoding rules it uses.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setEmbedGeocodingRules in interface IESRILocatorBuildOptionsEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGDBVersionName

public void setGDBVersionName(String rhs1)
                       throws IOException,
                              AutomationException

The name of the GDB version the locator is built against.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setGDBVersionName in interface IESRILocatorBuildOptionsEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStoreStandardizedRefData

public boolean isStoreStandardizedRefData()
                                   throws IOException,
                                          AutomationException

Indicates if the locator should store information extracted from the reference data in a standardized form.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isStoreStandardizedRefData in interface IESRILocatorBuildOptions

Returns:

The bStoreStandardizedRefData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmbedGeocodingRules

public boolean isEmbedGeocodingRules()
                              throws IOException,
                                     AutomationException

Indicates if the locator should contain a copy of geocoding rules it uses.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isEmbedGeocodingRules in interface IESRILocatorBuildOptions

Returns:

The bEmbedGeocodingRules

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGDBVersionName

public String getGDBVersionName()
                         throws IOException,
                                AutomationException

The name of the GDB version the locator is built against.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getGDBVersionName in interface IESRILocatorBuildOptions

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.