com.esri.arcgis.location
Interface IGeocodingProperties2

All Superinterfaces:

IAddressInputs, IGeocodingProperties, Serializable

All Known Implementing Classes:

ESRIGen2AddressLocator, ESRIGen2AddressLocatorStyle, IGeocodingProperties2Proxy

public interface IGeocodingProperties2
extends IGeocodingProperties, 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.

Method Summary

double	getEndOffsetDistance() End offset using either distance or percentage.
int	getEndOffsetDistanceUnits() Units used for the end offset.
void	setEndOffsetDistance(double endOffset) End offset using either distance or percentage.
void	setEndOffsetDistanceUnits(int endOffsetDistanceUnits) Units used for the end offset.

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

Method Detail

getEndOffsetDistance

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.

Returns:

The endOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffsetDistance

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.

Parameters:

endOffset - The endOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffsetDistanceUnits

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.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffsetDistanceUnits

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.

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.