org.apache.derby.client.am
Class PreparedStatement

java.lang.Object
  org.apache.derby.client.am.Statement
      org.apache.derby.client.am.PreparedStatement

All Implemented Interfaces:

java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper, PreparedStatementCallbackInterface, StatementCallbackInterface, UnitOfWorkListener

Direct Known Subclasses:

CallableStatement, PreparedStatement40

public class PreparedStatement
extends Statement
implements java.sql.PreparedStatement, PreparedStatementCallbackInterface

Nested Class Summary

private static class

PreparedStatement.PossibleTypes PossibleTypes is information which is set of types.

Field Summary

(package private) boolean	listenToUnitOfWork_
MaterialPreparedStatement	materialPreparedStatement_
boolean	outputRegistered_
ColumnMetaData	parameterMetaData_
(package private) boolean[]	parameterRegistered_
java.lang.Object[]	parameters_
(package private) boolean[]	parameterSet_
private java.util.ArrayList	parameterTypeList
protected ClientPooledConnection	pooledConnection_
(package private) java.lang.String	positionedUpdateCursorName_
java.lang.String	sql_

Fields inherited from class org.apache.derby.client.am.Statement

agent_, autoGeneratedKeys_, batch_, cachedCursor_, cachedSingletonRowData_, CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, connection_, cursorAttributesToSendOnPrepare_, cursorName_, doWriteTimeout, executeMethod__, executeQueryMethod__, executeUpdateMethod__, fetchDirection_, fetchSize_, generatedKeysColumnIndexes_, generatedKeysColumnNames_, generatedKeysResultSet_, indexOfCurrentResultSet_, isAutoCommittableStatement_, isCall__, isCatalogQuery_, isCommitSql__, isDeleteSql__, isInsertSql__, isPoolable, isPositionedUpdateDeleteSql__, isPreparedStatement_, isQuery__, isRollbackSql__, isUpdate__, isUpdateSql__, KEEP_CURRENT_RESULT, materialStatement_, maxFieldSize_, maxRows_, numInvisibleRS_, openOnClient_, openOnServer_, preparedStatementForAutoGeneratedKeys_, resultSet_, resultSetConcurrency_, resultSetHoldability_, resultSetList_, resultSetMetaData_, resultSetType_, returnValueFromProcedure_, section_, singletonRowData_, sqlMode_, sqlUpdateMode_, timeout_, TIMEOUT_STATEMENT, timeoutArrayList, updateCount_

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

PreparedStatement(Agent agent, Connection connection, java.lang.String sql, int type, int concurrency, int holdability, int autoGeneratedKeys, java.lang.String[] columnNames, int[] columnIndexes, ClientPooledConnection cpc)
The PreparedStatementConstructor used for jdbc 2 prepared statements with scroll attributes.

PreparedStatement(Agent agent, Connection connection, java.lang.String sql, Section section, ClientPooledConnection cpc)
The PreparedStatement constructor used for JDBC 2 positioned update statements.

Method Summary

void	addBatch()
private void	checkForSupportedDataType(int dataType) Checks whether a data type is supported for setObject(int, Object, int) and setObject(int, Object, int, int).
(package private) void	checkForValidParameterIndex(int parameterIndex)
(package private) void	checkForValidScale(int scale)
(package private) void	checkScaleForINOUTDecimal(int parameterIndex, int registerOutScale)
private void	checkStatementValidity(SqlException sqle)
private void	checkStreamLength(long length) Check the length passed in for the stream that is to be set.
private void	checkThatAllParametersAreSet()
private void	checkTypeForSetAsciiStream(int parameterIndex)
private void	checkTypeForSetBinaryStream(int parameterIndex)
private void	checkTypeForSetBlob(int parameterIndex)
private void	checkTypeForSetCharacterStream(int parameterIndex)
private void	checkTypeForSetClob(int parameterIndex)
void	clearParameters()
void	completeDescribeInput(ColumnMetaData parameterMetaData, Sqlca sqlca)
void	completeDescribeOutput(ColumnMetaData resultSetMetaData, Sqlca sqlca)
void	completeLocalCommit(java.util.Iterator listenerIterator)
void	completeLocalRollback(java.util.Iterator listenerIterator)
(package private) void	completePrepareDescribe()
boolean	execute()
boolean	execute(java.lang.String sql)
boolean	execute(java.lang.String sql, int autoGeneratedKeys)
boolean	execute(java.lang.String sql, int[] columnIndexes)
boolean	execute(java.lang.String sql, java.lang.String[] columnNames)
int[]	executeBatch()
private int[]	executeBatchRequestX(boolean supportsQueryBatchRequest)
int[]	executeBatchX(boolean supportsQueryBatchRequest)
java.sql.ResultSet	executeQuery()
java.sql.ResultSet	executeQuery(java.lang.String sql)
(package private) ResultSet	executeQueryX()
int	executeUpdate()
int	executeUpdate(java.lang.String sql)
int	executeUpdate(java.lang.String sql, int autoGeneratedKeys)
int	executeUpdate(java.lang.String sql, int[] columnIndexes)
int	executeUpdate(java.lang.String sql, java.lang.String[] columnNames)
private int	executeUpdateX()
(package private) boolean	executeX()
private boolean[]	expandBooleanArray(boolean[] array, int newLength)
private java.lang.Object[]	expandObjectArray(java.lang.Object[] array, int newLength)
private void	flowExecute(int executeType)
(package private) void	flowPrepareDescribeInputOutput()
private ColumnMetaData	getColumnMetaDataX()
protected java.lang.String	getJdbcStatementInterfaceName() Returns the name of the java.sql interface implemented by this class.
java.sql.ResultSetMetaData	getMetaData()
private ColumnMetaData	getMetaDataX()
java.sql.ParameterMetaData	getParameterMetaData()
private ParameterMetaData	getParameterMetaDataX()
private void	initPreparedStatement()
private void	initPreparedStatement(ColumnMetaData parameterMetaData, ColumnMetaData resultSetMetaData)
private void	initPreparedStatement(java.lang.String sql)
private void	initPreparedStatement(java.lang.String sql, Section section)
protected void	initResetPreparedStatement()
void	listenToUnitOfWork()
protected void	markClosed(boolean removeListener) This method cleans up client-side resources held by this Statement.
(package private) void	prepare()
void	readDescribeInput()
void	readDescribeOutput()
void	readExecute()
(package private) void	readPrepareDescribeInput()
(package private) void	readPrepareDescribeInputOutput()
void	reset(boolean fullReset)
(package private) void	resetForReuse() Resets the prepared statement for reuse in a statement pool.
private void	resetParameters()
void	resetPreparedStatement(Agent agent, Connection connection, java.lang.String sql, int type, int concurrency, int holdability, int autoGeneratedKeys, java.lang.String[] columnNames, int[] columnIndexes)
void	resetPreparedStatement(Agent agent, Connection connection, java.lang.String sql, Section section)
void	resetPreparedStatement(Agent agent, Connection connection, java.lang.String sql, Section section, ColumnMetaData parameterMetaData, ColumnMetaData resultSetMetaData)
void	setArray(int parameterIndex, java.sql.Array x)
void	setAsciiStream(int parameterIndex, java.io.InputStream x) Sets the designated parameter to the given input stream.
void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length) We do this inefficiently and read it all in here.
void	setAsciiStream(int parameterIndex, java.io.InputStream x, long length) We do this inefficiently and read it all in here.
void	setBigDecimal(int parameterIndex, java.math.BigDecimal x)
void	setBinaryStream(int parameterIndex, java.io.InputStream x) Sets the designated parameter to the given input stream.
void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length) sets the parameter to the Binary Stream object
void	setBinaryStream(int parameterIndex, java.io.InputStream x, long length) sets the parameter to the Binary Stream object
protected void	setBinaryStreamX(int parameterIndex, java.io.InputStream x, int length)
void	setBlob(int parameterIndex, java.sql.Blob x)
void	setBlob(int parameterIndex, java.io.InputStream inputStream) Sets the designated parameter to a InputStream object.
void	setBlob(int parameterIndex, java.io.InputStream inputStream, long length) Sets the designated parameter to a InputStream object.
void	setBlobX(int parameterIndex, java.sql.Blob x)
void	setBoolean(int parameterIndex, boolean x)
void	setByte(int parameterIndex, byte x)
void	setBytes(int parameterIndex, byte[] x)
void	setBytesX(int parameterIndex, byte[] x)
void	setCharacterStream(int parameterIndex, java.io.Reader x) Sets the designated parameter to the given Reader object.
void	setCharacterStream(int parameterIndex, java.io.Reader x, int length) Sets the designated parameter to the given Reader, which will have the specified number of bytes.
void	setCharacterStream(int parameterIndex, java.io.Reader x, long length) Sets the designated parameter to the given Reader, which will have the specified number of bytes.
void	setClob(int parameterIndex, java.sql.Clob x)
void	setClob(int parameterIndex, java.io.Reader reader) Sets the designated parameter to a Reader object.
void	setClob(int parameterIndex, java.io.Reader reader, long length) Sets the designated parameter to a Reader object.
(package private) void	setClobX(int parameterIndex, java.sql.Clob x)
void	setDate(int parameterIndex, java.sql.Date x)
void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar calendar)
void	setDouble(int parameterIndex, double x)
void	setFloat(int parameterIndex, float x)
(package private) void	setInput(int parameterIndex, java.lang.Object input)
void	setInt(int parameterIndex, int x)
(package private) void	setIntX(int parameterIndex, int x)
void	setLong(int parameterIndex, long x)
(package private) void	setLongX(int parameterIndex, long x)
void	setNull(int parameterIndex, int jdbcType)
void	setNull(int parameterIndex, int jdbcType, java.lang.String typeName)
(package private) void	setNullX(int parameterIndex, int jdbcType)
void	setObject(int parameterIndex, java.lang.Object x)
void	setObject(int parameterIndex, java.lang.Object x, int targetJdbcType)
void	setObject(int parameterIndex, java.lang.Object x, int targetJdbcType, int scale)
private void	setObjectX(int parameterIndex, java.lang.Object x, int targetJdbcType, int scale)
void	setRef(int parameterIndex, java.sql.Ref x)
void	setShort(int parameterIndex, short x)
(package private) void	setShortX(int parameterIndex, short x)
void	setString(int parameterIndex, java.lang.String x)
(package private) void	setStringX(int parameterIndex, java.lang.String x)
void	setTime(int parameterIndex, java.sql.Time x)
void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar calendar)
void	setTimestamp(int parameterIndex, java.sql.Timestamp x)
void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar calendar)
void	setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) Deprecated.
void	setURL(int parameterIndex, java.net.URL x)
void	writeDescribeInput(Section section)
void	writeDescribeOutput(Section section)
void	writeExecute(Section section, ColumnMetaData parameterMetaData, java.lang.Object[] inputs, int numInputColumns, boolean outputExpected, boolean chainedWritesFollowingSetLob)
private void	writeOpenQuery(Section section, int fetchSize, int resultSetType, int numInputColumns, ColumnMetaData parameterMetaData, java.lang.Object[] inputs)
(package private) void	writePrepareDescribeInput()
(package private) void	writePrepareDescribeInputOutput()
(package private) void	writePrepareDescribeInputOutput(java.lang.String sql, Section section)

Methods inherited from class org.apache.derby.client.am.Statement

accumulateWarning, addBatch, cacheCursorAttributesToSendOnPrepare, cancel, checkAutoGeneratedKeysParameters, checkForAppropriateSqlMode, checkForClosedStatement, checkForDuplicateCursorName, checkForInvalidBatchedSql, checkForStoredProcResultSetCount, clearBatch, clearWarnings, clearWarningsX, close, closeX, completeExecute, completeExecuteCall, completeExecuteCall, completeExecuteCallOpenQuery, completeExecuteImmediate, completeExecuteSetStatement, completeOpenQuery, completePrepare, completePrepareDescribeOutput, completeSqlca, escape, executeX, extractCursorNameFromWhereCurrentOf, finalize, flowExecuteBatch, getConnection, getConnectionCallbackInterface, getFetchDirection, getFetchSize, getGeneratedKeys, getGuessedResultSetMetaData, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getOwner, getPreparedStatementForAutoGeneratedKeys, getProcedureName, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getSqlWarnings, getUpdateCount, getWarnings, isClosed, isPoolable, isQueryMode, isWrapperFor, jdbc3FeatureNotSupported, jdbc3FeatureNotSupported, mapCursorNameToResultSet, markAutoCommitted, markClosed, markClosedOnServer, markPreparedStatementForAutoGeneratedKeysClosed, markResultSetsClosed, markResultSetsClosed, parseSqlAndSetSqlModes, parseStorProcReturnedScrollableRowset, prepareAutoGeneratedKeysStatement, readClose, readCloseResultSets, readCloseResultSets, readExecuteCall, readExecuteImmediate, readExecuteImmediateForBatch, readOpenQuery, readPrepare, readPrepareAutoGeneratedKeysStatement, readPrepareDescribeOutput, readSetSpecialRegister, removeClientCursorNameFromCache, resetCursorNameAndRemoveFromWhereCurrentOfMappings, resetStatement, resetStatement, resultSetCommitting, resultSetCommitting, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setOwner, setPoolable, setQueryTimeout, setupCursorNameCacheAndMappings, setUpdateCount, substituteClientCursorNameWithServerCursorName, upperCaseProcedureName, writeClose, writeCloseResultSets, writeCloseResultSets, writeExecuteCall, writeExecuteImmediate, writeOpenQuery, writePrepare, writePrepareDescribeOutput, writeSetSpecialRegister

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.sql.PreparedStatement

setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setRowId, setSQLXML

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Methods inherited from interface org.apache.derby.client.am.StatementCallbackInterface

accumulateWarning, completeExecute, completeExecuteCall, completeExecuteCall, completeExecuteCallOpenQuery, completeExecuteImmediate, completeExecuteSetStatement, completeOpenQuery, completePrepare, completePrepareDescribeOutput, completeSqlca, getConnectionCallbackInterface, getGuessedResultSetMetaData

Field Detail

materialPreparedStatement_

public MaterialPreparedStatement materialPreparedStatement_

sql_

public java.lang.String sql_

outputRegistered_

public boolean outputRegistered_

parameters_

public java.lang.Object[] parameters_

parameterSet_

boolean[] parameterSet_

parameterRegistered_

boolean[] parameterRegistered_

parameterMetaData_

public ColumnMetaData parameterMetaData_

parameterTypeList

private java.util.ArrayList parameterTypeList

positionedUpdateCursorName_

java.lang.String positionedUpdateCursorName_

pooledConnection_

protected final ClientPooledConnection pooledConnection_

listenToUnitOfWork_

boolean listenToUnitOfWork_

Constructor Detail

PreparedStatement

public PreparedStatement(Agent agent,
                         Connection connection,
                         java.lang.String sql,
                         Section section,
                         ClientPooledConnection cpc)
                  throws SqlException

The PreparedStatement constructor used for JDBC 2 positioned update statements. Called by material statement constructors. It has the ClientPooledConnection as one of its parameters this is used to raise the Statement Events when the prepared statement is closed

Parameters:

agent - The instance of NetAgent associated with this CallableStatement object.

connection - The connection object associated with this PreparedStatement Object.

sql - A String object that is the SQL statement to be sent to the database.

section - Section

cpc - The ClientPooledConnection wraps the underlying physical connection associated with this prepared statement. It is used to pass the Statement closed and the Statement error occurred events that occur back to the ClientPooledConnection.

Throws:

SqlException

PreparedStatement

public PreparedStatement(Agent agent,
                         Connection connection,
                         java.lang.String sql,
                         int type,
                         int concurrency,
                         int holdability,
                         int autoGeneratedKeys,
                         java.lang.String[] columnNames,
                         int[] columnIndexes,
                         ClientPooledConnection cpc)
                  throws SqlException

The PreparedStatementConstructor used for jdbc 2 prepared statements with scroll attributes. Called by material statement constructors. It has the ClientPooledConnection as one of its parameters this is used to raise the Statement Events when the prepared statement is closed

Parameters:

agent - The instance of NetAgent associated with this CallableStatement object.

connection - The connection object associated with this PreparedStatement Object.

sql - A String object that is the SQL statement to be sent to the database.

type - One of the ResultSet type constants.

concurrency - One of the ResultSet concurrency constants.

holdability - One of the ResultSet holdability constants.

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned.

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows.

columnIndexes - an array of column names indicating the columns that should be returned from the inserted row.

cpc - The ClientPooledConnection wraps the underlying physical connection associated with this prepared statement it is used to pass the Statement closed and the Statement error occurred events that occur back to the ClientPooledConnection.

Throws:

SqlException

Method Detail

setInput

void setInput(int parameterIndex,
              java.lang.Object input)

initPreparedStatement

private void initPreparedStatement()

initResetPreparedStatement

protected void initResetPreparedStatement()

Overrides:

initResetPreparedStatement in class Statement

reset

public void reset(boolean fullReset)
           throws SqlException

Overrides:

reset in class Statement

Throws:

SqlException

resetForReuse

void resetForReuse()
             throws SqlException

Resets the prepared statement for reuse in a statement pool.

Overrides:

resetForReuse in class Statement

Throws:

SqlException - if the reset fails

See Also:

Statement.resetForReuse()

resetParameters

private void resetParameters()

resetPreparedStatement

public void resetPreparedStatement(Agent agent,
                                   Connection connection,
                                   java.lang.String sql,
                                   Section section)
                            throws SqlException

Throws:

SqlException

initPreparedStatement

private void initPreparedStatement(java.lang.String sql,
                                   Section section)
                            throws SqlException

Throws:

SqlException

resetPreparedStatement

public void resetPreparedStatement(Agent agent,
                                   Connection connection,
                                   java.lang.String sql,
                                   int type,
                                   int concurrency,
                                   int holdability,
                                   int autoGeneratedKeys,
                                   java.lang.String[] columnNames,
                                   int[] columnIndexes)
                            throws SqlException

Throws:

SqlException

initPreparedStatement

private void initPreparedStatement(java.lang.String sql)
                            throws SqlException

Throws:

SqlException

resetPreparedStatement

public void resetPreparedStatement(Agent agent,
                                   Connection connection,
                                   java.lang.String sql,
                                   Section section,
                                   ColumnMetaData parameterMetaData,
                                   ColumnMetaData resultSetMetaData)
                            throws SqlException

Throws:

SqlException

initPreparedStatement

private void initPreparedStatement(ColumnMetaData parameterMetaData,
                                   ColumnMetaData resultSetMetaData)
                            throws SqlException

Throws:

SqlException

prepare

void prepare()
       throws SqlException

Throws:

SqlException

execute

public boolean execute(java.lang.String sql)
                throws java.sql.SQLException

Specified by:

execute in interface java.sql.Statement

Overrides:

execute in class Statement

Throws:

java.sql.SQLException

executeQuery

public java.sql.ResultSet executeQuery(java.lang.String sql)
                                throws java.sql.SQLException

Specified by:

executeQuery in interface java.sql.Statement

Overrides:

executeQuery in class Statement

Throws:

java.sql.SQLException

executeUpdate

public int executeUpdate(java.lang.String sql)
                  throws java.sql.SQLException

Specified by:

executeUpdate in interface java.sql.Statement

Overrides:

executeUpdate in class Statement

Throws:

java.sql.SQLException

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException

Specified by:

executeQuery in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

executeQueryX

ResultSet executeQueryX()
                  throws SqlException

Throws:

SqlException

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Specified by:

executeUpdate in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

executeUpdateX

private int executeUpdateX()
                    throws SqlException

Throws:

SqlException

setNull

public void setNull(int parameterIndex,
                    int jdbcType)
             throws java.sql.SQLException

Specified by:

setNull in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNullX

void setNullX(int parameterIndex,
              int jdbcType)
        throws SqlException

Throws:

SqlException

setNull

public void setNull(int parameterIndex,
                    int jdbcType,
                    java.lang.String typeName)
             throws java.sql.SQLException

Specified by:

setNull in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBoolean

public void setBoolean(int parameterIndex,
                       boolean x)
                throws java.sql.SQLException

Specified by:

setBoolean in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setByte

public void setByte(int parameterIndex,
                    byte x)
             throws java.sql.SQLException

Specified by:

setByte in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setShort

public void setShort(int parameterIndex,
                     short x)
              throws java.sql.SQLException

Specified by:

setShort in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setShortX

void setShortX(int parameterIndex,
               short x)
         throws SqlException

Throws:

SqlException

setInt

public void setInt(int parameterIndex,
                   int x)
            throws java.sql.SQLException

Specified by:

setInt in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setIntX

void setIntX(int parameterIndex,
             int x)
       throws SqlException

Throws:

SqlException

setLong

public void setLong(int parameterIndex,
                    long x)
             throws java.sql.SQLException

Specified by:

setLong in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setLongX

void setLongX(int parameterIndex,
              long x)

setFloat

public void setFloat(int parameterIndex,
                     float x)
              throws java.sql.SQLException

Specified by:

setFloat in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setDouble

public void setDouble(int parameterIndex,
                      double x)
               throws java.sql.SQLException

Specified by:

setDouble in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException

Specified by:

setBigDecimal in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x)
             throws java.sql.SQLException

Specified by:

setDate in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x,
                    java.util.Calendar&n