com.esri.arcgis.location
Interface IReferenceDataIndex

All Superinterfaces:
Serializable
All Known Subinterfaces:
IReferenceDataIndexEdit
All Known Implementing Classes:
IReferenceDataIndexEditProxy, IReferenceDataIndexProxy, ReferenceDataIndex

public interface IReferenceDataIndex
extends Serializable

Provides access to members for retrieving the geocoding index.

When To Use

Use the IReferenceDataIndex interface to get properties that describe the ReferenceDataIndex, and to build the index. This interface only applies to pre-9.2 locators.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
GeocodingIndexObject, GeocodingIndexClassExtension, ReferenceDataIndex, IReferenceDataTable.getGeocodingIndexes(), IGeocodingIndexCompute, IReferenceDataIndex, IReferenceDataIndexEdit, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex

Method Summary
 void build(String configKeyword, ITrackCancel cancelTracker)
          Builds the geocoding index.
 String getDisplayName()
          Name for the geocoding index to display in the user interface.
 String getName()
          Name of the geocoding index.
 boolean isExists()
          Indicates if the geocoding index exists.
 

Method Detail

getDisplayName

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

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

getName

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

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

isExists

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

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

build

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

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.