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

All Superinterfaces:
Dependable, Dependent, PreparedStatement, Provider
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).

Author:
ames

Field Summary
 
Fields inherited from interface org.apache.derby.catalog.Dependable
ALIAS, COLUMNS_IN_TABLE, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PREPARED_STATEMENT, SCHEMA, STORED_PREPARED_STATEMENT, TABLE, 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.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
 
Methods inherited from interface org.apache.derby.iapi.sql.PreparedStatement
execute, execute, 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, makeValid, prepareToInvalidate
 
Methods inherited from interface org.apache.derby.catalog.Dependable
getClassType, getDependableFinder, getObjectID, getObjectName, isPersistent
 

Method Detail

setSource

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

Parameters:
txt - the source text

getConstantAction

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

Returns:
ConstantAction The big structure enclosing the Execution constants.

getSavedObject

public 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

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

Returns:
Object[] the saved objects

getCursorInfo

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

Returns:
Object the cursor info

getActivationClass

public 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)

finish

public 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

public boolean needsSavepoint()
Does this statement need a savpoint

Returns:
true if needs a savepoint

getClone

public 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

public int getUpdateMode()
the update mode of the cursor

Returns:
The update mode of the cursor

getTargetTable

public ExecCursorTableReference getTargetTable()
the target table of the cursor

Returns:
target table of the cursor

getTargetColumns

public 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

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

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

setValid

public void setValid()
set this parepared statement to be valid


setSPSAction

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



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