An implementation must provide a ResultSet.open() method that performs the required action.
ResultSet.returnsRows() returns false and any method that fetches a row will throw an exception.
| Modifier and Type | Field and Description |
|---|---|
| pack-priv final Activation | |
| protected long | |
| protected long | |
| protected long | |
| protected long | |
| private int | |
| private int[] | |
| private boolean | isOpen
True if the result set has been opened, and not yet closed. |
| pack-priv final LanguageConnectionContext | |
| private DataValueDescriptor[] | |
| private final boolean | |
| private NoPutResultSet[] |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public void | addWarning(SQLWarning
the warning to add w)Implements org. Add a warning to this result set. |
| public final boolean | Returns: true if before the first row, false otherwise. Returns false when the result set contains no rows.The desired position type isType)Implements org. Determine if the cursor is before the first row in the result set. |
| public final void | clearCurrentRow()
Implements org. Clear the current row. |
| public void | close(boolean
True if this is part of an action of a MERGE statement. underMerge)Dump the stat if not already done so. |
| public boolean | Returns: Whether or not this ResultSet cause a commit or rollback.Does this ResultSet cause a commit or rollback. |
| public void | evaluateGenerationClauses(GeneratedMethod
the generated method which evaluates generation clauses generationClauses, Activation the thread-specific instance of the generated class activation, NoPutResultSet the tuple stream driving this INSERT/UPDATE source, ExecRow the base row being stuffed newRow, boolean true if this is an UPDATE. false otherwise. isUpdate)Compute the generation clauses on the current row in order to fill in computed columns. |
| public void | finish()
Implements org. 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(). |
| public final ExecRow | Returns: The row at the absolute position, or NULL if no such position.The position. row)Implements org. Returns the row at the absolute position from the query, and returns NULL when there is no such position. |
| public final Activation | |
| public ResultSet | getAutoGeneratedKeysResultset()
Implements org. ResultSet for rows inserted into the table (contains auto-generated keys columns only) |
| public Timestamp | Returns: Timestamp The Timestamp for the beginning of execution.Implements org. Get the Timestamp for the beginning of execution. |
| protected final long | Returns: long Current time in milliseconds.Return the current time in milliseconds, if DEBUG and RunTimeStats is on, else return 0. |
| public String | getCursorName()
Implements org. Return the cursor name, null in this case. |
| public Timestamp | Returns: Timestamp The Timestamp for the end of execution.Implements org. Get the Timestamp for the end of execution. |
| public long | Returns: long The execution time in milliseconds.Implements org. Get the execution time in milliseconds. |
| public final ExecRow | Returns: The first row, or NULL if no rows.Implements org. Returns the first row from the query, and returns NULL when there are no rows. |
| public final ExecRow | Returns: The last row, or NULL if no rows.Implements org. Returns the last row from the query, and returns NULL when there are no rows. |
| public final ExecRow | getNextRow()
Implements org. No rows to return, so throw an exception. |
| public final ExecRow | Returns: The previous row, or NULL if no more previous rows.Implements org. Returns the previous row from the query, and returns NULL when there are no more previous rows. |
| public String | Returns: String The query plan as a String.Indentation level. depth)RESOLVE - This method will go away once it is overloaded in all subclasses. |
| public final ExecRow | Returns: The row at the relative position, or NULL if no such position.The position. row)Implements org. Returns the row at the relative position from the current cursor position, and returns NULL when there is no such position. |
| public ResultDescription | getResultDescription()
Implements org. Returns null. |
| public final int | Returns: the row number, or 0 if not on a rowImplements org. Returns the row number of the current row. |
| public final NoPutResultSet[] | getSubqueryTrackingArray(int
The size of the array (For allocation on demand.) numSubqueries)Implements org. Get the subquery ResultSet tracking array from the top ResultSet. |
| public long | Returns: long The total amount of time spent (in milliseconds).CURRENT_RESULTSET_ONLY - time spent only in this ResultSet
ENTIRE_RESULTSET_TREE - time spent in this ResultSet and below. type)Implements org. Return the total amount of time spent in this ResultSet |
| public SQLWarning | getWarnings()
Implements org. Return the set of warnings generated during the execution of this result set. |
| public boolean | Returns: true if closed, false otherwiseImplements org. Find out if the |
| public long | |
| public final boolean | |
| public final ExecRow | Returns: NULL.Implements org. Sets the current position to after the last row and returns NULL because there is no current row. |
| public final ExecRow | Returns: NULL.Implements org. Sets the current position to before the first row and returns NULL because there is no current row. |
| pack-priv void | |
| private void | setupGeneratedColumns(Activation activation, ValueRow newRow)
Construct support for normalizing generated columns. |
| public Element | toXML(Element
Node to put content into. parentNode, String Element tag for content tag)Implements org. Produce an xml image of this ResultSet and its descendant ResultSets. |
| activation | back to summary |
|---|---|
| pack-priv final Activation activation | |
| beginExecutionTime | back to summary |
|---|---|
| protected long beginExecutionTime | |
| beginTime | back to summary |
|---|---|
| protected long beginTime | |
| endExecutionTime | back to summary |
|---|---|
| protected long endExecutionTime | |
| endTime | back to summary |
|---|---|
| protected long endTime | |
| firstColumn | back to summary |
|---|---|
| private int firstColumn | |
| generatedColumnPositions | back to summary |
|---|---|
| private int[] generatedColumnPositions | |
| isOpen | back to summary |
|---|---|
| private boolean isOpen True if the result set has been opened, and not yet closed. | |
| lcc | back to summary |
|---|---|
| pack-priv final LanguageConnectionContext lcc | |
| normalizedGeneratedValues | back to summary |
|---|---|
| private DataValueDescriptor[] normalizedGeneratedValues | |
| statisticsTimingOn | back to summary |
|---|---|
| private final boolean statisticsTimingOn | |
| subqueryTrackingArray | back to summary |
|---|---|
| private NoPutResultSet[] subqueryTrackingArray | |
| NoRowsResultSetImpl | back to summary |
|---|---|
| pack-priv NoRowsResultSetImpl(Activation activation) | |
| addWarning | back to summary |
|---|---|
| public void addWarning(SQLWarning w) Implements org. Doc from org. Add a warning to this result set.
| |
| checkRowPosition | back to summary |
|---|---|
| public final boolean checkRowPosition(int isType) Implements org. Determine if the cursor is before the first row in the result set.
| |
| clearCurrentRow | back to summary |
|---|---|
| public final void clearCurrentRow() Implements org. Clear the current row. This is done after a commit on holdable result sets. This is a no-op on result set which do not provide rows. | |
| close | back to summary |
|---|---|
| public void close(boolean underMerge) throws StandardException Dump the stat if not already done so. Close all of the open subqueries.
| |
| doesCommit | back to summary |
|---|---|
| public boolean doesCommit() Does this ResultSet cause a commit or rollback.
| |
| evaluateGenerationClauses | back to summary |
|---|---|
| public void evaluateGenerationClauses(GeneratedMethod generationClauses, Activation activation, NoPutResultSet source, ExecRow newRow, boolean isUpdate) throws StandardException Compute the generation clauses on the current row in order to fill in computed columns.
| |
| finish | back to summary |
|---|---|
| public void finish() throws StandardException Implements org. Doc from org. 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.
| |
| getAbsoluteRow | back to summary |
|---|---|
| public final ExecRow getAbsoluteRow(int row) throws StandardException Implements org. 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.
| |
| getActivation | back to summary |
|---|---|
| public final Activation getActivation() Implements org. | |
| getAutoGeneratedKeysResultset | back to summary |
|---|---|
| public ResultSet getAutoGeneratedKeysResultset() Implements org. Doc from org. ResultSet for rows inserted into the table (contains auto-generated keys columns only)
| |
| getBeginExecutionTimestamp | back to summary |
|---|---|
| public Timestamp getBeginExecutionTimestamp() Implements org. Get the Timestamp for the beginning of execution.
| |
| getCurrentTimeMillis | back to summary |
|---|---|
| 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.)
| |
| getCursorName | back to summary |
|---|---|
| public String getCursorName() Implements org. Return the cursor name, null in this case.
| |
| getEndExecutionTimestamp | back to summary |
|---|---|
| public Timestamp getEndExecutionTimestamp() Implements org. Get the Timestamp for the end of execution.
| |
| getExecuteTime | back to summary |
|---|---|
| public long getExecuteTime() Implements org. Get the execution time in milliseconds.
| |
| getFirstRow | back to summary |
|---|---|
| public final ExecRow getFirstRow() throws StandardException Implements org. Returns the first row from the query, and returns NULL when there are no rows.
| |
| getLastRow | back to summary |
|---|---|
| public final ExecRow getLastRow() throws StandardException Implements org. Returns the last row from the query, and returns NULL when there are no rows.
| |
| getNextRow | back to summary |
|---|---|
| public final ExecRow getNextRow() throws StandardException Implements org. No rows to return, so throw an exception.
| |
| getPreviousRow | back to summary |
|---|---|
| public final ExecRow getPreviousRow() throws StandardException Implements org. Returns the previous row from the query, and returns NULL when there are no more previous rows.
| |
| getQueryPlanText | back to summary |
|---|---|
| public String getQueryPlanText(int depth) RESOLVE - This method will go away once it is overloaded in all subclasses. Return the query plan as a String.
| |
| getRelativeRow | back to summary |
|---|---|
| public final ExecRow getRelativeRow(int row) throws StandardException Implements org. 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.
| |
| getResultDescription | back to summary |
|---|---|
| public ResultDescription getResultDescription() Implements org. Returns null.
| |
| getRowNumber | back to summary |
|---|---|
| public final int getRowNumber() Implements org. 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).
| |
| getSubqueryTrackingArray | back to summary |
|---|---|
| public final NoPutResultSet[] getSubqueryTrackingArray(int numSubqueries) Implements org. Doc from org. Get the subquery ResultSet tracking array from the top ResultSet. (Used for tracking open subqueries when closing down on an error.)
| |
| getTimeSpent | back to summary |
|---|---|
| public long getTimeSpent(int type) Implements org. Return the total amount of time spent in this ResultSet
| |
| getWarnings | back to summary |
|---|---|
| public SQLWarning getWarnings() Implements org. Doc from org. Return the set of warnings generated during the execution of this result set. The warnings are cleared once this call returns.
| |
| isClosed | back to summary |
|---|---|
| public boolean isClosed() Implements org. Find out if the
| |
| modifiedRowCount | back to summary |
|---|---|
| public long modifiedRowCount() Implements org. Returns zero.
| |
| returnsRows | back to summary |
|---|---|
| public final boolean returnsRows() Implements org. Returns FALSE
| |
| setAfterLastRow | back to summary |
|---|---|
| public final ExecRow setAfterLastRow() throws StandardException Implements org. Sets the current position to after the last row and returns NULL because there is no current row.
| |
| setBeforeFirstRow | back to summary |
|---|---|
| public final ExecRow setBeforeFirstRow() throws StandardException Implements org. Sets the current position to before the first row and returns NULL because there is no current row.
| |
| setup | back to summary |
|---|---|
| pack-priv void setup() throws StandardException Set up the result set for use. Should always be called from
| |
| setupGeneratedColumns | back to summary |
|---|---|
| private void setupGeneratedColumns(Activation activation, ValueRow newRow) throws StandardException Construct support for normalizing generated columns. This figures out which columns in the target row have generation clauses which need to be run. | |
| toXML | back to summary |
|---|---|
| public Element toXML(Element parentNode, String tag) throws Exception Implements org. Doc from org. Produce an xml image of this ResultSet and its descendant ResultSets. Appends an element to the parentNode and returns the appended element. | |