com.esri.arcgis.location
Class ReferenceDataTableEnumerator

java.lang.Object
  extended by com.esri.arcgis.location.ReferenceDataTableEnumerator
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IEnumReferenceDataTable, ISupportErrorInfo, Serializable

public class ReferenceDataTableEnumerator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEnumReferenceDataTable, ISupportErrorInfo

An enumeration of reference data tables for the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ReferenceDataIndex, IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, ReferenceDataTableEnumerator, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, ReferenceDataTable, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex, Serialized Form

Constructor Summary
ReferenceDataTableEnumerator(Object obj)
          Construct a ReferenceDataTableEnumerator 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 reference data tables for the locator.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 IReferenceDataTable next()
          Returns the next reference data table.
 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

ReferenceDataTableEnumerator

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

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

Throws:
IOException - if there are interop problems ReferenceDataTableEnumerator theReferenceDataTableEnumerator = (ReferenceDataTableEnumerator) 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 reference data tables for the locator.

Description

The Count property returns the number of ReferenceDataTables 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 IEnumReferenceDataTable
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

public IReferenceDataTable next()
                         throws IOException,
                                AutomationException
Returns the next reference data table.

Description

Returns the next ReferenceDataTable from the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
next in interface IEnumReferenceDataTable
Returns:
A reference to a com.esri.arcgis.location.IReferenceDataTable
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 ReferenceDataTableEnumerator so that the Next method returns the first ReferenceDataTable from the enumerator.

Remarks

You should use this method immediately after obtaining the ReferenceDataTableEnumerator 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 IEnumReferenceDataTable
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.