|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICursor
Provides access to members that hand out enumerated rows, field collections and allows for the updating, deleting and inserting of rows.
Cursors are forward only; they do not support backing up and retrieving rows that have already been retrieved or making multiple passes over data. If an application needs to make multiple passes over the data, the application needs to reexecute the query that returned the cursor. If both executions of the query are made within the same edit session (or database transaction with the appropriate level of isolation), the application is guaranteed not to see any changes made to the data by other concurrently executing applications.
Note that while a cursor is created in the client's memory after a call to methods such as ITable.Search or ITable.Insert, the DBMS cursor is not created until a call to NextRow (or a similar method) is made. This is why retrieving the first row may take longer than subsequent rows, and because underlying DBMS errors might be raised on the call, error handling is recommended.
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.
Method Summary | |
---|---|
void |
deleteRow()
Delete the existing Row 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 |
insertRow(IRowBuffer buffer)
Insert a new Row into the database using the property values in the input buffer. |
IRow |
nextRow()
Advance the position of the cursor by one and return the Row object at that position. |
void |
updateRow(IRow row)
Update the existing Row in the database corresponding to the current position of the cursor. |
Method Detail |
---|
int findField(String name) throws IOException, AutomationException
If the specified field cannot be found, this method returns a value of -1.
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFields getFields() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IRow nextRow() throws IOException, AutomationException
The NextRow method on a search or update cursor returns the next row in the result set to the application. The row object returned is allocated and hydrated by the cursor, and a reference to it is handed to the application. To retrieve all rows in a result set containing N rows, the application must make N calls to NextRow. If no rows remain in the result set, this method returns a null value.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void updateRow(IRow row) throws IOException, AutomationException
This method should only be called on update cursors.
row
- A reference to a com.esri.arcgis.geodatabase.IRow (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void deleteRow() throws IOException, AutomationException
The cursor must be initialized to a row (with the NextRow method) before this method can be successfully called.
This should only be called on update cursors. To delete a row retrieved from a search cursor, call IRow.Delete on the row itself.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object insertRow(IRowBuffer buffer) throws IOException, AutomationException
This method should only be called on insert cursors.
buffer
- A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void flush() throws IOException, AutomationException
This method should only be called on insert cursors.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |