org.apache.derby.vti
Interface VTIEnvironment

All Known Implementing Classes:
FromVTI, VTIResultSet

public interface VTIEnvironment

VTIEnvironment is an interface used in costing VTIs. The interface is passed as a parameter to various methods in the Virtual Table interface. IBM Corp. reserves the right to change, rename, or remove this interface at any time.

See Also:
VTICosting

Method Summary
 java.lang.String getOriginalSQL()
          Return the SQL text of the original SQL statement.
 java.lang.Object getSharedState(java.lang.String key)
          Get an an object associated with a key from set of objects maintained with the statement plan.
 int getStatementIsolationLevel()
          Get the specific JDBC isolation of the statement.
 boolean isCompileTime()
          Return true if this instance of the VTI has been created for compilation, false if it is for runtime execution.
 void setSharedState(java.lang.String key, java.io.Serializable value)
          Saves an object associated with a key that will be maintained for the lifetime of the statement plan.
 

Method Detail

isCompileTime

public boolean isCompileTime()
Return true if this instance of the VTI has been created for compilation, false if it is for runtime execution.


getOriginalSQL

public java.lang.String getOriginalSQL()
Return the SQL text of the original SQL statement.


getStatementIsolationLevel

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.


setSharedState

public void setSharedState(java.lang.String key,
                           java.io.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.


getSharedState

public java.lang.Object getSharedState(java.lang.String key)
Get an an object associated with a key from set of objects maintained with the statement plan.


Built on Tue 2006-10-10 19:23:47+0200, from revision exported

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.