com.esri.arcgis.location
Interface IReferenceDataTable

All Superinterfaces:
Serializable
All Known Subinterfaces:
IReferenceDataTable2, IReferenceDataTableEdit
All Known Implementing Classes:
IReferenceDataTable2Proxy, IReferenceDataTableEditProxy, IReferenceDataTableProxy, ReferenceDataTable

public interface IReferenceDataTable
extends 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.

Supported Platforms

Windows, Solaris, Linux

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

Method Summary
 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.
 

Method Detail

getDisplayName

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

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

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

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

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

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

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

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

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

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.