Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.sql.execute.VTIResultSet

Modifier and Type	Field and Description
private final ExecRow	allocatedRow
private final FormatableHashtable	compileTimeConstants
private GeneratedMethod	constructor
private IFastPath	fastPath
private boolean	isDerbyStyleTableFunction
private boolean	isTarget
public String	javaClassName
private boolean	pushedProjection
private Qualifier[][]	pushedQualifiers
private FormatableBitSet	referencedColumns
private DataTypeDescriptor[]	returnColumnTypes
private final TypeDescriptor	returnType
private boolean	reuseablePs
public int	rowsReturned
private boolean[]	runtimeNullableColumn
private int	scanIsolationLevel Specified isolation level of SELECT (scan).
private PreparedStatement	userPS
private ResultSet	userVTI
private boolean	version2
private String	vtiName
private String[]	vtiProjection
private Restriction	vtiRestriction
private String	vtiSchema

Access	Constructor and Description
pack-priv	VTIResultSet(Activation activation, int row, int resultSetNumber, GeneratedMethod constructor, String javaClassName, Qualifier[][] pushedQualifiers, int erdNumber, boolean version2, boolean reuseablePs, int ctcNumber, boolean isTarget, int scanIsolationLevel, double optimizerEstimatedRowCount, double optimizerEstimatedCost, boolean isDerbyStyleTableFunction, int returnTypeNumber, int vtiProjectionNumber, int vtiRestrictionNumber, String vtiSchema, String vtiName)

Method Summary

Modifier and Type	Method and Description
private void	cast(DataTypeDescriptor dtd, DataValueDescriptor dvd) Cast the value coming out of the user-coded ResultSet.
private void	castDecimal(DataTypeDescriptor dtd, DataValueDescriptor dvd) Set the correct precision and scale for a decimal value.
private void	castLongvarbinary(DataTypeDescriptor dtd, DataValueDescriptor dvd) Truncate long varbinary values to the legal maximum.
private void	castLongvarchar(DataTypeDescriptor dtd, DataValueDescriptor dvd) Truncate long varchars to the legal maximum.
private Restriction	cloneRestriction(Activation activation) Clone the restriction for a Restricted VTI, filling in parameter values as necessary.
private Restriction	cloneRestriction(Activation activation, Restriction original)
public void	close() Overrides org.apache.derby.impl.sql.execute.NoPutResultSetImpl.close. Implements org.apache.derby.iapi.sql.ResultSet.close. Tells the system that there will be no more calls to getNextRow() (until the next open() call), so it can free up the resources associated with the ResultSet.
public void	finish() Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.finish. Implements org.apache.derby.iapi.sql.ResultSet.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().
private ExecRow	Returns: The cached ExecRow for this ResultSet getAllocatedRow() Cache the ExecRow for this result set.
public ExecRow	Returns: a null. getCurrentRow() Implements org.apache.derby.iapi.sql.execute.CursorResultSet.getCurrentRow. This is not used in positioned update and delete, so just return a null.
public ExecRow	getNextRowCore() Implements abstract org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.getNextRowCore. Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.getNextRowCore. If open and not returned yet, returns the row after plugging the parameters into the expressions.
public final String	getOriginalSQL() Implements org.apache.derby.vti.VTIEnvironment.getOriginalSQL. Return the SQL text of the original SQL statement.
private int[]	getProjectedColList()
private DataTypeDescriptor[]	getReturnColumnTypes() Get the types of the columns returned by a Derby-style table function.
public RowLocation	Returns: a null. getRowLocation() Implements org.apache.derby.iapi.sql.execute.CursorResultSet.getRowLocation. This is not operating against a stored table, so it has no row location to report.
public final int	getScanIsolationLevel() Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.getScanIsolationLevel. Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.getScanIsolationLevel. Return the isolation level of the scan in the result set.
public Object	getSharedState(String Key into a cache of context variables key) Implements org.apache.derby.vti.VTIEnvironment.getSharedState. Get an object associated with a key from set of objects maintained with the statement plan.
public final int	getStatementIsolationLevel() Implements org.apache.derby.vti.VTIEnvironment.getStatementIsolationLevel. Get the specific JDBC isolation of the statement.
public long	Returns: long The total amount of time spent (in milliseconds). getTimeSpent(int CURRENT_RESULTSET_ONLY - time spent only in this ResultSet ENTIRE_RESULTSET_TREE - time spent in this ResultSet and below. type) Implements org.apache.derby.iapi.sql.ResultSet.getTimeSpent. Return the total amount of time spent in this ResultSet
pack-priv GeneratedMethod	Returns: The GeneratedMethod for instantiating the VTI. getVTIConstructor() Return the GeneratedMethod for instantiating the VTI.
public final boolean	isCompileTime() Implements org.apache.derby.vti.VTIEnvironment.isCompileTime. Return true if this instance of the Table Function has been created for compilation, false if it is for runtime execution.
pack-priv boolean	isReuseablePs()
public void	openCore() Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.openCore. Sets state to 'open'.
public void	populateFromResultSet(ExecRow row)
public void	reopenCore() Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.reopenCore. Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.reopenCore. If the VTI is a version2 vti that does not need to be instantiated multiple times then we simply close the current ResultSet and create a new one via a call to PreparedStatement.executeQuery().
private boolean[]	setNullableColumnList()
public final void	setSharedState(String Key into a cache of context variables key, Serializable Value to associate with the key value) Implements org.apache.derby.vti.VTIEnvironment.setSharedState. Saves an object associated with a key that will be maintained for the lifetime of the statement plan.
public Element	toXML(Element Node to put content into. parentNode, String Element tag for content tag) Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.toXML. Implements org.apache.derby.iapi.sql.ResultSet.toXML. Produce an xml image of this ResultSet and its descendant ResultSets.

allocatedRow	back to summary
private final ExecRow allocatedRow

compileTimeConstants	back to summary
private final FormatableHashtable compileTimeConstants

constructor	back to summary
private GeneratedMethod constructor

fastPath	back to summary
private IFastPath fastPath

isDerbyStyleTableFunction	back to summary
private boolean isDerbyStyleTableFunction

isTarget	back to summary
private boolean isTarget

javaClassName	back to summary
public String javaClassName

pushedProjection	back to summary
private boolean pushedProjection

pushedQualifiers	back to summary
private Qualifier[][] pushedQualifiers

referencedColumns	back to summary
private FormatableBitSet referencedColumns

returnColumnTypes	back to summary
private DataTypeDescriptor[] returnColumnTypes

returnType	back to summary
private final TypeDescriptor returnType

reuseablePs	back to summary
private boolean reuseablePs

rowsReturned	back to summary
public int rowsReturned

runtimeNullableColumn	back to summary
private boolean[] runtimeNullableColumn

scanIsolationLevel	back to summary
private int scanIsolationLevel Specified isolation level of SELECT (scan). If not set or not application, it will be set to TransactionControl.UNSPECIFIED_ISOLATION_LEVEL

userPS	back to summary
private PreparedStatement userPS

userVTI	back to summary
private ResultSet userVTI

version2	back to summary
private boolean version2

vtiName	back to summary
private String vtiName

vtiProjection	back to summary
private String[] vtiProjection

vtiRestriction	back to summary
private Restriction vtiRestriction

vtiSchema	back to summary
private String vtiSchema

VTIResultSet	back to summary
pack-priv VTIResultSet(Activation activation, int row, int resultSetNumber, GeneratedMethod constructor, String javaClassName, Qualifier[][] pushedQualifiers, int erdNumber, boolean version2, boolean reuseablePs, int ctcNumber, boolean isTarget, int scanIsolationLevel, double optimizerEstimatedRowCount, double optimizerEstimatedCost, boolean isDerbyStyleTableFunction, int returnTypeNumber, int vtiProjectionNumber, int vtiRestrictionNumber, String vtiSchema, String vtiName) throws StandardException

Method Detail

cast	back to summary
private void cast(DataTypeDescriptor dtd, DataValueDescriptor dvd) throws StandardException Cast the value coming out of the user-coded ResultSet. The rules are described in CastNode.getDataValueConversion().

castDecimal	back to summary
private void castDecimal(DataTypeDescriptor dtd, DataValueDescriptor dvd) throws StandardException Set the correct precision and scale for a decimal value.

castLongvarbinary	back to summary
private void castLongvarbinary(DataTypeDescriptor dtd, DataValueDescriptor dvd) throws StandardException Truncate long varbinary values to the legal maximum.

castLongvarchar	back to summary
private void castLongvarchar(DataTypeDescriptor dtd, DataValueDescriptor dvd) throws StandardException Truncate long varchars to the legal maximum.

cloneRestriction	back to summary
private Restriction cloneRestriction(Activation activation) throws StandardException Clone the restriction for a Restricted VTI, filling in parameter values as necessary.

cloneRestriction	back to summary
private Restriction cloneRestriction(Activation activation, Restriction original) throws StandardException

close back to summary

close	back to summary
public void close() throws StandardException Overrides org.apache.derby.impl.sql.execute.NoPutResultSetImpl.close. Implements org.apache.derby.iapi.sql.ResultSet.close. Doc from org.apache.derby.iapi.sql.ResultSet.close. Tells the system that there will be no more calls to getNextRow() (until the next open() call), so it can free up the resources associated with the ResultSet. Exceptions StandardException: thrown on error See Also `org.apache.derby.iapi.sql.ResultSet#close`

public void close() throws StandardException

Overrides org.apache.derby.impl.sql.execute.NoPutResultSetImpl.close.

Implements org.apache.derby.iapi.sql.ResultSet.close.

Doc from org.apache.derby.iapi.sql.ResultSet.close.

Tells the system that there will be no more calls to getNextRow() (until the next open() call), so it can free up the resources associated with the ResultSet.

Exceptions

StandardException:: thrown on error

finish	back to summary
public void finish() throws StandardException Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.finish. Implements org.apache.derby.iapi.sql.ResultSet.finish. Doc from org.apache.derby.iapi.sql.ResultSet.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(). Will close the result set if it is not already closed. Exceptions StandardException: on error

finish

back to summary

public void finish() throws StandardException

Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.finish.

Implements org.apache.derby.iapi.sql.ResultSet.finish.

Doc from org.apache.derby.iapi.sql.ResultSet.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(). Will close the result set if it is not already closed.

Exceptions

StandardException:: on error

getAllocatedRow	back to summary
private ExecRow getAllocatedRow() throws StandardException Cache the ExecRow for this result set. Returns:ExecRow The cached ExecRow for this ResultSet Exceptions StandardException: thrown on failure.

getAllocatedRow

back to summary

private ExecRow getAllocatedRow() throws StandardException

Cache the ExecRow for this result set.

Returns:ExecRow

The cached ExecRow for this ResultSet

Exceptions

StandardException:: thrown on failure.

getCurrentRow back to summary

getCurrentRow	back to summary
public ExecRow getCurrentRow() Implements org.apache.derby.iapi.sql.execute.CursorResultSet.getCurrentRow. This is not used in positioned update and delete, so just return a null. Returns:ExecRow a null. See Also `CursorResultSet`

public ExecRow getCurrentRow()

Implements org.apache.derby.iapi.sql.execute.CursorResultSet.getCurrentRow.

This is not used in positioned update and delete, so just return a null.

Returns:ExecRow: a null.
See Also: CursorResultSet

getNextRowCore	back to summary
public ExecRow getNextRowCore() throws StandardException Implements abstract org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.getNextRowCore. Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.getNextRowCore. If open and not returned yet, returns the row after plugging the parameters into the expressions. Returns:ExecRow Doc from org.apache.derby.iapi.sql.execute.NoPutResultSet.getNextRowCore. the next row in the result Exceptions StandardException: thrown on failure.

getNextRowCore

back to summary

public ExecRow getNextRowCore() throws StandardException

Implements abstract org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.getNextRowCore.

Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.getNextRowCore.

If open and not returned yet, returns the row after plugging the parameters into the expressions.

Returns:ExecRow

Doc from org.apache.derby.iapi.sql.execute.NoPutResultSet.getNextRowCore.

the next row in the result

Exceptions

StandardException:: thrown on failure.

getOriginalSQL	back to summary
public final String getOriginalSQL() Implements org.apache.derby.vti.VTIEnvironment.getOriginalSQL. Doc from org.apache.derby.vti.VTIEnvironment.getOriginalSQL. Return the SQL text of the original SQL statement. Returns:String the SQL text of the original SQL statement

getOriginalSQL

back to summary

public final String getOriginalSQL()

Implements org.apache.derby.vti.VTIEnvironment.getOriginalSQL.

Doc from org.apache.derby.vti.VTIEnvironment.getOriginalSQL.

Return the SQL text of the original SQL statement.

Returns:String: the SQL text of the original SQL statement

getProjectedColList	back to summary
private int[] getProjectedColList()

getReturnColumnTypes	back to summary
private DataTypeDescriptor[] getReturnColumnTypes() throws StandardException Get the types of the columns returned by a Derby-style table function.

getRowLocation back to summary

getRowLocation	back to summary
public RowLocation getRowLocation() Implements org.apache.derby.iapi.sql.execute.CursorResultSet.getRowLocation. This is not operating against a stored table, so it has no row location to report. Returns:RowLocation a null. See Also `CursorResultSet`

public RowLocation getRowLocation()

Implements org.apache.derby.iapi.sql.execute.CursorResultSet.getRowLocation.

This is not operating against a stored table, so it has no row location to report.

Returns:RowLocation: a null.
See Also: CursorResultSet

getScanIsolationLevel	back to summary
public final int getScanIsolationLevel() Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.getScanIsolationLevel. Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.getScanIsolationLevel. Doc from org.apache.derby.iapi.sql.execute.NoPutResultSet.getScanIsolationLevel. Return the isolation level of the scan in the result set. Only expected to be called for those ResultSets that contain a scan. Returns:int The isolation level of the scan (in TransactionController constants).

getScanIsolationLevel

back to summary

public final int getScanIsolationLevel()

Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.getScanIsolationLevel.

Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.getScanIsolationLevel.

Doc from org.apache.derby.iapi.sql.execute.NoPutResultSet.getScanIsolationLevel.

Return the isolation level of the scan in the result set. Only expected to be called for those ResultSets that contain a scan.

Returns:int: The isolation level of the scan (in TransactionController constants).

getSharedState	back to summary
public Object getSharedState(String key) Implements org.apache.derby.vti.VTIEnvironment.getSharedState. Doc from org.apache.derby.vti.VTIEnvironment.getSharedState. Get an object associated with a key from set of objects maintained with the statement plan. Parameters key:String Key into a cache of context variables Returns:Object the value associated with the key

getSharedState

back to summary

public Object getSharedState(String key)

Implements org.apache.derby.vti.VTIEnvironment.getSharedState.

Doc from org.apache.derby.vti.VTIEnvironment.getSharedState.

Get an object associated with a key from set of objects maintained with the statement plan.

Parameters

key:String: Key into a cache of context variables

Returns:Object

the value associated with the key

getStatementIsolationLevel	back to summary
public final int getStatementIsolationLevel() Implements org.apache.derby.vti.VTIEnvironment.getStatementIsolationLevel. Doc from org.apache.derby.vti.VTIEnvironment.getStatementIsolationLevel. Get the specific JDBC isolation of the statement. If it returns Connection.TRANSACTION_NONE then no isolation was specified and the connection's isolation level is implied. Returns:int the specific JDBC isolation of the statement

getStatementIsolationLevel

back to summary

public final int getStatementIsolationLevel()

Implements org.apache.derby.vti.VTIEnvironment.getStatementIsolationLevel.

Doc from org.apache.derby.vti.VTIEnvironment.getStatementIsolationLevel.

Get the specific JDBC isolation of the statement. If it returns Connection.TRANSACTION_NONE then no isolation was specified and the connection's isolation level is implied.

Returns:int: the specific JDBC isolation of the statement

getTimeSpent	back to summary
public long getTimeSpent(int type) Implements org.apache.derby.iapi.sql.ResultSet.getTimeSpent. Return the total amount of time spent in this ResultSet Parameters type:int CURRENT_RESULTSET_ONLY - time spent only in this ResultSet ENTIRE_RESULTSET_TREE - time spent in this ResultSet and below. Returns:long long The total amount of time spent (in milliseconds).

getTimeSpent

back to summary

public long getTimeSpent(int type)

Implements org.apache.derby.iapi.sql.ResultSet.getTimeSpent.

Return the total amount of time spent in this ResultSet

Parameters

type:int: CURRENT_RESULTSET_ONLY - time spent only in this ResultSet ENTIRE_RESULTSET_TREE - time spent in this ResultSet and below.

Returns:long

long The total amount of time spent (in milliseconds).

getVTIConstructor	back to summary
pack-priv GeneratedMethod getVTIConstructor() Return the GeneratedMethod for instantiating the VTI. Returns:GeneratedMethod The GeneratedMethod for instantiating the VTI.

getVTIConstructor

back to summary

pack-priv GeneratedMethod getVTIConstructor()

Return the GeneratedMethod for instantiating the VTI.

Returns:GeneratedMethod: The GeneratedMethod for instantiating the VTI.

isCompileTime	back to summary
public final boolean isCompileTime() Implements org.apache.derby.vti.VTIEnvironment.isCompileTime. Doc from org.apache.derby.vti.VTIEnvironment.isCompileTime. Return true if this instance of the Table Function has been created for compilation, false if it is for runtime execution. Returns:boolean true if this instance of the Table Function has been created for compilation

isCompileTime

back to summary

public final boolean isCompileTime()

Implements org.apache.derby.vti.VTIEnvironment.isCompileTime.

Doc from org.apache.derby.vti.VTIEnvironment.isCompileTime.

Return true if this instance of the Table Function has been created for compilation, false if it is for runtime execution.

Returns:boolean: true if this instance of the Table Function has been created for compilation

isReuseablePs	back to summary
pack-priv boolean isReuseablePs()

openCore	back to summary
public void openCore() throws StandardException Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.openCore. Sets state to 'open'. Exceptions StandardException: thrown if activation closed.

openCore

back to summary

public void openCore() throws StandardException

Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.openCore.

Sets state to 'open'.

Exceptions

StandardException:: thrown if activation closed.

populateFromResultSet	back to summary
public void populateFromResultSet(ExecRow row) throws StandardException Exceptions StandardException: thrown on failure to open

reopenCore back to summary

public void reopenCore() throws StandardException

Overrides org.apache.derby.impl.sql.execute.BasicNoPutResultSetImpl.reopenCore.

Implements org.apache.derby.iapi.sql.execute.NoPutResultSet.reopenCore.

If the VTI is a version2 vti that does not need to be instantiated multiple times then we simply close the current ResultSet and create a new one via a call to PreparedStatement.executeQuery().

Exceptions

StandardException:: thrown if cursor finished.

See Also

NoPutResultSet#openCore

setNullableColumnList	back to summary
private boolean[] setNullableColumnList() throws SQLException, StandardException

setSharedState

back to summary

public final void setSharedState(String key, Serializable value)

Implements org.apache.derby.vti.VTIEnvironment.setSharedState.

Doc from org.apache.derby.vti.VTIEnvironment.setSharedState.

Saves an object associated with a key that will be maintained for the lifetime of the statement plan. Any previous value associated with the key is discarded. Any saved object can be seen by any JDBC Connection that has a Statement object that references the same statement plan.

Parameters