com.esri.arcgis.location
Interface IAttachedLocator

All Superinterfaces:
Serializable
All Known Implementing Classes:
AttachedLocator, IAttachedLocatorProxy

public interface IAttachedLocator
extends Serializable

Provides access to members that describe the process used to create the feature class.

Remarks

To rematch a geocoded feature class programatically, use the IAttachedLocator interface to retrieve all of the information about the locator that is attached to the dataset. Then, use the IAdvancedGeocoding::RematchTable method with the information from the AttachedLocator to rematch the geocoded feature class.

When To Use

Use the IAttachedLocator interface to retrieve information about the locator that is attached to a dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset), ILocatorAttach2.attachLocator(com.esri.arcgis.geodatabase.ILocator, com.esri.arcgis.geodatabase.ITable, String, String)

Method Summary
 String getInputFieldNamesList()
          Names of fields in the input table used by the locator.
 String getInputJoinFieldName()
          Name of the ObjectID field in the input table.
 ITable getInputTable()
          Table that was located.
 ILocator getLocator()
          Locator used to create the feature class.
 String getOutputFieldNamesList()
          Names of result fields in the output feature class.
 String getOutputJoinFieldName()
          Name of the JoinOID field in the output feature class.
 ITable getOutputTable()
          Feature class that was created.
 

Method Detail

getInputTable

ITable getInputTable()
                     throws IOException,
                            AutomationException
Table that was located.

Description

The InputTable property returns a reference to the table containing the address information that was used to create the geocoded feature class.

Remarks

For geocoded feature classes created with ArcCatalog or ArcMap, this property always returns a reference to the geocoded feature class itself. When you geocode a table using ArcCatalog or ArcMap, the address fields are copied from the address table to the geocoded feature class, and are prefixed with "ARC_". By default, ArcCatalog and ArcMap use these fields, not the fields from the original address table, when rematching the geocoded feature class.

ArcCatalog and ArcMap copy fields from the address table to the geocoded 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.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)

getInputFieldNamesList

String getInputFieldNamesList()
                              throws IOException,
                                     AutomationException
Names of fields in the input table used by the locator.

Remarks

The InputFieldNamesList property returns a comma-delimited string that contains the names of the fields in the table returned by the InputTable that are used as address fields by the locator. The fields in this string are in the same order as specified by the IAddressInputs::AddressFields property on the locator.

For geocoded feature classes created with ArcCatalog or ArcMap, these fields are always contained in the geocoded feature class itself. When you geocode a table using ArcCatalog or ArcMap, the address fields are copied from the address table to the geocoded feature class, and are prefixed with "ARC_". By default, ArcCatalog and ArcMap use these fields, not the fields from the original address table, when rematching the geocoded feature class.

ArcCatalog and ArcMap copy the address fields from the address table to the geocoded feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fieldNames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, IAddressInputs, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)

getInputJoinFieldName

String getInputJoinFieldName()
                             throws IOException,
                                    AutomationException
Name of the ObjectID field in the input table.

Remarks

The InputJoinFieldName property returns the name of the field in the table returned by the InputTable property that is used to relate records in the address table to features in the output feature class, specified by the OutputTable property.

For geocoded feature classes created with ArcCatalog or ArcMap, the table returned by the InputTable property is always the geocoded feature class itself, and the InputJoinFieldName property returns the name of the ObjectID field. When you geocode a table using ArcCatalog or ArcMap, the address fields are copied from the address table to the geocoded feature class, and are prefixed with "ARC_". By default, ArcCatalog and ArcMap use these fields, not the fields from the original address table, when rematching the geocoded feature class.

ArcCatalog and ArcMap copy the address fields from the address table to the geocoded feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)

getOutputTable

ITable getOutputTable()
                      throws IOException,
                             AutomationException
Feature class that was created.

Description

The OutputTable property returns a reference to the geocoded 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.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)

getOutputFieldNamesList

String getOutputFieldNamesList()
                               throws IOException,
                                      AutomationException
Names of result fields in the output feature class.

Remarks

The OutputFieldNamesList property returns a comma-delimited string that contains the names of the fields in the table returned by the OutputTable property that contain the match information. The fields in this string are in the same order as specified by the IAddressGeocoding::MatchFields property on the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fieldNames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, IAddressGeocoding.getMatchFields(), ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)

getOutputJoinFieldName

String getOutputJoinFieldName()
                              throws IOException,
                                     AutomationException
Name of the JoinOID field in the output feature class.

Remarks

The OutputJoinFieldName property returns the name of the field in the geocoded feature class that is used to relate records in the address table, specified by the InputTable property, to features in the output feature class.

For geocoded feature classes created with ArcCatalog or ArcMap, the OutputJoinFieldName property always returns the name of the ObjectID field in the geocoded feature class, since the table returned by the InputTable and OutputTable properties is always the geocoded feature class for both. When you geocode a table using ArcCatalog or ArcMap, the address fields are copied from the address table to the geocoded feature class, and are prefixed with "ARC_". By default, ArcCatalog and ArcMap use these fields, not the fields from the original address table, when rematching the geocoded feature class.

ArcCatalog and ArcMap copy the address fields from the address table to the geocoded feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)

getLocator

ILocator getLocator()
                    throws IOException,
                           AutomationException
Locator used to create the feature class.

Description

The Locator property returns a copy of the locator, including runtime geocoding options, that was used to create the geocoded 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.ILocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)