Top Description Methods
org.apache.derby.vti

public Interface VTIEnvironment

Known Direct Implementers
org.apache.derby.impl.sql.execute.VTIResultSet, org.apache.derby.impl.sql.compile.FromVTI

VTIEnvironment is the state variable created by the optimizer to help it place a Table Function in the join order. The methods of VTICosting use this state variable in order to pass information to each other and learn other details of the operating environment.

See Also
org.apache.derby.vti.VTICosting

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the SQL text of the original SQL statement
getOriginalSQL
()

Return the SQL text of the original SQL statement.

public Object

Returns:

the value associated with the key
getSharedState
(String
Key into a cache of context variables
key
)

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

public int

Returns:

the specific JDBC isolation of the statement
getStatementIsolationLevel
()

Get the specific JDBC isolation of the statement.

public boolean

Returns:

true if this instance of the Table Function has been created for compilation
isCompileTime
()

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

public void
setSharedState(String
Key into a cache of context variables
key
,
Serializable
Value to associate with the key
value
)

Saves an object associated with a key that will be maintained for the lifetime of the statement plan.

Method Detail

getOriginalSQLback to summary
public String getOriginalSQL()

Return the SQL text of the original SQL statement.

Returns:String

the SQL text of the original SQL statement

getSharedStateback to summary
public Object getSharedState(String key)

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

getStatementIsolationLevelback to summary
public int 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

isCompileTimeback to summary
public boolean 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

setSharedStateback to summary
public void setSharedState(String key, Serializable value)

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
key:String

Key into a cache of context variables

value:Serializable

Value to associate with the key