Top Description Fields Methods
org.apache.derby.iapi.sql.execute

public Interface CursorResultSet

extends ResultSet
Known Direct Implementers
org.apache.derby.impl.sql.execute.BulkTableScanResultSet, org.apache.derby.impl.sql.execute.DependentResultSet, org.apache.derby.impl.sql.execute.CurrentOfResultSet, org.apache.derby.impl.sql.execute.MaterializedResultSet, org.apache.derby.impl.sql.execute.ScrollInsensitiveResultSet, org.apache.derby.impl.sql.execute.TemporaryRowHolderResultSet, org.apache.derby.impl.sql.execute.GroupedAggregateResultSet, org.apache.derby.impl.sql.execute.HashScanResultSet, org.apache.derby.impl.sql.execute.HashTableResultSet, org.apache.derby.impl.sql.execute.IndexRowToBaseRowResultSet, org.apache.derby.impl.sql.execute.JoinResultSet, org.apache.derby.impl.sql.execute.MultiProbeTableScanResultSet, org.apache.derby.impl.sql.execute.NormalizeResultSet, org.apache.derby.impl.sql.execute.ProjectRestrictResultSet, org.apache.derby.impl.sql.execute.RowCountResultSet, org.apache.derby.impl.sql.execute.RowResultSet, org.apache.derby.impl.sql.execute.ScalarAggregateResultSet, org.apache.derby.impl.sql.execute.SetOpResultSet, org.apache.derby.impl.sql.execute.SortResultSet, org.apache.derby.impl.sql.execute.TableScanResultSet, org.apache.derby.impl.sql.execute.UnionResultSet, org.apache.derby.impl.sql.execute.ValidateCheckConstraintResultSet, org.apache.derby.impl.sql.execute.VTIResultSet
Imports
org.apache.derby.iapi.sql.ResultSet, org.apache.derby.iapi.types.RowLocation, org.apache.derby.shared.common.error.StandardException

The CursorResultSet interface is used to provide additional operations on result sets that can be used in cursors.

Since the ResulSet operations must also be supported by cursor result sets, we extend that interface here as well.

Field Summary

Inherited from org.apache.derby.iapi.sql.ResultSet:
CURRENT_RESULTSET_ONLYENTIRE_RESULTSET_TREEISAFTERLASTISBEFOREFIRSTISFIRSTISLAST

Method Summary

Modifier and TypeMethod and Description
public ExecRow

Returns:

the last row returned by getNextRow. null if closed.
getCurrentRow
()

Returns the current row of the result set.

public RowLocation

Returns:

the row location of the current cursor row.
getRowLocation
()

Returns the row location of the current base table row of the cursor.

Inherited from org.apache.derby.iapi.sql.ResultSet:
addWarningcheckRowPositioncleanUpclearCurrentRowclosefinishgetAbsoluteRowgetActivationgetAutoGeneratedKeysResultsetgetBeginExecutionTimestampgetCursorNamegetEndExecutionTimestampgetExecuteTimegetFirstRowgetLastRowgetNextRowgetPreviousRowgetRelativeRowgetResultDescriptiongetRowNumbergetSubqueryTrackingArraygetTimeSpentgetWarningsisClosedmodifiedRowCountopenreturnsRowssetAfterLastRowsetBeforeFirstRowtoXML

Method Detail

getCurrentRowback to summary
public ExecRow getCurrentRow() throws StandardException

Returns the current row of the result set. REMIND: eventually, this will only return the current row for result sets that need to return it; either some field in the activation or a parameter in the constructor will be used to signal that this needs to function. This will let us limit the number of live objects we are holding on to.

Returns:ExecRow

the last row returned by getNextRow. null if closed.

Exceptions
StandardException:
thrown on failure.
getRowLocationback to summary
public RowLocation getRowLocation() throws StandardException

Returns the row location of the current base table row of the cursor. If this cursor's row is composed of multiple base tables' rows, i.e. due to a join, then a null is returned.

Returns:RowLocation

the row location of the current cursor row.

Exceptions
StandardException:
thrown on failure to get location from storage engine