com.esri.arcgis.location
Class RSLocator

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

All Implemented Interfaces:

ILocator, ILocatorDataset, com.esri.arcgis.interop.RemoteObjRef, IAddressCandidates, IAddressCandidates2, IAddressGeocoding, IAddressInputs, IGeocodingProperties, IIntersectionGeocoding, ILocator2, ILocatorImpl, IReverseGeocoding, IReverseGeocodingProperties, IClone, java.io.Serializable

public class RSLocator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocator, ILocator2, ILocatorImpl, ILocatorDataset, IAddressInputs, IAddressGeocoding, IAddressCandidates, IAddressCandidates2, IReverseGeocoding, IReverseGeocodingProperties, IIntersectionGeocoding, IGeocodingProperties, IClone

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

Description 'An address locator that uses the Esri RouteServer geocoding engine.' 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.location.ILocatorImpl

IID, IIDcff73580_6c73_11d3_9f5c_00c04f6bdf06, xxDummy

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

IID, IIDfdadfae4_939d_11d3_9f6b_00c04f6bdf06, xxDummy

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

IID, IID600a589a_ddc1_11d3_9f74_00c04f8ed1c4, xxDummy

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

IID, IIDe62c17a3_595a_4a07_b862_a870aba99a98, xxDummy

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

IID600a5899_ddc1_11d3_9f74_00c04f8ed1c4

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

IID, IID5af33731_8b62_4dd7_897c_faacc0cd575e, 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.IIntersectionGeocoding

IID, IID5cd1b646_774c_11d3_9f61_00c04f8ed1c4, xxDummy

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

IID, IID600a5896_ddc1_11d3_9f74_00c04f8ed1c4, xxDummy

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

IID600a589d_ddc1_11d3_9f74_00c04f8ed1c4

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

RSLocator()
Constructs a RSLocator using ArcGIS Engine.

RSLocator(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RSLocator theRSLocator = (RSLocator) obj;

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.
IArray	findAddressCandidates(IPropertySet address) Generates candidates for an address.
IArray	findMatchingAddressCandidates(IPropertySet address) Generates candidates for an address, including only matching ones.
IFields	getAddressFields() Fields needed to geocode a table of addresses.
java.lang.Object	getBuildTime() The date and time the locator was built.
IFields	getCandidateFields() Fields contained in a list of candidates.
java.lang.String	getCategory() Category of the locator.
static java.lang.String	getClsid() getClsid.
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.
ILocatorName	getFullName() The Name object for the locator.
IFields	getIntersectionCandidateFields() Fields contained by intersection candidates.
java.lang.String	getIntersectionConnectors() Connector strings used to designate intersections.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILocatorWorkspace	getLocatorWorkspace() The locator workspace that contains the locator.
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.
IPropertySet	getProperties() Properties of the locator.
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.
int	getSpellingSensitivity() Spelling sensitivity setting.
ILocatorUI	getUserInterface() User interface for the locator.
int	hashCode() the hashcode for this object
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	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isIntersection(IPropertySet address) Indicates if an address is an intersection.
boolean	isMatchIfScoresTie() Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.
boolean	isUseRelativePaths() Indicates if the paths to the reference data should be stored relative to the locator.
IPropertySet	matchAddress(IPropertySet address) Geocodes a single address.
void	matchTable(ITable addressTable, java.lang.String addressFieldNames, java.lang.String whereClause, IFeatureClass outputFeatureClass, java.lang.String outputFieldNames, IPropertySet fieldsToCopy, ITrackCancel cancelTracker) Geocodes a table of addresses.
void	release() Release a RSLocator.
IPropertySet	reverseGeocode(IPoint location, boolean bReturnIntersection) Generate an address based on a point.
void	setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields) Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.
void	setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields) Indicates if the feature ID of the matched feature is included in the geocoding result.
void	setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields) Indicates if the standardized address is included in the geocoding result.
void	setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields) Indicates if the x and y coordinates of the address location are included in the geocoding result.
void	setCategory(java.lang.String rhs1) Category of the locator.
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	setEndOffset(int endOffset) End offset percentage.
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	setName(java.lang.String rhs1) Name of the locator.
void	setProperties(IPropertySet props) Properties of the locator.
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	setUseRelativePaths(boolean bUseRelativePaths) Indicates if the paths to the reference data should be stored relative to the locator.
void	validate() Checks that the locator properties and locator dataset are present and valid.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RSLocator

public RSLocator()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a RSLocator using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RSLocator

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RSLocator theRSLocator = (RSLocator) obj;

Construct a RSLocator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RSLocator.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

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

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.

setName

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

Name of the locator.

Specified by:

setName in interface ILocatorImpl

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

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

Category of the locator.

Specified by:

setCategory in interface ILocatorImpl

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

Properties of the locator.

Specified by:

getProperties in interface ILocatorImpl

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.

setProperties

public void setProperties(IPropertySet props)
                   throws java.io.IOException,
                          AutomationException

Properties of the locator.

Specified by:

setProperties in interface ILocatorImpl

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public ILocatorName getFullName()
                         throws java.io.IOException,
                                AutomationException

The Name object for the locator.

Specified by:

getFullName in interface ILocatorDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorWorkspace

public ILocatorWorkspace getLocatorWorkspace()
                                      throws java.io.IOException,
                                             AutomationException

The locator workspace that contains the locator.

Specified by:

getLocatorWorkspace in interface ILocatorDataset

Returns:

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

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.

getMatchFields

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

Fields contained in the geocoding result.

Specified by:

getMatchFields in interface IAddressGeocoding

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.

matchAddress

public IPropertySet matchAddress(IPropertySet address)
                          throws java.io.IOException,
                                 AutomationException

Geocodes a single address.

Specified by:

matchAddress in interface IAddressGeocoding

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (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.

matchTable

public void matchTable(ITable addressTable,
                       java.lang.String addressFieldNames,
                       java.lang.String whereClause,
                       IFeatureClass outputFeatureClass,
                       java.lang.String outputFieldNames,
                       IPropertySet fieldsToCopy,
                       ITrackCancel cancelTracker)
                throws java.io.IOException,
                       AutomationException

Geocodes a table of addresses.

Specified by:

matchTable in interface IAddressGeocoding

Parameters:

addressTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

addressFieldNames - The addressFieldNames (in)

whereClause - The whereClause (in)

outputFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (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.

validate

public void validate()
              throws java.io.IOException,
                     AutomationException

Checks that the locator properties and locator dataset are present and valid.

Specified by:

validate in interface IAddressGeocoding

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCandidateFields

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

Fields contained in a list of candidates.

Specified by:

getCandidateFields in interface IAddressCandidates

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.

findAddressCandidates

public IArray findAddressCandidates(IPropertySet address)
                             throws java.io.IOException,
                                    AutomationException

Generates candidates for an address.

Specified by:

findAddressCandidates in interface IAddressCandidates

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findMatchingAddressCandidates

public IArray findMatchingAddressCandidates(IPropertySet address)
                                     throws java.io.IOException,
                                            AutomationException

Generates candidates for an address, including only matching ones.

Specified by:

findMatchingAddressCandidates in interface IAddressCandidates2

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reverseGeocode

public IPropertySet reverseGeocode(IPoint location,
                                   boolean bReturnIntersection)
                            throws java.io.IOException,
                                   AutomationException

Generate an address based on a point.

Specified by:

reverseGeocode in interface IReverseGeocoding

Parameters:

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

bReturnIntersection - The bReturnIntersection (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.

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.

getIntersectionCandidateFields

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

Fields contained by intersection candidates.

Specified by:

getIntersectionCandidateFields in interface IIntersectionGeocoding

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.

isIntersection

public boolean isIntersection(IPropertySet address)
                       throws java.io.IOException,
                              AutomationException

Indicates if an address is an intersection.

Specified by:

isIntersection in interface IIntersectionGeocoding

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

The isAnIntersection

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.

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.