Class BasicNoPutResultSetImpl
- All Implemented Interfaces:
NoPutResultSet
,ResultSet
,RowLocationRetRowSource
,RowSource
- Direct Known Subclasses:
NoPutResultSetImpl
This abstract class does not define the entire ResultSet interface, but leaves the 'get' half of the interface for subtypes to implement. It is package-visible only, with its methods being public for exposure by its subtypes.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Activation
private int[]
long
long
(package private) ExecRow
long
protected ExecRow
protected long
protected boolean
protected boolean
protected boolean
long
int
long
double
double
(package private) ResultDescription
int
int
protected long
private StatementContext
private final boolean
private TransactionController
private SQLWarning
Fields inherited from interface org.apache.derby.iapi.sql.execute.NoPutResultSet
ABSOLUTE, FIRST, LAST, NEXT, PREVIOUS, RELATIVE, TEMPORARY_RESULT_SET_NUMBER
Fields inherited from interface org.apache.derby.iapi.sql.ResultSet
CURRENT_RESULTSET_ONLY, ENTIRE_RESULTSET_TREE, ISAFTERLAST, ISBEFOREFIRST, ISFIRST, ISLAST
-
Constructor Summary
ConstructorsConstructorDescriptionBasicNoPutResultSetImpl
(ResultDescription resultDescription, Activation activation, double optimizerEstimatedRowCount, double optimizerEstimatedCost) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionfinal void
Add a warning to this result set.protected void
Attach this result set to the top statement context on the stack.void
Checks whether the currently executing statement has been cancelled.boolean
checkRowPosition
(int isType) Determine if the cursor is before the first row in the result set.static Element
childrenToXML
(Element outerNode, ResultSet outerRS) Pretty-print the inner ResultSet fields inside an outer ResultSet.void
cleanUp()
Clean up on errorprotected final String
dumpTimeStats
(String indent, String subIndent) Dump out the time information for run time stats.private static void
findResultSetFields
(ArrayList<Field> fieldList, Class<?> klass) Find all fields of type ResultSet.void
finish()
Tells the system that there will be no more access to any database information via this result set; in particular, no more calls to open().protected final void
getAbsoluteRow
(int row) Returns the row at the absolute position from the query, and returns NULL when there is no such position.final Activation
ResultSet for rows inserted into the table (contains auto-generated keys columns only)Get the Timestamp for the beginning of execution.protected ExecRow
getCompactRow
(ExecRow candidate, FormatableBitSet accessedCols, boolean isKeyed) Get a compacted version of the candidate row according to the columns specified in the bit map.protected final long
Return the current time in milliseconds, if DEBUG and RunTimeStats is on, else return 0.protected final long
getElapsedMillis
(long beginTime) Return the elapsed time in milliseconds, between now and the beginTime, if DEBUG and RunTimeStats is on, else return 0.Get the Timestamp for the end of execution.double
Get the estimated row count from this result set.long
Get the execution time in milliseconds.(package private) final ExecutionFactory
Get a execution factoryReturns the first row from the query, and returns NULL when there are no rows.protected final LanguageConnectionContext
Cache the language connection context.Returns the last row from the query, and returns NULL when there are no rows.final ExecRow
Return the requested values computed from the next row (if any) for which the restriction evaluates to true.abstract ExecRow
Return the requested values computed from the next row (if any) for which the restriction evaluates to true.int
Return the point of attachment for this subquery.Returns the previous row from the query, and returns NULL when there are no more previous rows.getRelativeRow
(int row) Returns the row at the relative position from the current cursor position, and returns NULL when there is no such position.Returns the description of the table's rowsint
Returns the row number of the current row.int
Return the isolation level of the scan in the result set.final NoPutResultSet[]
getSubqueryTrackingArray
(int numSubqueries) Get the subquery ResultSet tracking array from the top ResultSet.(package private) final TransactionController
Get the current transaction controller.final SQLWarning
Return the set of warnings generated during the execution of this result set.boolean
isClosed()
Report if closed.boolean
Is this ResultSet or it's source result set for update This method will be overriden in the inherited Classes if it is trueprotected final boolean
void
Mark the ResultSet as the topmost one in the ResultSet tree.final long
Returns the number of rows affected by the statement.final void
open()
open a scan on the table. scan parameters are evaluated at each open, so there is probably some way of altering their values...protected final void
Allow sub-classes to record the total time spent in their constructor time.void
This is the default implementation of reopenCore().boolean
Do we need to relock the row when going to the heap.int
Get the number of this ResultSet, which is guaranteed to be unique within a statement.boolean
Returns true.Sets the current position to after the last row and returns NULL because there is no current row.Sets the current position to before the first row and returns NULL because there is no current row.protected ExecRow
setCompactRow
(ExecRow candidateRow, ExecRow compactRow) Copy columns from the candidate row from the store to the given compact row.protected final void
setCompatRow
(ExecRow compactRow, DataValueDescriptor[] sourceRow) private static String
stripPackage
(String className) Strip the package location from a class nameProduce an xml image of this ResultSet and its descendant ResultSets.static Element
Pretty-print a ResultSet as an xml child of a parent node.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.derby.iapi.sql.execute.NoPutResultSet
markRowAsDeleted, openCore, positionScanAtRowLocation, setCurrentRow, setHasDeferrableChecks, setNeedsRowLocation, setTargetResultSet, updateRow
Methods inherited from interface org.apache.derby.iapi.sql.ResultSet
clearCurrentRow, close, getCursorName, getTimeSpent
Methods inherited from interface org.apache.derby.iapi.store.access.RowLocationRetRowSource
needsRowLocation, needsRowLocationForDeferredCheckConstraints, offendingRowLocation, rowLocation
Methods inherited from interface org.apache.derby.iapi.store.access.RowSource
closeRowSource, getNextRowFromRowSource, getValidColumns, needsToClone
-
Field Details
-
isOpen
protected boolean isOpen -
finished
protected boolean finished -
currentRow
-
isTopResultSet
protected boolean isTopResultSet -
warnings
-
numOpens
public int numOpens -
rowsSeen
public int rowsSeen -
rowsFiltered
public int rowsFiltered -
startExecutionTime
protected long startExecutionTime -
endExecutionTime
protected long endExecutionTime -
beginTime
public long beginTime -
constructorTime
public long constructorTime -
openTime
public long openTime -
nextTime
public long nextTime -
closeTime
public long closeTime -
optimizerEstimatedRowCount
public double optimizerEstimatedRowCount -
optimizerEstimatedCost
public double optimizerEstimatedCost -
statementContext
-
subqueryTrackingArray
-
compactRow
ExecRow compactRow -
activation
-
statisticsTimingOn
private final boolean statisticsTimingOn -
resultDescription
ResultDescription resultDescription -
tc
-
baseColumnMap
private int[] baseColumnMap
-
-
Constructor Details
-
BasicNoPutResultSetImpl
BasicNoPutResultSetImpl(ResultDescription resultDescription, Activation activation, double optimizerEstimatedRowCount, double optimizerEstimatedCost) Constructor.
Sets beginTime for all children to use to measue constructor time.- Parameters:
resultDescription
- the result description. May be null.activation
- The activationoptimizerEstimatedRowCount
- The optimizer's estimate of the total number of rows for this result setoptimizerEstimatedCost
- The optimizer's estimated cost for this result set
-
-
Method Details
-
recordConstructorTime
protected final void recordConstructorTime()Allow sub-classes to record the total time spent in their constructor time. -
getActivation
- Specified by:
getActivation
in interfaceResultSet
-
isXplainOnlyMode
protected final boolean isXplainOnlyMode() -
reopenCore
This is the default implementation of reopenCore(). It simply does a close() followed by an open(). If there are optimizations to be made (caching, etc), this is a good place to do it -- this will be overridden by a number of resultSet imlementations. and SHOULD be overridden by any node that can get between a base table and a join.- Specified by:
reopenCore
in interfaceNoPutResultSet
- Throws:
StandardException
- thrown if cursor finished.- See Also:
-
getNextRowCore
Description copied from interface:NoPutResultSet
Return the requested values computed from the next row (if any) for which the restriction evaluates to true.restriction and projection parameters are evaluated for each row.
- Specified by:
getNextRowCore
in interfaceNoPutResultSet
- Returns:
- the next row in the result
- Throws:
StandardException
- thrown if cursor finished.- See Also:
-
getPointOfAttachment
public int getPointOfAttachment()Description copied from interface:NoPutResultSet
Return the point of attachment for this subquery. (Only meaningful for Any and Once ResultSets, which can and will only be at the top of a ResultSet for a subquery.)- Specified by:
getPointOfAttachment
in interfaceNoPutResultSet
- Returns:
- int Point of attachment (result set number) for this subquery. (-1 if not a subquery - also Sanity violation)
- See Also:
-
markAsTopResultSet
public void markAsTopResultSet()Mark the ResultSet as the topmost one in the ResultSet tree. Useful for closing down the ResultSet on an error.- Specified by:
markAsTopResultSet
in interfaceNoPutResultSet
-
getScanIsolationLevel
public int getScanIsolationLevel()Description copied from interface:NoPutResultSet
Return the isolation level of the scan in the result set. Only expected to be called for those ResultSets that contain a scan.- Specified by:
getScanIsolationLevel
in interfaceNoPutResultSet
- Returns:
- The isolation level of the scan (in TransactionController constants).
- See Also:
-
getEstimatedRowCount
public double getEstimatedRowCount()Description copied from interface:NoPutResultSet
Get the estimated row count from this result set.- Specified by:
getEstimatedRowCount
in interfaceNoPutResultSet
- Returns:
- The estimated row count (as a double) from this result set.
- See Also:
-
requiresRelocking
public boolean requiresRelocking()Description copied from interface:NoPutResultSet
Do we need to relock the row when going to the heap.- Specified by:
requiresRelocking
in interfaceNoPutResultSet
- Returns:
- Whether or not we need to relock the row when going to the heap.
- See Also:
-
open
open a scan on the table. scan parameters are evaluated at each open, so there is probably some way of altering their values... NOTE: This method should only be called on the top ResultSet of a ResultSet tree to ensure that the entire ResultSet tree gets closed down on an error. the openCore() method will be called for all other ResultSets in the tree.- Specified by:
open
in interfaceResultSet
- Throws:
StandardException
- thrown if cursor finished.
-
getAbsoluteRow
Returns the row at the absolute position from the query, and returns NULL when there is no such position. (Negative position means from the end of the result set.) Moving the cursor to an invalid position leaves the cursor positioned either before the first row (negative position) or after the last row (positive position). NOTE: An exception will be thrown on 0.- Specified by:
getAbsoluteRow
in interfaceResultSet
- Parameters:
row
- The position.- Returns:
- The row at the absolute position, or NULL if no such position.
- Throws:
StandardException
- Thrown on failure- See Also:
-
getRelativeRow
Returns the row at the relative position from the current cursor position, and returns NULL when there is no such position. (Negative position means toward the beginning of the result set.) Moving the cursor to an invalid position leaves the cursor positioned either before the first row (negative position) or after the last row (positive position). NOTE: 0 is valid. NOTE: An exception is thrown if the cursor is not currently positioned on a row.- Specified by:
getRelativeRow
in interfaceResultSet
- Parameters:
row
- The position.- Returns:
- The row at the relative position, or NULL if no such position.
- Throws:
StandardException
- Thrown on failure- See Also:
-
setBeforeFirstRow
Sets the current position to before the first row and returns NULL because there is no current row.- Specified by:
setBeforeFirstRow
in interfaceResultSet
- Returns:
- NULL.
- Throws:
StandardException
- Thrown on failure- See Also:
-
checkRowPosition
Determine if the cursor is before the first row in the result set.- Specified by:
checkRowPosition
in interfaceResultSet
- Returns:
- true if before the first row, false otherwise. Returns false when the result set contains no rows.
- Throws:
StandardException
- Thrown on error.
-
getRowNumber
public int getRowNumber()Returns the row number of the current row. Row numbers start from 1 and go to 'n'. Corresponds to row numbering used to position current row in the result set (as per JDBC).- Specified by:
getRowNumber
in interfaceResultSet
- Returns:
- the row number, or 0 if not on a row
-
getFirstRow
Returns the first row from the query, and returns NULL when there are no rows.- Specified by:
getFirstRow
in interfaceResultSet
- Returns:
- The first row, or NULL if no rows.
- Throws:
StandardException
- Thrown on failure- See Also:
-
getNextRow
Return the requested values computed from the next row (if any) for which the restriction evaluates to true.restriction and projection parameters are evaluated for each row. NOTE: This method should only be called on the top ResultSet of a ResultSet tree to ensure that the entire ResultSet tree gets closed down on an error. the getNextRowCore() method will be called for all other ResultSets in the tree.
- Specified by:
getNextRow
in interfaceResultSet
- Returns:
- the next row in the result
- Throws:
StandardException
- thrown on failure.StandardException
- ResultSetNotOpen thrown if not yet open.- See Also:
-
getPreviousRow
Returns the previous row from the query, and returns NULL when there are no more previous rows.- Specified by:
getPreviousRow
in interfaceResultSet
- Returns:
- The previous row, or NULL if no more previous rows.
- Throws:
StandardException
- Thrown on failure- See Also:
-
getLastRow
Returns the last row from the query, and returns NULL when there are no rows.- Specified by:
getLastRow
in interfaceResultSet
- Returns:
- The last row, or NULL if no rows.
- Throws:
StandardException
- Thrown on failure- See Also:
-
setAfterLastRow
Sets the current position to after the last row and returns NULL because there is no current row.- Specified by:
setAfterLastRow
in interfaceResultSet
- Returns:
- NULL.
- Throws:
StandardException
- Thrown on failure- See Also:
-
returnsRows
public boolean returnsRows()Returns true.- Specified by:
returnsRows
in interfaceResultSet
- Returns:
- TRUE if the statement returns rows, FALSE if not.
-
modifiedRowCount
public final long modifiedRowCount()Description copied from interface:ResultSet
Returns the number of rows affected by the statement. Only valid of returnsRows() returns false. For other DML statements, it returns the number of rows modified by the statement. For statements that do not affect rows (like DDL statements), it returns zero.- Specified by:
modifiedRowCount
in interfaceResultSet
- Returns:
- The number of rows affect by the statement, so far.
-
cleanUp
Clean up on error- Specified by:
cleanUp
in interfaceResultSet
- Throws:
StandardException
- Thrown on failure
-
isClosed
public boolean isClosed()Report if closed. -
finish
Description copied from interface:ResultSet
Tells the system that there will be no more access to any database information via this result set; in particular, no more calls to open(). Will close the result set if it is not already closed.- Specified by:
finish
in interfaceResultSet
- Throws:
StandardException
- on error
-
finishAndRTS
- Throws:
StandardException
- on error
-
getResultDescription
Returns the description of the table's rows- Specified by:
getResultDescription
in interfaceResultSet
- Returns:
- A ResultDescription describing the results of the statement.
-
getExecuteTime
public long getExecuteTime()Get the execution time in milliseconds.- Specified by:
getExecuteTime
in interfaceResultSet
- Returns:
- long The execution time in milliseconds.
-
getBeginExecutionTimestamp
Get the Timestamp for the beginning of execution.- Specified by:
getBeginExecutionTimestamp
in interfaceResultSet
- Returns:
- Timestamp The Timestamp for the beginning of execution.
-
getEndExecutionTimestamp
Get the Timestamp for the end of execution.- Specified by:
getEndExecutionTimestamp
in interfaceResultSet
- Returns:
- Timestamp The Timestamp for the end of execution.
-
getSubqueryTrackingArray
Description copied from interface:ResultSet
Get the subquery ResultSet tracking array from the top ResultSet. (Used for tracking open subqueries when closing down on an error.)- Specified by:
getSubqueryTrackingArray
in interfaceResultSet
- Parameters:
numSubqueries
- The size of the array (For allocation on demand.)- Returns:
- NoPutResultSet[] Array of NoPutResultSets for subqueries.
- See Also:
-
getCurrentTimeMillis
protected final long getCurrentTimeMillis()Return the current time in milliseconds, if DEBUG and RunTimeStats is on, else return 0. (Only pay price of system call if need to.)- Returns:
- long Current time in milliseconds.
-
getAutoGeneratedKeysResultset
Description copied from interface:ResultSet
ResultSet for rows inserted into the table (contains auto-generated keys columns only)- Specified by:
getAutoGeneratedKeysResultset
in interfaceResultSet
- Returns:
- NoPutResultSet NoPutResultSets for rows inserted into the table.
- See Also:
-
getElapsedMillis
protected final long getElapsedMillis(long beginTime) Return the elapsed time in milliseconds, between now and the beginTime, if DEBUG and RunTimeStats is on, else return 0. (Only pay price of system call if need to.)- Returns:
- long Elapsed time in milliseconds.
-
dumpTimeStats
Dump out the time information for run time stats.- Returns:
- Nothing.
-
attachStatementContext
Attach this result set to the top statement context on the stack. Result sets can be directly read from the JDBC layer. The JDBC layer will push and pop a statement context around each ResultSet.getNext(). There's no guarantee that the statement context used for the last getNext() will be the context used for the current getNext(). The last statement context may have been popped off the stack and so will not be available for cleanup if an error occurs. To make sure that we will be cleaned up, we always attach ourselves to the top context. The fun and games occur in nested contexts: using JDBC result sets inside user code that is itself invoked from queries or CALL statements.- Throws:
StandardException
- thrown if cursor finished.
-
getLanguageConnectionContext
Cache the language connection context. Return it.- Returns:
- the language connection context
-
resultSetNumber
public int resultSetNumber()Description copied from interface:NoPutResultSet
Get the number of this ResultSet, which is guaranteed to be unique within a statement.- Specified by:
resultSetNumber
in interfaceNoPutResultSet
- See Also:
-
getExecutionFactory
Get a execution factory- Returns:
- the execution factory
-
getTransactionController
Get the current transaction controller. -
getCompactRow
protected ExecRow getCompactRow(ExecRow candidate, FormatableBitSet accessedCols, boolean isKeyed) throws StandardException Get a compacted version of the candidate row according to the columns specified in the bit map. Share the holders between rows. If there is no bit map, use the candidate row as the compact row. Also, create an array of ints mapping base column positions to compact column positions, to make it cheaper to copy columns to the compact row, if we ever have to do it again.- Parameters:
candidate
- The row to get the columns fromaccessedCols
- A bit map of the columns that are accessed in the candidate rowisKeyed
- Tells whether to return a ValueRow or an IndexRow- Returns:
- A compact row.
- Throws:
StandardException
-
setCompactRow
Copy columns from the candidate row from the store to the given compact row. If there is no column map, just use the candidate row. This method assumes the above method (getCompactRow()) was called first. getCompactRow() sets up the baseColumnMap.- Parameters:
candidateRow
- The candidate row from the storecompactRow
- The compact row to fill in- Returns:
- The compact row to use
-
setCompatRow
-
isForUpdate
public boolean isForUpdate()Is this ResultSet or it's source result set for update This method will be overriden in the inherited Classes if it is true- Specified by:
isForUpdate
in interfaceNoPutResultSet
- Returns:
- Whether or not the result set is for update.
-
checkCancellationFlag
Checks whether the currently executing statement has been cancelled. This is done by checking the statement's allocated StatementContext object.- Throws:
StandardException
- See Also:
-
addWarning
Description copied from interface:ResultSet
Add a warning to this result set.- Specified by:
addWarning
in interfaceResultSet
- Parameters:
w
- the warning to add
-
getWarnings
Description copied from interface:ResultSet
Return the set of warnings generated during the execution of this result set. The warnings are cleared once this call returns.- Specified by:
getWarnings
in interfaceResultSet
-
toXML
Description copied from interface:ResultSet
Produce an xml image of this ResultSet and its descendant ResultSets. Appends an element to the parentNode and returns the appended element.
-
toXML
Pretty-print a ResultSet as an xml child of a parent node. Return the node representing the ResultSet child.
- Throws:
Exception
-
stripPackage
Strip the package location from a class name -
childrenToXML
Pretty-print the inner ResultSet fields inside an outer ResultSet. Returns the outerNode.
- Throws:
Exception
-
findResultSetFields
private static void findResultSetFields(ArrayList<Field> fieldList, Class<?> klass) throws Exception Find all fields of type ResultSet.
- Throws:
Exception
-