com.esri.arcgis.location
Class ReferenceDataIndexEnumerator

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IEnumReferenceDataIndex, ISupportErrorInfo, Serializable

public class ReferenceDataIndexEnumerator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEnumReferenceDataIndex, ISupportErrorInfo

An enumeration of reference data indexes for a reference data table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

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

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getCount() The number of geocoding indexes on the reference data table.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
IReferenceDataIndex	next() Returns the next geocoding index.
void	reset() Resets the enumeration.

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

ReferenceDataIndexEnumerator

public ReferenceDataIndexEnumerator(Object obj)
                             throws IOException

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

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

Throws:

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

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of geocoding indexes on the reference data table.

Description

The Count property returns the number of ReferenceDataIndexes contained by the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IEnumReferenceDataIndex

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public IReferenceDataIndex next()
                         throws IOException,
                                AutomationException

Returns the next geocoding index.

Description

Returns the next ReferenceDataIndex from the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface IEnumReferenceDataIndex

Returns:

A reference to a com.esri.arcgis.location.IReferenceDataIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the enumeration.

Description

The Reset method resets the ReferenceDataIndexEnumerator so that the Next method returns the first ReferenceDataIndex from the enumerator.

Remarks

You should use this method immediately after obtaining the ReferenceDataIndexEnumerator from the locator. You need to use this method before querying the Count property or calling the Next method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IEnumReferenceDataIndex

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.