org.apache.derby.iapi.sql.execute
Interface CursorResultSet

All Superinterfaces:
ResultSet
All Known Implementing Classes:
BulkTableScanResultSet, CurrentOfResultSet, DependentResultSet, DistinctGroupedAggregateResultSet, DistinctScalarAggregateResultSet, DistinctScanResultSet, GroupedAggregateResultSet, HashJoinResultSet, HashLeftOuterJoinResultSet, HashScanResultSet, HashTableResultSet, IndexRowToBaseRowResultSet, JoinResultSet, MaterializedResultSet, MergeJoinResultSet, MultiProbeTableScanResultSet, NestedLoopJoinResultSet, NestedLoopLeftOuterJoinResultSet, NormalizeResultSet, ProjectRestrictResultSet, RowCountResultSet, RowResultSet, ScalarAggregateResultSet, ScrollInsensitiveResultSet, SetOpResultSet, SortResultSet, TableScanResultSet, TemporaryRowHolderResultSet, UnionResultSet, VTIResultSet

public interface CursorResultSet
extends ResultSet

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
 
Fields inherited from interface org.apache.derby.iapi.sql.ResultSet
CURRENT_RESULTSET_ONLY, ENTIRE_RESULTSET_TREE, ISAFTERLAST, ISBEFOREFIRST, ISFIRST, ISLAST
 
Method Summary
 ExecRow getCurrentRow()
          Returns the current row of the result set.
 RowLocation getRowLocation()
          Returns the row location of the current base table row of the cursor.
 
Methods inherited from interface org.apache.derby.iapi.sql.ResultSet
checkRowPosition, cleanUp, clearCurrentRow, close, finish, getAbsoluteRow, getActivation, getAutoGeneratedKeysResultset, getBeginExecutionTimestamp, getCursorName, getEndExecutionTimestamp, getExecuteTime, getFirstRow, getLastRow, getNextRow, getPreviousRow, getRelativeRow, getResultDescription, getRowNumber, getSubqueryTrackingArray, getTimeSpent, getWarnings, isClosed, modifiedRowCount, open, returnsRows, setAfterLastRow, setBeforeFirstRow
 

Method Detail

getRowLocation

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:
the row location of the current cursor row.
Throws:
StandardException - thrown on failure to get location from storage engine

getCurrentRow

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:
the last row returned by getNextRow. null if closed.
Throws:
StandardException - thrown on failure.

Built on Thu 2011-03-10 11:54:14+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.