com.esri.arcgis.location
Class IGeocodingProperties2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.location.IAddressInputsProxy
          com.esri.arcgis.location.IGeocodingPropertiesProxy
              com.esri.arcgis.location.IGeocodingProperties2Proxy

All Implemented Interfaces:

IAddressInputs, IGeocodingProperties, IGeocodingProperties2, Externalizable, Serializable

public class IGeocodingProperties2Proxy
extends IGeocodingPropertiesProxy
implements IGeocodingProperties2, Serializable

Provides access to members that control geocoding settings.

When To Use

Use the IGeocodingProperties2 interface to inspect and set properties specific to address locators that use the second generation ESRI geocoding engine.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGeocodingProperties2Proxy()
	IGeocodingProperties2Proxy(Object obj)
protected	IGeocodingProperties2Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
double	getEndOffsetDistance() End offset using either distance or percentage.
int	getEndOffsetDistanceUnits() Units used for the end offset.
void	removeListener(String iidStr, Object theListener)
void	setEndOffsetDistance(double endOffset) End offset using either distance or percentage.
void	setEndOffsetDistanceUnits(int endOffsetDistanceUnits) Units used for the end offset.

Methods inherited from class com.esri.arcgis.location.IGeocodingPropertiesProxy

getEndOffset, getIntersectionConnectors, getMinimumCandidateScore, getMinimumMatchScore, getSideOffset, getSideOffsetUnits, getSpellingSensitivity, isAddPercentAlongToMatchFields, isAddReferenceIDToMatchFields, isAddStandardizeStringToMatchFields, isAddXYCoordsToMatchFields, isMatchIfScoresTie, isUseRelativePaths, setAddPercentAlongToMatchFields, setAddReferenceIDToMatchFields, setAddStandardizeStringToMatchFields, setAddXYCoordsToMatchFields, setDefaultInputFieldNames, setEndOffset, setIntersectionConnectors, setMatchIfScoresTie, setMinimumCandidateScore, setMinimumMatchScore, setSideOffset, setSideOffsetUnits, setSpellingSensitivity, setUseRelativePaths

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

getEndOffset, getIntersectionConnectors, getMinimumCandidateScore, getMinimumMatchScore, getSideOffset, getSideOffsetUnits, getSpellingSensitivity, isAddPercentAlongToMatchFields, isAddReferenceIDToMatchFields, isAddStandardizeStringToMatchFields, isAddXYCoordsToMatchFields, isMatchIfScoresTie, isUseRelativePaths, setAddPercentAlongToMatchFields, setAddReferenceIDToMatchFields, setAddStandardizeStringToMatchFields, setAddXYCoordsToMatchFields, setDefaultInputFieldNames, setEndOffset, setIntersectionConnectors, setMatchIfScoresTie, setMinimumCandidateScore, setMinimumMatchScore, setSideOffset, setSideOffsetUnits, setSpellingSensitivity, setUseRelativePaths

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

getAddressFields, getDefaultInputFieldNames

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGeocodingProperties2Proxy

public IGeocodingProperties2Proxy()

IGeocodingProperties2Proxy

public IGeocodingProperties2Proxy(Object obj)
                           throws IOException

Throws:

IOException

IGeocodingProperties2Proxy

protected IGeocodingProperties2Proxy(Object obj,
                                     String iid)
                              throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class IGeocodingPropertiesProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IGeocodingPropertiesProxy

Throws:

IOException

getEndOffsetDistance

public double getEndOffsetDistance()
                            throws IOException,
                                   AutomationException

End offset using either distance or percentage.

Remarks

Locators that use polyline features as reference data interpolate positions along reference data features for geocoded addresses. In order to prevent features that are located at the end of a reference data feature from falling on top of other features (for example, a cross street), the locator can apply a “squeeze factor”, or end offset, to the location of a geocoded address.

The EndOffsetDistance property specifies by what amount to offset geocoded locations from the end of reference data features, and is expressed as either a percentage of the length of the reference feature, between 0.0 percent and 50.0 percent, or as a set distance.

Product Availability

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

Specified by:

getEndOffsetDistance in interface IGeocodingProperties2

Returns:

The endOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffsetDistance

public void setEndOffsetDistance(double endOffset)
                          throws IOException,
                                 AutomationException

End offset using either distance or percentage.

Product Availability

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

Specified by:

setEndOffsetDistance in interface IGeocodingProperties2

Parameters:

endOffset - The endOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffsetDistanceUnits

public int getEndOffsetDistanceUnits()
                              throws IOException,
                                     AutomationException

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

Remarks

Locators that use polyline features as reference data interpolate positions along reference data features for geocoded addresses. For those locators, you can specify an end offset using the EndOffsetDistance property, which specifies by what amount to offset geocoded locations from the end of reference data features. The EndOffsetDistanceUnits property specifies the units for the end offset.

You can use these properties prevent features that are located at the end of a reference data feature from falling on top of other features (for example, a cross street). By default, the value of the EndOffsetDistanceUnits property is esriUnknownUnits, which indicates to use the reference data’s units.

Product Availability

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

Specified by:

getEndOffsetDistanceUnits in interface IGeocodingProperties2

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffsetDistanceUnits

public void setEndOffsetDistanceUnits(int endOffsetDistanceUnits)
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Specified by:

setEndOffsetDistanceUnits in interface IGeocodingProperties2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.