com.esri.arcgis.location
Class IReferenceDataTableProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.location.IReferenceDataTableProxy
All Implemented Interfaces:
IReferenceDataTable, Externalizable, Serializable
Direct Known Subclasses:
IReferenceDataTable2Proxy, IReferenceDataTableEditProxy

public class IReferenceDataTableProxy
extends com.esri.arcgis.interop.Dispatch
implements IReferenceDataTable, Serializable

Provides access to members for retrieving reference data table information.

Superseded By

IReferenceDataTable2

When To Use

Use the IReferenceDataTable interface to obtain information about a Feature-Data-Object data source that a locator uses as reference data.

Product Availability

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

See Also:
ReferenceDataIndex, IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, ReferenceDataTableEnumerator, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, ReferenceDataTable, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex, Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IReferenceDataTableProxy()
           
  IReferenceDataTableProxy(Object obj)
           
protected IReferenceDataTableProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getDisplayName()
          Name for the reference data table to display in the user interface.
 IEnumReferenceDataField getFields()
          Reference data fields in the reference data table.
 IArray getFilters()
          Filters to use to browse for the reference data table.
 IEnumReferenceDataIndex getGeocodingIndexes()
          Geocoding indexes on the reference data table.
 ITableName getName()
          Name of the reference data table.
 void removeListener(String iidStr, Object theListener)
           
 
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

IReferenceDataTableProxy

public IReferenceDataTableProxy()

IReferenceDataTableProxy

public IReferenceDataTableProxy(Object obj)
                         throws IOException
Throws:
IOException

IReferenceDataTableProxy

protected IReferenceDataTableProxy(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

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException
Name for the reference data table to display in the user interface.

Remarks

You can use the DisplayName property to determine how a locator uses the reference data source. Locators created with ArcGIS use a display name of "Primary table" for the primary reference data source used by the locator. Alternate street name tables have a display name of "Alternate Name table". Locators based on geocoding indexes created in ArcView 3 use a display name of "Table1" for their reference data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayName in interface IReferenceDataTable
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IEnumReferenceDataField getFields()
                                  throws IOException,
                                         AutomationException
Reference data fields in the reference data table.

Description

Returns a ReferenceDataFieldsEnumerator that contains descriptions of the Fields in the ReferenceDataTable that are used by the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFields in interface IReferenceDataTable
Returns:
A reference to a com.esri.arcgis.location.IEnumReferenceDataField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeocodingIndexes

public IEnumReferenceDataIndex getGeocodingIndexes()
                                            throws IOException,
                                                   AutomationException
Geocoding indexes on the reference data table.

Description

Returns a EnumReferenceDataIndex that retrieves the geocoding indexes used by the locator. This property only applies to pre-9.2 locators.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGeocodingIndexes in interface IReferenceDataTable
Returns:
A reference to a com.esri.arcgis.location.IEnumReferenceDataIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public ITableName getName()
                   throws IOException,
                          AutomationException
Name of the reference data table.

Description

Returns a TableName object that describes the data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IReferenceDataTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ITableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilters

public IArray getFilters()
                  throws IOException,
                         AutomationException
Filters to use to browse for the reference data table.

Remarks

Returns an Array of GxObjectFilters that you can use to allow the user to browse for reference data for a locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFilters in interface IReferenceDataTable
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.