com.esri.arcgis.location
Interface ILocatorAttach

All Superinterfaces:
Serializable
All Known Implementing Classes:
AGSLocatorWorkspace, DatabaseLocatorWorkspace, ILocatorAttachProxy, LocalLocatorWorkspace

public interface ILocatorAttach
extends Serializable

Provides access to members that attach locators to datasets.

Superseded By

ILocatorAttach2

When To Use

Use the ILocatorAttach interface to attach a locator to a located dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void attachLocator(ILocator locator, ITable attachToTable, ITable inputTable, String inputFieldNames, String inputJoinFieldName, ITable outputTable, String outputFieldNames, String outputJoinFieldName)
          Attaches a locator to a table.
 

Method Detail

attachLocator

void attachLocator(ILocator locator,
                   ITable attachToTable,
                   ITable inputTable,
                   String inputFieldNames,
                   String inputJoinFieldName,
                   ITable outputTable,
                   String outputFieldNames,
                   String outputJoinFieldName)
                   throws IOException,
                          AutomationException
Attaches a locator to a table.

Remarks

The AttachLocator method attaches a locator to a dataset. After creating a dataset using a locator, you should attach the locator to the dataset so that it can be rematched.

The Locator parameter specifies the locator that you want to attach to the dataset. Usually, this is the locator that you used to create the dataset.

The attachToTable parameter specifies the dataset to which you want to attach the locator.

The InputTable parameter specifies the dataset that contains the input attributes required by the locator. When you locate a table, you should copy the input attributes to the output dataset, and this property should then refer to the located dataset.

The InputFieldNames parameter is a comma-delimited string that specifies the names of the fields in InputTable that contain the input attributes required by the locator.

Use the InputJoinFieldName parameter to specify the attribute in InputTable that relates records in the input table to records in the located dataset. Normally, you will use the name of the ObjectID attribute in the located dataset for this parameter.

The OutputFieldNames parameter is a comma-delimited string that specifies the names of the fields in the located dataset that contain the match attributes generated by the locator. If the locator supports the IAddressGeocoding interface, you can use the MatchFields property to determine which fields contain the match attributes.

Use the OutputJoinFieldName parameter to specify the attribute in the located dataset that relates records in the located dataset to records in InputTable. Normally, you will use the name of the ObjectID attribute in the located dataset for this parameter.

The OutputTable parameter specifies the dataset that contains the result fields created by the address locator. Typically, this is the geocoded feature class, and is the dataset to which you are attaching the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
locator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
attachToTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
inputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
inputFieldNames - The inputFieldNames (in)
inputJoinFieldName - The inputJoinFieldName (in)
outputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
outputFieldNames - The outputFieldNames (in)
outputJoinFieldName - The outputJoinFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.