com.esri.arcgis.location
Interface IEnumReferenceDataIndex

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEnumReferenceDataIndexProxy, ReferenceDataIndexEnumerator

public interface IEnumReferenceDataIndex
extends Serializable

Provides access to members for retrieving the geocoding indexes.

When To Use

Use the IEnumReferenceDataIndex interface to retrieve the ReferenceDataIndexes contained by the enumerator.

Product Availability

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

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

Method Summary

int	getCount() The number of geocoding indexes on the reference data table.
IReferenceDataIndex	next() Returns the next geocoding index.
void	reset() Resets the enumeration.

Method Detail

getCount

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.