com.esri.arcgis.location
Class LocatorNameEnumerator

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

All Implemented Interfaces:

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

public class LocatorNameEnumerator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEnumLocatorName, ISupportErrorInfo

An enumeration of Name objects for locators and locator styles.

Remarks

The LocatorNameEnumerator is an enumeration of LocatorName objects. Use the ILocatorWorkspace::LocatorNames method to get an enumeration of LocatorName objects from a locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
IEnumLocatorName	esri_clone() Creates a copy of the enumeration.
int	getCount() Number of Name objects in the enumeration.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
ILocatorName	next() Returns the next Name object.
ILocatorName	previous() Returns the previous Name object.
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

LocatorNameEnumerator

public LocatorNameEnumerator(Object obj)
                      throws IOException

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

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

Throws:

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

next

public ILocatorName next()
                  throws IOException,
                         AutomationException

Returns the next Name object.

Description

The Next method returns the next LocatorName object in the LocatorNameEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface IEnumLocatorName

Returns:

A reference to a com.esri.arcgis.geodatabase.ILocatorName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

previous

public ILocatorName previous()
                      throws IOException,
                             AutomationException

Returns the previous Name object.

Description

The Previous method returns the previous LocatorName object in the LocatorNameEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

previous in interface IEnumLocatorName

Returns:

A reference to a com.esri.arcgis.geodatabase.ILocatorName

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.

Remarks

The Reset method resets the LocatorNameEnumerator so that the next call to the Next method returns the first LocatorName object in the LocatorNameEnumerator. The Reset method should always be called on a LocatorNameEnumerator immediately after retrieving it from a locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IEnumLocatorName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IEnumLocatorName esri_clone()
                            throws IOException,
                                   AutomationException

Creates a copy of the enumeration.

Product Availability

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

Specified by:

esri_clone in interface IEnumLocatorName

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumLocatorName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of Name objects in the enumeration.

Description

The Count property returns the number of LocatorName objects in the LocatorNameEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IEnumLocatorName

Returns:

The count

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.