com.esri.arcgis.geodatabase
Interface IFeatureCursor

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITemporalCursor

All Known Implementing Classes:

FeatureCursor, IFeatureCursorProxy, ITemporalCursorProxy, RelQueryCursor, TemporalCursor

public interface IFeatureCursor
extends Serializable

Provides access to members that hand out enumerated features, field collections and allows for the updating, deleting and inserting of features.

Remarks

The IFeatureCursor interface provides access to a set of features in a feature class. It operates in the same way as ICursor, although it does not inherit from that interface. This saves you from having to use Query-Interface when dealing with features rather than rows.

Feature cursors can be used as an input to IFeatureCursorBuffer, which lets you spatially buffer the features by a distance.

You can also draw the features from a cursor on the display. For more information, see the IFeatureRenderer::Draw method.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Method Summary

void	deleteFeature() Delete the existing Feature in the database corresponding to the current position of the cursor.
int	findField(String name) The index of the field with the specified name.
void	flush() Flush any outstanding buffered writes to the database.
IFields	getFields() The fields Collection for this cursor.
Object	insertFeature(IFeatureBuffer buffer) Insert a new Feature into the database using the property values in the input buffer.
IFeature	nextFeature() Advance the position of the cursor by one and return the Feature object at that position.
void	updateFeature(IFeature object) Update the existing Feature in the database corresponding to the current position of the cursor.

Method Detail

findField

int findField(String name)
              throws IOException,
                     AutomationException

The index of the field with the specified name.

Remarks

If the specified field cannot be found, this method returns a value of -1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws IOException,
                         AutomationException

The fields Collection for this cursor.

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.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextFeature

IFeature nextFeature()
                     throws IOException,
                            AutomationException

Advance the position of the cursor by one and return the Feature object at that position.

Remarks

If you fetch features out of a geodatabase using a cursor (recycling or non recycling), the spatial reference of the feature, as returned by NextFeature, is guaranteed to be in the spatial reference that you specified in the query filter .

No guarantee however is made that the geometry of the feature will continue to remain in this spatial reference. In particular, if you use a non recycling cursor, then the feature you fetch will be shared with other consumers and any one of these may change its spatial reference at any time. It is the developers responsibility to test the spatial reference or the geometry you get from the feature (via IFeature::Shape) if you retrieve the geometry at a later time and rely on its spatial reference being a specified spatial reference.

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.IFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateFeature

void updateFeature(IFeature object)
                   throws IOException,
                          AutomationException

Update the existing Feature in the database corresponding to the current position of the cursor.

Remarks

This method should only be called on update cursors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

object - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteFeature

void deleteFeature()
                   throws IOException,
                          AutomationException

Delete the existing Feature in the database corresponding to the current position of the cursor.

Remarks

The cursor must be initialized to a feature (with the NextFeature() method) before this method can be successfully called.

This should only be called on update cursors. To delete a feature retrieved from a search cursor, call IFeature.Delete on the feature itself.

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.

insertFeature

Object insertFeature(IFeatureBuffer buffer)
                     throws IOException,
                            AutomationException

Insert a new Feature into the database using the property values in the input buffer. The ID of the new Feature is returned.

Remarks

This method should only be called on insert cursors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

buffer - A reference to a com.esri.arcgis.geodatabase.IFeatureBuffer (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flush

void flush()
           throws IOException,
                  AutomationException

Flush any outstanding buffered writes to the database.

Remarks

This method should only be called on insert cursors.

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.