com.esri.arcgis.controls
Class ARFeatureCursor

java.lang.Object
  extended by com.esri.arcgis.controls.ARFeatureCursor
All Implemented Interfaces:
IARFeatureCursor, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ARFeatureCursor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARFeatureCursor

ARFeatureCursor object.

Description

Use the ARFeatureCursor object to iterate over the set of ARFeature objects that are returned from the IARLayer::SearchARFeatures and IARMap::SearchARFeatures methods. An ARFeatureCursor allows ARFeature objects to be returned one at a time; this is useful if there are a large number of ARFeature objects.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ARFeatureCursor(Object obj)
          Construct a ARFeatureCursor using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 int hashCode()
          the hashcode for this object
 IARFeature nextARFeature()
          Retrieves the next feature in the enumeration sequence.
 
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

ARFeatureCursor

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

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

Throws:
IOException - if there are interop problems ARFeatureCursor theARFeatureCursor = (ARFeatureCursor) 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

nextARFeature

public IARFeature nextARFeature()
                         throws IOException,
                                AutomationException
Retrieves the next feature in the enumeration sequence.

Description

The NextARFeature method returns the next ARFeature object within the subset. The next ARFeature is created and allocated to the ARFeatureCursor. The ARFeatureCursor is forward only and does not support retrieving ARFeature objects that have already been retrieved, or making multiple passes over the ARFeature’s. If an application needs to make multiple passes over the data, the application needs to re-execute the ArcReaderSearchDef that returned the ARFeatureCursor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
nextARFeature in interface IARFeatureCursor
Returns:
A reference to a com.esri.arcgis.controls.IARFeature
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.