com.esri.arcgis.location
Class LocatorEnumerator

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

public class LocatorEnumerator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEnumLocator, ISupportErrorInfo

An enumeration of locators and locator styles.

Remarks

Use the ILocatorWorkspace::Locators method to get a LocatorEnumerator from a locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILocatorWorkspace2, ILocatorManager2, DatabaseLocatorWorkspace, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, ILocatorWorkspaceName, Serialized Form

Constructor Summary
LocatorEnumerator(Object obj)
          Construct a LocatorEnumerator using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IEnumLocator esri_clone()
          Creates a copy of the enumeration.
 int getCount()
          Number of locators in the enumeration.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 ILocator next()
          Returns the next locator or locator style.
 ILocator previous()
          Returns the previous locator or locator style.
 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

LocatorEnumerator

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

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

Throws:
IOException - if there are interop problems LocatorEnumerator theLocatorEnumerator = (LocatorEnumerator) 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 ILocator next()
              throws IOException,
                     AutomationException
Returns the next locator or locator style.

Description

The Next method returns the next locator in the LocatorEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
next in interface IEnumLocator
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

previous

public ILocator previous()
                  throws IOException,
                         AutomationException
Returns the previous locator or locator style.

Description

The Previous method returns the previous locator in the LocatorEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
previous in interface IEnumLocator
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), ILocator, ESRIFDOAddressLocator, StreetMapAddressLocator, com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.catalogUI.IGxLocator

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the enumeration.

Remarks

The Reset method resets the LocatorEnumerator so that the next call to the Next method returns the first locator in the LocatorEnumerator. The Reset method should always be called on a LocatorEnumerator 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 IEnumLocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IEnumLocator 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 IEnumLocator
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumLocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
Number of locators in the enumeration.

Description

The Count property returns the number of locators in the LocatorEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCount in interface IEnumLocator
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.