com.esri.arcgis.location
Class IAttachedLocatorProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.location.IAttachedLocatorProxy
All Implemented Interfaces:
IAttachedLocator, Externalizable, Serializable

public class IAttachedLocatorProxy
extends com.esri.arcgis.interop.Dispatch
implements IAttachedLocator, 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), Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IAttachedLocatorProxy()
           
  IAttachedLocatorProxy(Object obj)
           
protected IAttachedLocatorProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IAttachedLocatorProxy

public IAttachedLocatorProxy()

IAttachedLocatorProxy

public IAttachedLocatorProxy(Object obj)
                      throws IOException
Throws:
IOException

IAttachedLocatorProxy

protected IAttachedLocatorProxy(Object obj,
                                String iid)
                         throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

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.

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

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.

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

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.

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

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.

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

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)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException