com.esri.arcgis.location
Interface IAddressGeocoding

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAdvancedGeocoding, IAdvancedGeocoding2

All Known Implementing Classes:

AGSAddressLocator, CompositeLocator, ESRIFDOAddressLocator, ESRIGen2AddressLocator, IAddressGeocodingProxy, IAdvancedGeocoding2Proxy, IAdvancedGeocodingProxy, RSLocator, StreetMapAddressLocator

public interface IAddressGeocoding
extends Serializable

Provides access to members for geocoding addresses.

When To Use

Use the IAddressGeocoding interface to geocode single addresses and tables of addresses.

Product Availability

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

See Also:

IAddressGeocoding.matchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, com.esri.arcgis.system.IPropertySet, com.esri.arcgis.system.ITrackCancel), IAdvancedGeocoding.rematchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, String, String, com.esri.arcgis.system.ITrackCancel), IAddressGeocoding.matchAddress(com.esri.arcgis.system.IPropertySet), IAddressGeocoding

Method Summary

IFields	getMatchFields() Fields contained in the geocoding result.
IPropertySet	matchAddress(IPropertySet address) Geocodes a single address.
void	matchTable(ITable addressTable, String addressFieldNames, String whereClause, IFeatureClass outputFeatureClass, String outputFieldNames, IPropertySet fieldsToCopy, ITrackCancel cancelTracker) Geocodes a table of addresses.
void	validate() Checks that the locator properties and locator dataset are present and valid.

Method Detail

getMatchFields

IFields getMatchFields()
                       throws IOException,
                              AutomationException

Fields contained in the geocoding result.

Description

The MatchFields property returns the fields that are created by the address locator for matched addresses.

Remarks

The MatchFields that can be returned by geocoding services included with ArcGIS are:

• Match_addr - The address that the matched location actually resides based on the information of the matched candidate. For example, an input address "123 Main St N" is matched to a candidate with the suffix direction 'NW" and all other components matched correctly. The Match_addr field will contain "123 Main St NW" as the actual address that was matched.
• Pct_along - For address locators that use feature classes with polyline geometry as reference data, the percentage along the matched feature at which the matched address is located.
• Ref_ID - The ObjectID of the matched feature.
• Score - A number between 0 and 100 indicating the score of the matched feature. A score of 100 represents an exact match.
• Shape - The geometry for the matched address.
• Side - For address locators that can match addresses to a particular side of a street, the side of the street on which the address matches the matched feature. A value of "L" indicates the left side of the street, and a value of "R" indicates the right side of the street.
• Stan_addr - The standardized address.
• Status - A string value that indicates whether the address was matched ("M"), unmatched ("U"), or had two or more candidates tied with the best score ("T").
• X - The x coordinate of the matched address.
• Y - The y coordinate of the matched address.

All address locators based on the address locator styles provided with ArcGIS return the Shape, Status , Score and Match_addr fields.

You can use the fields returned by this property to inspect the match returned by the MatchAddress method, or to define the feature class that is created using the MatchTable method. See the MatchTable method for more information on fields written to the result feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IAddressGeocoding.matchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, com.esri.arcgis.system.IPropertySet, com.esri.arcgis.system.ITrackCancel), IAdvancedGeocoding.rematchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, String, String, com.esri.arcgis.system.ITrackCancel), IAddressGeocoding.matchAddress(com.esri.arcgis.system.IPropertySet), IAddressGeocoding

matchAddress

IPropertySet matchAddress(IPropertySet address)
                          throws IOException,
                                 AutomationException

Geocodes a single address.

Remarks

The address parameter is a PropertySet that contains the components of the address that you want to match. The property names in this PropertySet are defined by the IAddressInputs::AddressFields property.

The PropertySet returned by this method contains properties defined by the MatchFields property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IAddressGeocoding.matchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, com.esri.arcgis.system.IPropertySet, com.esri.arcgis.system.ITrackCancel), IAdvancedGeocoding.rematchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, String, String, com.esri.arcgis.system.ITrackCancel), IAddressGeocoding.matchAddress(com.esri.arcgis.system.IPropertySet), IAddressGeocoding

matchTable

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

Geocodes a table of addresses.

Description

The MatchTable method geocodes a table of addresses to a feature class.

Remarks

Before you geocode a table of addresses, you must first create the feature class that will contain the geocoded features. In addition to having an ObjectID and the match fields created by the locator, you can also specify fields from the address table to copy to the geocoded feature class. When you geocode a table of addresses using ArcGIS for Desktop, the output feature class contains two copies of the address fields from the address table. One copy is a static copy that contains the original values of the address components from the address table. The second copy is an editable copy that you can use to modify the address when rematching the geocoded feature class. The names of the latter set of address fields are prefixed with "ARC_". In general, it is a good idea to follow this pattern when programatically geocoding a table of addresses, since the locator that you attach to the geocoded feature class will then only need to refer to the geocoded feature class itself (and not the original address table) to be able to rematch the addresses in the geocoded feature class.

The addressFieldNames parameter is used to specify the names of the fields in the addressTable that contain address information. The field names are contained in a comma-delimited string, in the order required by the address locator. You can get the set of address fields for the geocoding service using IAddressInputs::AddressFields. Use the IField::Required property to determine which address fields are required by the address locator. You must specify the names of the required fields in the address table. If your address table does not contain an optional address field, do not specify a name in the this property.

The WhereClause parameter is used to restrict which addresses in the table are geocoded using a query.

The outputFeatureClass parameter is the feature class that will contain the geocoded addresses. This feature class must have an ObjectID field, and the match fields for the address locator. Use the MatchFields property to get the match fields for the address locator. In addition to the fields returned from the MatchFields property, the result feature class also contains the Match_type field indicating how an adddress was matched. The field may contain the following values assigned by IAddressGeocoding::MatchTable or IAddressUI::RematchTable

• A - Automatically matched or rematched.
• M - If the geocoded feature classes are rematched using the Interactive Rematch dialog box, you may see other values including "M" for manually matched or unmatched using the Match or Unmatch button.
• PP - Pick by Point. The address was matched to the click point using the Pick Address from Map tool in the Interactive Rematch dialog box with ArcMap.
• PA - Pick by Address. That means the address was matched to closest address with the Pick Address from Map tool.

To copy any additional fields from the address table, or to create new fields in the feature class, you must also add them to the feature class before geocoding the table.

The outputFieldNames parameter is a string containing a comma-delimited list of the names of the match fields in the feature class. The names of the fields must be specified in the same order as defined by the address locator. Use the MatchFields property to get the match fields for the address locator.

The fieldsToCopy parameter allows you to copy values from fields in the address table to the feature class. To copy a field, add a property to the PropertySet with the name of the destination field in the feature class, and with a value of the name of the field in the address table. You must add the the field to the feature class when you create it in order to copy values from the address table.

The CancelTracker parameter allows you to optionally display the progress while the geocoding service geocodes the table of addresses.

To be able to rematch a geocoded feature class, you must attach a locator to the geocoded feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILocatorManager2, IAddressGeocoding.matchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, com.esri.arcgis.system.IPropertySet, com.esri.arcgis.system.ITrackCancel), AttachedLocator, ILocatorAttach2, IAttachedLocator, IAdvancedGeocoding.rematchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, String, String, com.esri.arcgis.system.ITrackCancel), ILocatorManager, LocatorManager, IAddressGeocoding.matchAddress(com.esri.arcgis.system.IPropertySet), IAddressGeocoding, ILocatorAttach2.attachLocator(com.esri.arcgis.geodatabase.ILocator, com.esri.arcgis.geodatabase.ITable, String, String)

validate

void validate()
              throws IOException,
                     AutomationException

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

Remarks

The Validate method allows you to check that the locator is ready to be used. This method checks if the locator properties and locator dataset are present and valid.

This method preloads all locators referenced by a composite locator. Use this method to optimize performance as locators are loaded on application startup, so that the first geocoding operation will run quickly.

This method returns a value of True if the locator is valid, and returns an error if it is not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

GeocodingIndexObject, GeocodingIndexClassExtension, IReferenceDataTable.getGeocodingIndexes(), ReferenceDataIndex, IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, IGeocodingIndexCompute, ReferenceDataTableEnumerator, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, IReferenceDataIndex, IReferenceDataIndexEdit, ReferenceDataTable, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex