com.esri.arcgis.geodatabase
Class IEnumLocatorProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IEnumLocatorProxy

All Implemented Interfaces:

IEnumLocator, Externalizable, Serializable

public class IEnumLocatorProxy
extends com.esri.arcgis.interop.Dispatch
implements IEnumLocator, 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.

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, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IEnumLocatorProxy()
	IEnumLocatorProxy(Object obj)
protected	IEnumLocatorProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	reset() Resets the enumeration.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IEnumLocatorProxy

public IEnumLocatorProxy()

IEnumLocatorProxy

public IEnumLocatorProxy(Object obj)
                  throws IOException

Throws:

IOException

IEnumLocatorProxy

protected IEnumLocatorProxy(Object obj,
                            String iid)
                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.