com.esri.arcgis.location
Class IGeocodingPropertiesProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.location.IAddressInputsProxy
          extended by com.esri.arcgis.location.IGeocodingPropertiesProxy
All Implemented Interfaces:
IAddressInputs, IGeocodingProperties, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IGeocodingProperties2Proxy

public class IGeocodingPropertiesProxy
extends IAddressInputsProxy
implements IGeocodingProperties, java.io.Serializable

Internal use class Proxy for 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 =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.location.IGeocodingProperties
IID, IID600a5896_ddc1_11d3_9f74_00c04f8ed1c4
 
Fields inherited from interface com.esri.arcgis.location.IAddressInputs
IID600a589d_ddc1_11d3_9f74_00c04f8ed1c4
 
Constructor Summary
  IGeocodingPropertiesProxy()
          For internal use only
  IGeocodingPropertiesProxy(java.lang.Object obj)
           
protected IGeocodingPropertiesProxy(java.lang.Object obj, java.lang.String iid)
           
  IGeocodingPropertiesProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IGeocodingPropertiesProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 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 removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 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 class com.esri.arcgis.location.IAddressInputsProxy
getAddressFields, getDefaultInputFieldNames
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.location.IAddressInputs
getAddressFields, getDefaultInputFieldNames
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IGeocodingPropertiesProxy

public IGeocodingPropertiesProxy(java.lang.String CLSID,
                                 java.lang.String host,
                                 com.esri.arcgis.interop.AuthInfo authInfo)
                          throws java.net.UnknownHostException,
                                 java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IGeocodingPropertiesProxy

public IGeocodingPropertiesProxy()
For internal use only


IGeocodingPropertiesProxy

public IGeocodingPropertiesProxy(java.lang.Object obj)
                          throws java.io.IOException
Throws:
java.io.IOException

IGeocodingPropertiesProxy

protected IGeocodingPropertiesProxy(java.lang.Object obj,
                                    java.lang.String iid)
                             throws java.io.IOException
Throws:
java.io.IOException

IGeocodingPropertiesProxy

protected IGeocodingPropertiesProxy(java.lang.String CLSID,
                                    java.lang.String iid,
                                    java.lang.String host,
                                    com.esri.arcgis.interop.AuthInfo authInfo)
                             throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class IAddressInputsProxy
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class IAddressInputsProxy
Throws:
java.io.IOException

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.