org.apache.derby.iapi.sql.execute
Interface ExecPreparedStatement

All Superinterfaces:
Dependable, Dependent, PreparedStatement
All Known Subinterfaces:
StorablePreparedStatement
All Known Implementing Classes:
GenericPreparedStatement, GenericStorablePreparedStatement

public interface ExecPreparedStatement
extends PreparedStatement

Execution extends prepared statement to add methods it needs for execution purposes (that should not be on the Database API).


Field Summary
 
Fields inherited from interface org.apache.derby.catalog.Dependable
ACTIVATION, ALIAS, COLUMNS_IN_TABLE, COLUMNS_PERMISSION, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PERM, PREPARED_STATEMENT, ROLE_GRANT, ROUTINE_PERMISSION, SCHEMA, SEQUENCE, STORED_PREPARED_STATEMENT, TABLE, TABLE_PERMISSION, TRIGGER, VIEW
 
Method Summary
 void finish(LanguageConnectionContext lcc)
          Mark the statement as unusable, i.e. the system is finished with it and no one should be able to use it.
 GeneratedClass getActivationClass()
          Get the class generated for this prepared statement.
 ExecPreparedStatement getClone()
          Get a new prepared statement that is a shallow copy of the current one.
 ConstantAction getConstantAction()
          Get the Execution constants.
 java.lang.Object getCursorInfo()
          Get the saved cursor info.
 java.util.List getRequiredPermissionsList()
           
 java.lang.Object getSavedObject(int objectNum)
          Get a saved object by number.
 java.lang.Object[] getSavedObjects()
          Get all the saved objects.
 ResultColumnDescriptor[] getTargetColumns()
          the target columns of the cursor; this is a superset of the updatable columns, describing the row available
 ExecCursorTableReference getTargetTable()
          the target table of the cursor
 java.lang.String[] getUpdateColumns()
          the update columns of the cursor
 int getUpdateMode()
          the update mode of the cursor
 boolean needsSavepoint()
          Does this statement need a savpoint
 void setSource(java.lang.String txt)
          set the statement text
 void setSPSAction()
          Indicate that the statement represents an SPS action
 void setValid()
          set this parepared statement to be valid
 boolean upToDate(GeneratedClass gc)
           Checks whether this PreparedStatement is up to date and its activation class is identical to the supplied generated class.
 
Methods inherited from interface org.apache.derby.iapi.sql.PreparedStatement
execute, executeSubStatement, executeSubStatement, getActivation, getBeginCompileTimestamp, getBindTimeInMillis, getCompileTimeInMillis, getCompileTimeWarnings, getEndCompileTimestamp, getGenerateTimeInMillis, getOptimizeTimeInMillis, getParameterTypes, getParseTimeInMillis, getResultDescription, getSource, getSPSName, isAtomic, referencesSessionSchema, rePrepare, upToDate
 
Methods inherited from interface org.apache.derby.iapi.sql.depend.Dependent
isValid, makeInvalid, prepareToInvalidate
 
Methods inherited from interface org.apache.derby.catalog.Dependable
getClassType, getDependableFinder, getObjectID, getObjectName, isPersistent
 

Method Detail

setSource

void setSource(java.lang.String txt)
set the statement text

Parameters:
txt - the source text

getConstantAction

ConstantAction getConstantAction()
Get the Execution constants. This routine is called at Execution time.

Returns:
ConstantAction The big structure enclosing the Execution constants.

getSavedObject

java.lang.Object getSavedObject(int objectNum)
Get a saved object by number. This is called during execution to access objects created at compile time. These are meant to be read-only at run time.

Returns:
Object A saved object. The caller has to know what it is requesting and cast it back to the expected type.

getSavedObjects

java.lang.Object[] getSavedObjects()
Get all the saved objects. Used for stored prepared statements.

Returns:
Object[] the saved objects

getCursorInfo

java.lang.Object getCursorInfo()
Get the saved cursor info. Used for stored prepared statements.

Returns:
Object the cursor info

getActivationClass

GeneratedClass getActivationClass()
                                  throws StandardException
Get the class generated for this prepared statement. Used to confirm compatability with auxilary structures.

Throws:
StandardException - on error obtaining class (probably when a stored prepared statement is loading)

upToDate

boolean upToDate(GeneratedClass gc)
                 throws StandardException

Checks whether this PreparedStatement is up to date and its activation class is identical to the supplied generated class. A call to upToDate(gc) is supposed to perform the same work as the following code in one atomic operation:

 getActivationClass() == gc && upToDate()
 

Parameters:
gc - a generated class that must be identical to getActivationClass() for this method to return true
Returns:
true if this statement is up to date and its activation class is identical to gc, false otherwise
Throws:
StandardException
See Also:
PreparedStatement.upToDate(), getActivationClass()

finish

void finish(LanguageConnectionContext lcc)
Mark the statement as unusable, i.e. the system is finished with it and no one should be able to use it.


needsSavepoint

boolean needsSavepoint()
Does this statement need a savpoint

Returns:
true if needs a savepoint

getClone

ExecPreparedStatement getClone()
                               throws StandardException
Get a new prepared statement that is a shallow copy of the current one.

Returns:
a new prepared statement
Throws:
StandardException - on error

getUpdateMode

int getUpdateMode()
the update mode of the cursor

Returns:
The update mode of the cursor

getTargetTable

ExecCursorTableReference getTargetTable()
the target table of the cursor

Returns:
target table of the cursor

getTargetColumns

ResultColumnDescriptor[] getTargetColumns()
the target columns of the cursor; this is a superset of the updatable columns, describing the row available

Returns:
target columns of the cursor as an array of column descriptors

getUpdateColumns

java.lang.String[] getUpdateColumns()
the update columns of the cursor

Returns:
update columns of the cursor as a string of column names

setValid

void setValid()
set this parepared statement to be valid


setSPSAction

void setSPSAction()
Indicate that the statement represents an SPS action


getRequiredPermissionsList

java.util.List getRequiredPermissionsList()
Returns:
the list of permissions required to execute this statement. May be null if the database does not use SQL standard authorization

Built on Thu 2010-12-23 20:49:13+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.