com.esri.arcgis.location
Class ReferenceDataTable

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IReferenceDataTable, IReferenceDataTable2, IReferenceDataTableEdit, ISupportErrorInfo, Serializable

public class ReferenceDataTable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IReferenceDataTable2, IReferenceDataTableEdit, ISupportErrorInfo

A reference data table definition for a locator.

Description

A ReferenceDataTable describes 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, Serialized Form

Constructor Summary

ReferenceDataTable(Object obj)
Construct a ReferenceDataTable 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	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.
IArray	getFilterUIDs() UID's of the 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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	setNameByRef(ITableName rhs1) Name of the reference data table.

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

ReferenceDataTable

public ReferenceDataTable(Object obj)
                   throws IOException

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

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

Throws:

IOException - if there are interop problems ReferenceDataTable theReferenceDataTable = (ReferenceDataTable) 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

getFilterUIDs

public IArray getFilterUIDs()
                     throws IOException,
                            AutomationException

UID's of the filters to use to browse for the reference data table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilterUIDs in interface IReferenceDataTable2

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.

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.

setNameByRef

public void setNameByRef(ITableName rhs1)
                  throws IOException,
                         AutomationException

Name of the reference data table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameByRef in interface IReferenceDataTableEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.ITableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.