com.esri.arcgis.location
Class ReferenceDataIndex

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IReferenceDataIndex, IReferenceDataIndexEdit, ISupportErrorInfo, Serializable

public class ReferenceDataIndex
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IReferenceDataIndex, IReferenceDataIndexEdit, ISupportErrorInfo

A reference data index definition for a reference data table.

Description

A ReferenceDataIndex describes a geocoding index on a ReferenceDataTable used by a locator. This object only applies to pre-9.2 locator indexes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

GeocodingIndexObject, GeocodingIndexClassExtension, ReferenceDataIndex, IReferenceDataTable.getGeocodingIndexes(), IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, ReferenceDataTableEnumerator, IGeocodingIndexCompute, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, IReferenceDataIndex, ReferenceDataTable, IReferenceDataIndexEdit, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex, Serialized Form

Constructor Summary

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

Method Summary

void	build(String configKeyword, ITrackCancel cancelTracker) Builds the geocoding index.
boolean	equals(Object o) Compare this object with another
String	getDisplayName() Name for the geocoding index to display in the user interface.
String	getName() Name of the geocoding index.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isExists() Indicates if the geocoding index exists.
void	setName(String rhs1) Name of the geocoding index.

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

ReferenceDataIndex

public ReferenceDataIndex(Object obj)
                   throws IOException

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

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

Throws:

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

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

Name for the geocoding index to display in the user interface.

Remarks

Returns the name of the geocoding index that is displayed on the user interface. 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:

getDisplayName in interface IReferenceDataIndex

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the geocoding index.

Remarks

The Name property returns the fully-qualified name of the geocoding index. 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:

getName in interface IReferenceDataIndex

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExists

public boolean isExists()
                 throws IOException,
                        AutomationException

Indicates if the geocoding index exists.

Remarks

The Exists property returns True if the geocoding index exists, or False if not. 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:

isExists in interface IReferenceDataIndex

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

build

public void build(String configKeyword,
                  ITrackCancel cancelTracker)
           throws IOException,
                  AutomationException

Builds the geocoding index.

Remarks

When you use the Build method, the geocoding index is built using the current atribute values in the ReferenceDataTable that it indexes. If the geocoding index already exists, then the index is deleted if you have permissions to do so, and the index is rebuilt. This method 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:

build in interface IReferenceDataIndex

Parameters:

configKeyword - The configKeyword (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException

Name of the geocoding index.

Description

The Name property lets you specify the name of the Table or file to which the ReferenceDataIndex refers. This property only applies to pre-9.2 locators.

Remarks

The Table or file must be contained within the same Workspace as the ReferenceDataTable that it indexes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IReferenceDataIndexEdit

Parameters:

rhs1 - The rhs1 (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.