com.esri.arcgis.location
Class IReferenceDataIndexProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.location.IReferenceDataIndexProxy

All Implemented Interfaces:

IReferenceDataIndex, Externalizable, Serializable

Direct Known Subclasses:

IReferenceDataIndexEditProxy

public class IReferenceDataIndexProxy
extends com.esri.arcgis.interop.Dispatch
implements IReferenceDataIndex, 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.

See Also:

GeocodingIndexObject, GeocodingIndexClassExtension, ReferenceDataIndex, IReferenceDataTable.getGeocodingIndexes(), IGeocodingIndexCompute, IReferenceDataIndex, IReferenceDataIndexEdit, 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

	IReferenceDataIndexProxy()
	IReferenceDataIndexProxy(Object obj)
protected	IReferenceDataIndexProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
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

IReferenceDataIndexProxy

public IReferenceDataIndexProxy()

IReferenceDataIndexProxy

public IReferenceDataIndexProxy(Object obj)
                         throws IOException

Throws:

IOException

IReferenceDataIndexProxy

protected IReferenceDataIndexProxy(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 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.