com.esri.arcgis.controls
Class IEngineEnumRowProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IEngineEnumRowProxy

All Implemented Interfaces:

IEngineEnumRow, Externalizable, Serializable

public class IEngineEnumRowProxy
extends com.esri.arcgis.interop.Dispatch
implements IEngineEnumRow, Serializable

Provides access to members that enumerate rows in sequence.

Description

This interface is new at ArcGIS 9.3.

Use the IEngineEnumRow enumeration object when you need to maintain a collection of IRow objects in engine. The collection itself can consist of any object that implements the IRow interface. For example, the Feature coclass implements the IRow interface so you can use the IEngineEnumRow object to maintain a collection of features.

The enumeration provides methods to cycle through it:

Use the Count method to identify how many objects exist within the collection.

Use the Next method to retrieve the next object in the enumeration.

Use the Reset method to reset the enumeration to the first object in the collection.

Product Availability

Available with ArcGIS Engine.

See Also:

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getCount() The number of rows.
IRow	next() Retrieves the next row in the sequence.
void	removeListener(String iidStr, Object theListener)
void	reset() Resets the enumeration sequence to the beginning.

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

IEngineEnumRowProxy

public IEngineEnumRowProxy()

IEngineEnumRowProxy

public IEngineEnumRowProxy(Object obj)
                    throws IOException

Throws:

IOException

IEngineEnumRowProxy

protected IEngineEnumRowProxy(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

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of rows.

Description

The property lists the total number of IRow objects in the enumeration.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCount in interface IEngineEnumRow

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public IRow next()
          throws IOException,
                 AutomationException

Retrieves the next row in the sequence.

Description

This method retreives the next IRow object in the enumeration. If the enumeration has been reset, the Next method will return the first row in the enumeration. If the enumeration is at the end of its collection, the Next method will return a NULL object.

Product Availability

Available with ArcGIS Engine.

Specified by:

next in interface IEngineEnumRow

Returns:

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

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 sequence to the beginning.

Description

This method will reset the enumeration so that the Next method will retreive the first IRow object in the collection. Use the Reset method if you need to recycle the enumeration.

Product Availability

Available with ArcGIS Engine.

Specified by:

reset in interface IEngineEnumRow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.