com.esri.arcgis.location
Class AttachedLocator

java.lang.Object
  com.esri.arcgis.location.AttachedLocator

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IAttachedLocator, ISupportErrorInfo, Serializable

public class AttachedLocator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAttachedLocator, ISupportErrorInfo

A locator that is attached to a dataset.

Description

An AttachedLocator describes a locator that is attached to a dataset, along with the names of the input and output fields in the dataset used by the locator.

Remarks

When you geocode a table of addresses using a locator in ArcCatalog or in ArcMap, a copy of that locator is "attached" to the geocoded feature class. Use the AttachedLocator object to retrieve a copy of the locator that is attached to a dataset, in order to examine the geocoding settings that were used to create the geocoded feature class, or to rematch the geocoded feature class. Use the ILocatorManager::GetLocatorFromDataset method to retrieve an attached locator from a dataset.

Developers who geocode a table of addresses using IAddressGeocoding::MatchTable must write additional code to attach the locator to the geocoded feature class using the ILocatorAttach2::AttachLocator method.

Only one locator can be attached to a dataset. If you attach a locator to a dataset that already has an attached locator, the original attached locator will be replaced by the new attached locator.

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), Serialized Form

Constructor Summary

AttachedLocator(Object obj)
Construct a AttachedLocator using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AttachedLocator

public AttachedLocator(Object obj)
                throws IOException

Construct a AttachedLocator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AttachedLocator.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
AttachedLocator o = (AttachedLocator)obj; // will not work

AttachedLocator o = new AttachedLocator(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems AttachedLocator theAttachedLocator = (AttachedLocator) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getInputTable

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInputTable in interface IAttachedLocator

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInputFieldNamesList in interface IAttachedLocator

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInputJoinFieldName in interface IAttachedLocator

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

public 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

Specified by:

getOutputTable in interface IAttachedLocator

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

public 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

Specified by:

getOutputFieldNamesList in interface IAttachedLocator

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutputJoinFieldName in interface IAttachedLocator

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

public 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

Specified by:

getLocator in interface IAttachedLocator

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)

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.