com.esri.arcgis.geodatabase
Interface IEnumLocator

All Superinterfaces:
Serializable
All Known Implementing Classes:
IEnumLocatorProxy, LocatorEnumerator

public interface IEnumLocator
extends Serializable

Provides access to members for retrieving a set of locators.

Remarks

A LocatorEnumerator can be retrieved from a locator workspace using the ILocatorWorkspace::Locators property.

When To Use

Use the IEnumLocator interface to inspect the set of locators contained in a LocatorEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), ILocatorWorkspace2, ILocatorManager2, StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), DatabaseLocatorWorkspace, ILocator, ILocatorWorkspace, ESRIFDOAddressLocator, StreetMapAddressLocator, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, com.esri.arcgis.locationui.LocatorExtension, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, com.esri.arcgis.catalogUI.IGxLocator, ILocatorWorkspaceName

Method Summary
 IEnumLocator esri_clone()
          Creates a copy of the enumeration.
 int getCount()
          Number of locators in the enumeration.
 ILocator next()
          Returns the next locator or locator style.
 ILocator previous()
          Returns the previous locator or locator style.
 void reset()
          Resets the enumeration.
 

Method Detail

next

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

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

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

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

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

IEnumLocator esri_clone()
                        throws IOException,
                               AutomationException
Creates a copy of the enumeration.

Product Availability

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

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

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

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.