com.esri.arcgis.location
Class ESRIGen2AddressLocatorStyle

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

All Implemented Interfaces:

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

public class ESRIGen2AddressLocatorStyle
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocator, ILocator2, ILocatorStyle, IAddressInputs, IClone, IESRILocatorBuildOptionsEdit, IGeocodingProperties, IGeocodingProperties2, IGeocodingOutputs, IPlaceNameAlias, IESRILocatorReleaseInfo, IReferenceDataTables, IReverseGeocodingProperties, ISimpleStandardization, ISingleLineAddressInput, ISupportErrorInfo

COM Class 'ESRIGen2AddressLocatorStyle'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description 'An address locator style that uses the Esri geocoding engine introduced in ArcGIS version 10.0.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.location.ILocator2

IID, IID09d6643b_d40f_4988_86f5_432952fc38e7, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ILocator

IID655c5c62_6478_11d3_9f57_00c04f6bdf06

Fields inherited from interface com.esri.arcgis.geodatabase.ILocatorStyle

IID, IIDcfc5ef8c_4fcc_40de_928a_21b354eae9bd, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.location.IESRILocatorBuildOptionsEdit

IID, IIDa85f8063_4e7b_4266_b5ac_be4232524d9e, xxDummy

Fields inherited from interface com.esri.arcgis.location.IESRILocatorBuildOptions

IID92a704b6_ee5b_4513_a4ff_0205866fa5a6

Fields inherited from interface com.esri.arcgis.location.IGeocodingProperties2

IID, IID896714a4_0313_4dbc_b471_5d4c6a6ec351, xxDummy

Fields inherited from interface com.esri.arcgis.location.IGeocodingProperties

IID600a5896_ddc1_11d3_9f74_00c04f8ed1c4

Fields inherited from interface com.esri.arcgis.location.IAddressInputs

IID600a589d_ddc1_11d3_9f74_00c04f8ed1c4

Fields inherited from interface com.esri.arcgis.location.IGeocodingOutputs

IID, IIDcb7b12d8_b15e_4cd3_9efa_8d93f384bd7b, xxDummy

Fields inherited from interface com.esri.arcgis.location.IPlaceNameAlias

IID, IIDe5aaa254_3ebd_49a7_aa9f_62ae8c762f9c, xxDummy

Fields inherited from interface com.esri.arcgis.location.IESRILocatorReleaseInfo

IID, IIDfde5639f_468d_4f00_9558_6246e56e7852, xxDummy

Fields inherited from interface com.esri.arcgis.location.IReferenceDataTables

IID, IID600a5898_ddc1_11d3_9f74_00c04f8ed1c4, xxDummy

Fields inherited from interface com.esri.arcgis.location.IReverseGeocodingProperties

IID, IIDb693864f_4485_4d9a_a69e_3aa66153f44d, xxDummy

Fields inherited from interface com.esri.arcgis.location.ISimpleStandardization

IID, IID1bb3b08b_45fc_43f3_a141_928881076c38, xxDummy

Fields inherited from interface com.esri.arcgis.location.ISingleLineAddressInput

IID, IID42825b3a_5b8e_485d_bcbc_895f7d06c9c2, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

ESRIGen2AddressLocatorStyle(java.lang.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(java.lang.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.
java.lang.String	getAliasField() Name of the alias field.
java.lang.Object	getBuildTime() The date and time the locator was built.
java.lang.String	getCategory() Category of the locator.
java.lang.Object	getDefaultAliasFieldNames() Recognized names for the address fields in the place name alias table.
java.lang.Object	getDefaultInputFieldNames() Recognized names for the single line input field.
java.lang.Object	getDefaultInputFieldNames(java.lang.String addressField) Recognized names for an input field.
java.lang.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.
java.lang.String	getGDBVersionName() The name of the GDB version the locator is built against.
java.lang.String	getIntersectionConnectors() Connector strings used to designate intersections.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IFields	getMatchFields() Fields contained in the geocoding result.
int	getMinimumCandidateScore() Minimum candidate score setting.
int	getMinimumMatchScore() Minimum match score setting.
java.lang.String	getName() Name of the locator.
java.lang.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
java.lang.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	release() Release a ESRIGen2AddressLocatorStyle.
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(java.lang.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(java.lang.String name) Name of the alias field.
void	setDefaultAliasFieldNames(java.lang.Object names) Recognized names for the address fields in the place name alias table.
void	setDefaultInputFieldNames(java.lang.String addressField, java.lang.Object rhs2) Recognized names for a required input field.
void	setDescription(java.lang.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(java.lang.String rhs1) The name of the GDB version the locator is built against.
void	setIntersectionConnectors(java.lang.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(java.lang.String address) Standardize a single address.
void	simpleStandardizeTable(ITable inputTable, java.lang.String inputFieldsToConcatinate, java.lang.String whereClause, ITable outputTable, java.lang.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

Constructor Detail

ESRIGen2AddressLocatorStyle

public ESRIGen2AddressLocatorStyle(java.lang.Object obj)
                            throws java.io.IOException

Construct a ESRIGen2AddressLocatorStyle using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ESRIGen2AddressLocatorStyle.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
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

Throws:

java.io.IOException - if there are interop problems ESRIGen2AddressLocatorStyle theESRIGen2AddressLocatorStyle = (ESRIGen2AddressLocatorStyle) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ESRIGen2AddressLocatorStyle.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the locator.

Specified by:

getName in interface ILocator

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description of the locator.

Specified by:

getDescription in interface ILocator

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

Description of the locator.

Specified by:

setDescription in interface ILocator

Parameters:

description - The description (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

Category of the locator.

Specified by:

getCategory in interface ILocator

Returns:

The category

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserInterface

public ILocatorUI getUserInterface()
                            throws java.io.IOException,
                                   AutomationException

User interface for the locator.

Specified by:

getUserInterface in interface ILocator

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBuildTime

public java.lang.Object getBuildTime()
                              throws java.io.IOException,
                                     AutomationException

The date and time the locator was built.

Specified by:

getBuildTime in interface ILocator2

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddressFields

public IFields getAddressFields()
                         throws java.io.IOException,
                                AutomationException

Fields needed to geocode a table of addresses.

Specified by:

getAddressFields in interface IAddressInputs

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

public java.lang.Object getDefaultInputFieldNames(java.lang.String addressField)
                                           throws java.io.IOException,
                                                  AutomationException

Recognized names for an input field.

Specified by:

getDefaultInputFieldNames in interface IAddressInputs

Parameters:

addressField - The addressField (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStoreStandardizedRefData

public void setStoreStandardizedRefData(boolean rhs1)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

setStoreStandardizedRefData in interface IESRILocatorBuildOptionsEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmbedGeocodingRules

public void setEmbedGeocodingRules(boolean rhs1)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

setEmbedGeocodingRules in interface IESRILocatorBuildOptionsEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGDBVersionName

public void setGDBVersionName(java.lang.String rhs1)
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

setGDBVersionName in interface IESRILocatorBuildOptionsEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStoreStandardizedRefData

public boolean isStoreStandardizedRefData()
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

isStoreStandardizedRefData in interface IESRILocatorBuildOptions

Returns:

The bStoreStandardizedRefData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmbedGeocodingRules

public boolean isEmbedGeocodingRules()
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

isEmbedGeocodingRules in interface IESRILocatorBuildOptions

Returns:

The bEmbedGeocodingRules

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGDBVersionName

public java.lang.String getGDBVersionName()
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

getGDBVersionName in interface IESRILocatorBuildOptions

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumMatchScore

public int getMinimumMatchScore()
                         throws java.io.IOException,
                                AutomationException

Minimum match score setting.

Specified by:

getMinimumMatchScore in interface IGeocodingProperties

Returns:

The minimumMatchScore

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumMatchScore

public void setMinimumMatchScore(int minimumMatchScore)
                          throws java.io.IOException,
                                 AutomationException

Minimum match score setting.

Specified by:

setMinimumMatchScore in interface IGeocodingProperties

Parameters:

minimumMatchScore - The minimumMatchScore (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumCandidateScore

public int getMinimumCandidateScore()
                             throws java.io.IOException,
                                    AutomationException

Minimum candidate score setting.

Specified by:

getMinimumCandidateScore in interface IGeocodingProperties

Returns:

The minimumCandidateScore

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCandidateScore

public void setMinimumCandidateScore(int minimumCandidateScore)
                              throws java.io.IOException,
                                     AutomationException

Minimum candidate score setting.

Specified by:

setMinimumCandidateScore in interface IGeocodingProperties

Parameters:

minimumCandidateScore - The minimumCandidateScore (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpellingSensitivity

public int getSpellingSensitivity()
                           throws java.io.IOException,
                                  AutomationException

Spelling sensitivity setting.

Specified by:

getSpellingSensitivity in interface IGeocodingProperties

Returns:

The spellingSensitivity

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpellingSensitivity

public void setSpellingSensitivity(int spellingSensitivity)
                            throws java.io.IOException,
                                   AutomationException

Spelling sensitivity setting.

Specified by:

setSpellingSensitivity in interface IGeocodingProperties

Parameters:

spellingSensitivity - The spellingSensitivity (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffset

public int getEndOffset()
                 throws java.io.IOException,
                        AutomationException

End offset percentage.

Specified by:

getEndOffset in interface IGeocodingProperties

Returns:

The endOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffset

public void setEndOffset(int endOffset)
                  throws java.io.IOException,
                         AutomationException

End offset percentage.

Specified by:

setEndOffset in interface IGeocodingProperties

Parameters:

endOffset - The endOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideOffset

public double getSideOffset()
                     throws java.io.IOException,
                            AutomationException

Side offset distance.

Specified by:

getSideOffset in interface IGeocodingProperties

Returns:

The sideOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideOffset

public void setSideOffset(double sideOffset)
                   throws java.io.IOException,
                          AutomationException

Side offset distance.

Specified by:

setSideOffset in interface IGeocodingProperties

Parameters:

sideOffset - The sideOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideOffsetUnits

public int getSideOffsetUnits()
                       throws java.io.IOException,
                              AutomationException

Units used for the side offset.

Specified by:

getSideOffsetUnits in interface IGeocodingProperties

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideOffsetUnits

public void setSideOffsetUnits(int sideOffsetUnits)
                        throws java.io.IOException,
                               AutomationException

Units used for the side offset.

Specified by:

setSideOffsetUnits in interface IGeocodingProperties

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddXYCoordsToMatchFields

public boolean isAddXYCoordsToMatchFields()
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

isAddXYCoordsToMatchFields in interface IGeocodingProperties

Returns:

The bAddXYCoordsToMatchFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddXYCoordsToMatchFields

public void setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

setAddXYCoordsToMatchFields in interface IGeocodingProperties

Parameters:

bAddXYCoordsToMatchFields - The bAddXYCoordsToMatchFields (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddStandardizeStringToMatchFields

public boolean isAddStandardizeStringToMatchFields()
                                            throws java.io.IOException,
                                                   AutomationException

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

Specified by:

isAddStandardizeStringToMatchFields in interface IGeocodingProperties

Returns:

The bAddStandardizeStringToMatchFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddStandardizeStringToMatchFields

public void setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields)
                                          throws java.io.IOException,
                                                 AutomationException

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

Specified by:

setAddStandardizeStringToMatchFields in interface IGeocodingProperties

Parameters:

bAddStandardizeStringToMatchFields - The bAddStandardizeStringToMatchFields (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddReferenceIDToMatchFields

public boolean isAddReferenceIDToMatchFields()
                                      throws java.io.IOException,
                                             AutomationException

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

Specified by:

isAddReferenceIDToMatchFields in interface IGeocodingProperties

Returns:

The bAddReferenceIDToMatchFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddReferenceIDToMatchFields

public void setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields)
                                    throws java.io.IOException,
                                           AutomationException

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

Specified by:

setAddReferenceIDToMatchFields in interface IGeocodingProperties

Parameters:

bAddReferenceIDToMatchFields - The bAddReferenceIDToMatchFields (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddPercentAlongToMatchFields

public boolean isAddPercentAlongToMatchFields()
                                       throws java.io.IOException,
                                              AutomationException

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

Specified by:

isAddPercentAlongToMatchFields in interface IGeocodingProperties

Returns:

The bAddPercentAlongToMatchFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddPercentAlongToMatchFields

public void setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields)
                                     throws java.io.IOException,
                                            AutomationException

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

Specified by:

setAddPercentAlongToMatchFields in interface IGeocodingProperties

Parameters:

bAddPercentAlongToMatchFields - The bAddPercentAlongToMatchFields (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMatchIfScoresTie

public boolean isMatchIfScoresTie()
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

isMatchIfScoresTie in interface IGeocodingProperties

Returns:

The bMatchIfScoresTie

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMatchIfScoresTie

public void setMatchIfScoresTie(boolean bMatchIfScoresTie)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setMatchIfScoresTie in interface IGeocodingProperties

Parameters:

bMatchIfScoresTie - The bMatchIfScoresTie (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

public void setDefaultInputFieldNames(java.lang.String addressField,
                                      java.lang.Object rhs2)
                               throws java.io.IOException,
                                      AutomationException

Recognized names for a required input field.

Specified by:

setDefaultInputFieldNames in interface IGeocodingProperties

Parameters:

addressField - The addressField (in)

rhs2 - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntersectionConnectors

public java.lang.String getIntersectionConnectors()
                                           throws java.io.IOException,
                                                  AutomationException

Connector strings used to designate intersections.

Specified by:

getIntersectionConnectors in interface IGeocodingProperties

Returns:

The intersectionConnectors

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIntersectionConnectors

public void setIntersectionConnectors(java.lang.String intersectionConnectors)
                               throws java.io.IOException,
                                      AutomationException

Connector strings used to designate intersections.

Specified by:

setIntersectionConnectors in interface IGeocodingProperties

Parameters:

intersectionConnectors - The intersectionConnectors (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRelativePaths

public boolean isUseRelativePaths()
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

isUseRelativePaths in interface IGeocodingProperties

Returns:

The bUseRelativePaths

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseRelativePaths

public void setUseRelativePaths(boolean bUseRelativePaths)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setUseRelativePaths in interface IGeocodingProperties

Parameters:

bUseRelativePaths - The bUseRelativePaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffsetDistance

public double getEndOffsetDistance()
                            throws java.io.IOException,
                                   AutomationException

End offset using either distance or percentage.

Specified by:

getEndOffsetDistance in interface IGeocodingProperties2

Returns:

The endOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffsetDistance

public void setEndOffsetDistance(double endOffset)
                          throws java.io.IOException,
                                 AutomationException

End offset using either distance or percentage.

Specified by:

setEndOffsetDistance in interface IGeocodingProperties2

Parameters:

endOffset - The endOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffsetDistanceUnits

public int getEndOffsetDistanceUnits()
                              throws java.io.IOException,
                                     AutomationException

Units used for the end offset. Use esriUnknownUnits to specify the end offset as a percentage of the segment's length.

Specified by:

getEndOffsetDistanceUnits in interface IGeocodingProperties2

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffsetDistanceUnits

public void setEndOffsetDistanceUnits(int endOffsetDistanceUnits)
                               throws java.io.IOException,
                                      AutomationException

Units used for the end offset. Use esriUnknownUnits to specify the end offset as a percentage of the segment's length.

Specified by:

setEndOffsetDistanceUnits in interface IGeocodingProperties2

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMatchFields

public IFields getMatchFields()
                       throws java.io.IOException,
                              AutomationException

Fields contained in the geocoding result.

Specified by:

getMatchFields in interface IGeocodingOutputs

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITableName getTable()
                    throws java.io.IOException,
                           AutomationException

Name object for the place name alias table.

Specified by:

getTable in interface IPlaceNameAlias

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITableName name)
                   throws java.io.IOException,
                          AutomationException

Name object for the place name alias table.

Specified by:

setTableByRef in interface IPlaceNameAlias

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliasField

public java.lang.String getAliasField()
                               throws java.io.IOException,
                                      AutomationException

Name of the alias field.

Specified by:

getAliasField in interface IPlaceNameAlias

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasField

public void setAliasField(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Name of the alias field.

Specified by:

setAliasField in interface IPlaceNameAlias

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IPlaceNameAlias_getAddressFields

public java.lang.String IPlaceNameAlias_getAddressFields()
                                                  throws java.io.IOException,
                                                         AutomationException

Names of the address fields.

Specified by:

IPlaceNameAlias_getAddressFields in interface IPlaceNameAlias

Returns:

The fieldList

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddressFields

public void setAddressFields(java.lang.String fieldList)
                      throws java.io.IOException,
                             AutomationException

Names of the address fields.

Specified by:

setAddressFields in interface IPlaceNameAlias

Parameters:

fieldList - The fieldList (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultAliasFieldNames

public java.lang.Object getDefaultAliasFieldNames()
                                           throws java.io.IOException,
                                                  AutomationException

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

Specified by:

getDefaultAliasFieldNames in interface IPlaceNameAlias

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultAliasFieldNames

public void setDefaultAliasFieldNames(java.lang.Object names)
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

setDefaultAliasFieldNames in interface IPlaceNameAlias

Parameters:

names - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelease

public java.lang.String getRelease()
                            throws java.io.IOException,
                                   AutomationException

The description of locator release.

Specified by:

getRelease in interface IESRILocatorReleaseInfo

Returns:

The esri_release

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTables

public IEnumReferenceDataTable getTables()
                                  throws java.io.IOException,
                                         AutomationException

The reference data tables used by the locator.

Specified by:

getTables in interface IReferenceDataTables

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasEnoughInfo

public boolean isHasEnoughInfo()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

isHasEnoughInfo in interface IReferenceDataTables

Returns:

The bHasEnough

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchDistance

public double getSearchDistance()
                         throws java.io.IOException,
                                AutomationException

Search distance.

Specified by:

getSearchDistance in interface IReverseGeocodingProperties

Returns:

The searchDistance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchDistance

public void setSearchDistance(double searchDistance)
                       throws java.io.IOException,
                              AutomationException

Search distance.

Specified by:

setSearchDistance in interface IReverseGeocodingProperties

Parameters:

searchDistance - The searchDistance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchDistanceUnits

public int getSearchDistanceUnits()
                           throws java.io.IOException,
                                  AutomationException

Units used for the search distance.

Specified by:

getSearchDistanceUnits in interface IReverseGeocodingProperties

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchDistanceUnits

public void setSearchDistanceUnits(int searchDistanceUnits)
                            throws java.io.IOException,
                                   AutomationException

Units used for the search distance.

Specified by:

setSearchDistanceUnits in interface IReverseGeocodingProperties

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simpleStandardizeTable

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

Standardize a table of addresses.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSimpleStandardizeFields

public IFields getSimpleStandardizeFields()
                                   throws java.io.IOException,
                                          AutomationException

Fields contained in a standardized address.

Specified by:

getSimpleStandardizeFields in interface ISimpleStandardization

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simpleStandardizeAddress

public IPropertySet simpleStandardizeAddress(java.lang.String address)
                                      throws java.io.IOException,
                                             AutomationException

Standardize a single address.

Specified by:

simpleStandardizeAddress in interface ISimpleStandardization

Parameters:

address - The address (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSingleLineAddressField

public IField getSingleLineAddressField()
                                 throws java.io.IOException,
                                        AutomationException

Field needed to geocode a single line address.

Specified by:

getSingleLineAddressField in interface ISingleLineAddressInput

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

public java.lang.Object getDefaultInputFieldNames()
                                           throws java.io.IOException,
                                                  AutomationException

Recognized names for the single line input field.

Specified by:

getDefaultInputFieldNames in interface ISingleLineAddressInput

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.