com.esri.core.geometry
Class GeometryCursor

java.lang.Object
  com.esri.core.geometry.GeometryCursor

Direct Known Subclasses:

GeometryCursorAppend, ListeningGeometryCursor, SimpleGeometryCursor

public abstract class GeometryCursor
extends Object

An abstract Geometry Cursor class.

Constructor Summary

GeometryCursor()

Method Summary

abstract int	getGeometryID() Returns the ID of the current geometry.
abstract Geometry	next() Moves the cursor to the next Geometry.
boolean	tock() Executes a unit of work on the cursor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeometryCursor

public GeometryCursor()

Method Detail

next

public abstract Geometry next()

Moves the cursor to the next Geometry. Returns null when reached the end. The behavior of the cursor is undefined after the method returns null.

getGeometryID

public abstract int getGeometryID()

Returns the ID of the current geometry. The ID is propagated across the operations (when possible). Returns an ID associated with the current Geometry. The ID is passed along and is returned by some operators to preserve relationship between the input and output geometry classes. It is not always possible to preserve an ID during an operation.

tock

public boolean tock()

Executes a unit of work on the cursor.

Returns:

Returns true, if there is a geometry ready to be pulled using next(). This method is to be used together with the tick() method on the ListeningGeometryCursor. Call tock() for each tick() on the ListeningGeometryCursor.