com.esri.arcgis.location
Interface IGeocodingProperties

All Superinterfaces:

IAddressInputs, java.io.Serializable

All Known Subinterfaces:

IGeocodingProperties2

All Known Implementing Classes:

AGSAddressLocator, CompositeLocator, ESRIFDOAddressLocator, ESRIFDOAddressLocatorStyle, ESRIGen2AddressLocator, ESRIGen2AddressLocatorStyle, IGeocodingProperties2Proxy, IGeocodingPropertiesProxy, RSLocator, StreetMapAddressLocator, StreetMapAddressLocatorStyle

public interface IGeocodingProperties
extends IAddressInputs, java.io.Serializable

COM Interface 'IGeocodingProperties'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description: 'Provides access to members that control geocoding settings.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID600a5896_ddc1_11d3_9f74_00c04f8ed1c4
static int	xxDummy Deprecated. Internal use only

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

IID600a589d_ddc1_11d3_9f74_00c04f8ed1c4

Method Summary

int	getEndOffset() End offset percentage.
java.lang.String	getIntersectionConnectors() Connector strings used to designate intersections.
int	getMinimumCandidateScore() Minimum candidate score setting.
int	getMinimumMatchScore() Minimum match score setting.
double	getSideOffset() Side offset distance.
int	getSideOffsetUnits() Units used for the side offset.
int	getSpellingSensitivity() Spelling sensitivity setting.
boolean	isAddPercentAlongToMatchFields() Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.
boolean	isAddReferenceIDToMatchFields() Indicates if the feature ID of the matched feature is included in the geocoding result.
boolean	isAddStandardizeStringToMatchFields() Indicates if the standardized address is included in the geocoding result.
boolean	isAddXYCoordsToMatchFields() Indicates if the x and y coordinates of the address location are included in the geocoding result.
boolean	isMatchIfScoresTie() Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.
boolean	isUseRelativePaths() Indicates if the paths to the reference data should be stored relative to the locator.
void	setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields) Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.
void	setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields) Indicates if the feature ID of the matched feature is included in the geocoding result.
void	setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields) Indicates if the standardized address is included in the geocoding result.
void	setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields) Indicates if the x and y coordinates of the address location are included in the geocoding result.
void	setDefaultInputFieldNames(java.lang.String addressField, java.lang.Object rhs2) Recognized names for a required input field.
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	setSideOffset(double sideOffset) Side offset distance.
void	setSideOffsetUnits(int sideOffsetUnits) Units used for the side offset.
void	setSpellingSensitivity(int spellingSensitivity) Spelling sensitivity setting.
void	setUseRelativePaths(boolean bUseRelativePaths) Indicates if the paths to the reference data should be stored relative to the locator.

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

getAddressFields, getDefaultInputFieldNames

Field Detail

IID600a5896_ddc1_11d3_9f74_00c04f8ed1c4

static final int IID600a5896_ddc1_11d3_9f74_00c04f8ed1c4

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getMinimumMatchScore

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

Minimum match score setting.

Returns:

The minimumMatchScore

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumMatchScore

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

Minimum match score setting.

Parameters:

minimumMatchScore - The minimumMatchScore (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumCandidateScore

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

Minimum candidate score setting.

Returns:

The minimumCandidateScore

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumCandidateScore

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

Minimum candidate score setting.

Parameters:

minimumCandidateScore - The minimumCandidateScore (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpellingSensitivity

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

Spelling sensitivity setting.

Returns:

The spellingSensitivity

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpellingSensitivity

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

Spelling sensitivity setting.

Parameters:

spellingSensitivity - The spellingSensitivity (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndOffset

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

End offset percentage.

Returns:

The endOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndOffset

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

End offset percentage.

Parameters:

endOffset - The endOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSideOffset

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

Side offset distance.

Returns:

The sideOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSideOffset

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

Side offset distance.

Parameters:

sideOffset - The sideOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSideOffsetUnits

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

Units used for the side offset.

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

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

Units used for the side offset.

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

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

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

Returns:

The bAddXYCoordsToMatchFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddXYCoordsToMatchFields

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.

Parameters:

bAddXYCoordsToMatchFields - The bAddXYCoordsToMatchFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAddStandardizeStringToMatchFields

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

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

Returns:

The bAddStandardizeStringToMatchFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddStandardizeStringToMatchFields

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

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

Parameters:

bAddStandardizeStringToMatchFields - The bAddStandardizeStringToMatchFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAddReferenceIDToMatchFields

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

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

Returns:

The bAddReferenceIDToMatchFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddReferenceIDToMatchFields

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

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

Parameters:

bAddReferenceIDToMatchFields - The bAddReferenceIDToMatchFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAddPercentAlongToMatchFields

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.

Returns:

The bAddPercentAlongToMatchFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddPercentAlongToMatchFields

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.

Parameters:

bAddPercentAlongToMatchFields - The bAddPercentAlongToMatchFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMatchIfScoresTie

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.

Returns:

The bMatchIfScoresTie

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMatchIfScoresTie

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.

Parameters:

bMatchIfScoresTie - The bMatchIfScoresTie (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

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

Recognized names for a required input field.

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

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

Connector strings used to designate intersections.

Returns:

The intersectionConnectors

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIntersectionConnectors

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

Connector strings used to designate intersections.

Parameters:

intersectionConnectors - The intersectionConnectors (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseRelativePaths

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

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

Returns:

The bUseRelativePaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseRelativePaths

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

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

Parameters:

bUseRelativePaths - The bUseRelativePaths (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.