org.apache.commons.dbcp
Class DelegatingPreparedStatement

java.lang.Object
  |
  +--org.apache.commons.dbcp.AbandonedTrace
        |
        +--org.apache.commons.dbcp.DelegatingPreparedStatement

All Implemented Interfaces:

java.sql.PreparedStatement, java.sql.Statement

Direct Known Subclasses:

PoolablePreparedStatement

public class DelegatingPreparedStatement

extends AbandonedTrace

implements java.sql.PreparedStatement

A base delegating implementation of PreparedStatement.

All of the methods from the PreparedStatement interface simply check to see that the PreparedStatement is active, and call the corresponding method on the "delegate" provided in my constructor.

Extends AbandonedTrace to implement Statement tracking and logging of code which created the Statement. Tracking the Statement ensures that the Connection which created it can close any open Statement's on Connection close.

Author:

Rodney Waldhoff

, Glenn L. Nielsen , James House (james@interobjective.com)

Field Summary

protected boolean	_closed
protected DelegatingConnection	_conn The connection that created me.
protected java.sql.PreparedStatement	_stmt My delegate.

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

DelegatingPreparedStatement(DelegatingConnection c, java.sql.PreparedStatement s)
Create a wrapper for the Statement which traces this Statement to the Connection which created it and the code which created it.

Method Summary

protected void	activate()
void	addBatch()
void	addBatch(java.lang.String sql)
void	cancel()
protected void	checkOpen()
void	clearBatch()
void	clearParameters()
void	clearWarnings()
void	close() Close this DelegatingPreparedStatement, and close any ResultSets that were not explicitly closed.
boolean	execute()
boolean	execute(java.lang.String sql)
int[]	executeBatch()
java.sql.ResultSet	executeQuery()
java.sql.ResultSet	executeQuery(java.lang.String sql)
int	executeUpdate()
int	executeUpdate(java.lang.String sql)
java.sql.Connection	getConnection()
java.sql.PreparedStatement	getDelegate() Returns my underlying PreparedStatement.
int	getFetchDirection()
int	getFetchSize()
java.sql.PreparedStatement	getInnermostDelegate() If my underlying PreparedStatement is not a DelegatingPreparedStatement, returns it, otherwise recursively invokes this method on my delegate.
int	getMaxFieldSize()
int	getMaxRows()
java.sql.ResultSetMetaData	getMetaData()
boolean	getMoreResults()
int	getQueryTimeout()
java.sql.ResultSet	getResultSet()
int	getResultSetConcurrency()
int	getResultSetType()
int	getUpdateCount()
java.sql.SQLWarning	getWarnings()
protected void	passivate()
void	setArray(int i, java.sql.Array x)
void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length)
void	setBigDecimal(int parameterIndex, java.math.BigDecimal x)
void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length)
void	setBlob(int i, java.sql.Blob x)
void	setBoolean(int parameterIndex, boolean x)
void	setByte(int parameterIndex, byte x)
void	setBytes(int parameterIndex, byte[] x)
void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length)
void	setClob(int i, java.sql.Clob x)
void	setCursorName(java.lang.String name)
void	setDate(int parameterIndex, java.sql.Date x)
void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal)
void	setDelegate(java.sql.PreparedStatement s) Sets my delegate.
void	setDouble(int parameterIndex, double x)
void	setEscapeProcessing(boolean enable)
void	setFetchDirection(int direction)
void	setFetchSize(int rows)
void	setFloat(int parameterIndex, float x)
void	setInt(int parameterIndex, int x)
void	setLong(int parameterIndex, long x)
void	setMaxFieldSize(int max)
void	setMaxRows(int max)
void	setNull(int parameterIndex, int sqlType)
void	setNull(int paramIndex, int sqlType, java.lang.String typeName)
void	setObject(int parameterIndex, java.lang.Object x)
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType)
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale)
void	setQueryTimeout(int seconds)
void	setRef(int i, java.sql.Ref x)
void	setShort(int parameterIndex, short x)
void	setString(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 cal)
void	setTimestamp(int parameterIndex, java.sql.Timestamp x)
void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal)

Methods inherited from class org.apache.commons.dbcp.AbandonedTrace

addTrace, clearTrace, getConfig, getLastUsed, getTrace, printStackTrace, removeTrace, setLastUsed, setLastUsed, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.PreparedStatement

getParameterMetaData, setUnicodeStream, setURL

Methods inherited from interface java.sql.Statement

execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getGeneratedKeys, getMoreResults, getResultSetHoldability

Field Detail

_closed

protected boolean _closed

_conn

protected DelegatingConnection _conn

The connection that created me.

_stmt

protected java.sql.PreparedStatement _stmt

My delegate.

Constructor Detail

DelegatingPreparedStatement

public DelegatingPreparedStatement(DelegatingConnection c,
                                   java.sql.PreparedStatement s)

Create a wrapper for the Statement which traces this Statement to the Connection which created it and the code which created it.

Parameters:

s - the PreparedStatement to delegate all calls to.

c - the DelegatingConnection that created this statement.

Method Detail

activate

protected void activate()

addBatch

public void addBatch()
              throws java.sql.SQLException

Specified by:

addBatch in interface java.sql.PreparedStatement

java.sql.SQLException

addBatch

public void addBatch(java.lang.String sql)
              throws java.sql.SQLException

Specified by:

addBatch in interface java.sql.Statement

java.sql.SQLException

cancel

public void cancel()
            throws java.sql.SQLException

Specified by:

cancel in interface java.sql.Statement

java.sql.SQLException

checkOpen

protected void checkOpen()
                  throws java.sql.SQLException

java.sql.SQLException

clearBatch

public void clearBatch()
                throws java.sql.SQLException

Specified by:

clearBatch in interface java.sql.Statement

java.sql.SQLException

clearParameters

public void clearParameters()
                     throws java.sql.SQLException

Specified by:

clearParameters in interface java.sql.PreparedStatement

java.sql.SQLException

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException

Specified by:

clearWarnings in interface java.sql.Statement

java.sql.SQLException

close

public void close()
           throws java.sql.SQLException

Close this DelegatingPreparedStatement, and close any ResultSets that were not explicitly closed.

Specified by:

close in interface java.sql.Statement

java.sql.SQLException

execute

public boolean execute()
                throws java.sql.SQLException

Specified by:

execute in interface java.sql.PreparedStatement

java.sql.SQLException

execute

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

Specified by:

execute in interface java.sql.Statement

java.sql.SQLException

executeBatch

public int[] executeBatch()
                   throws java.sql.SQLException

Specified by:

executeBatch in interface java.sql.Statement

java.sql.SQLException

executeQuery

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

Specified by:

executeQuery in interface java.sql.PreparedStatement

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

java.sql.SQLException

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Specified by:

executeUpdate in interface java.sql.PreparedStatement

java.sql.SQLException

executeUpdate

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

Specified by:

executeUpdate in interface java.sql.Statement

java.sql.SQLException

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface java.sql.Statement

java.sql.SQLException

getDelegate

public java.sql.PreparedStatement getDelegate()

Returns my underlying PreparedStatement.

Returns:

my underlying PreparedStatement.

getFetchDirection

public int getFetchDirection()
                      throws java.sql.SQLException

Specified by:

getFetchDirection in interface java.sql.Statement

java.sql.SQLException

getFetchSize

public int getFetchSize()
                 throws java.sql.SQLException

Specified by:

getFetchSize in interface java.sql.Statement

java.sql.SQLException

getInnermostDelegate

public java.sql.PreparedStatement getInnermostDelegate()

If my underlying PreparedStatement is not a DelegatingPreparedStatement, returns it, otherwise recursively invokes this method on my delegate.

Hence this method will return the first delegate that is not a DelegatingPreparedStatement, or null when no non-DelegatingPreparedStatement delegate can be found by transversing this chain.

This method is useful when you may have nested DelegatingPreparedStatements, and you want to make sure to obtain a "genuine" PreparedStatement.

getMaxFieldSize

public int getMaxFieldSize()
                    throws java.sql.SQLException

Specified by:

getMaxFieldSize in interface java.sql.Statement

java.sql.SQLException

getMaxRows

public int getMaxRows()
               throws java.sql.SQLException

Specified by:

getMaxRows in interface java.sql.Statement

java.sql.SQLException

getMetaData

public java.sql.ResultSetMetaData getMetaData()
                                       throws java.sql.SQLException

Specified by:

getMetaData in interface java.sql.PreparedStatement

java.sql.SQLException

getMoreResults

public boolean getMoreResults()
                       throws java.sql.SQLException

Specified by:

getMoreResults in interface java.sql.Statement

java.sql.SQLException

getQueryTimeout

public int getQueryTimeout()
                    throws java.sql.SQLException

Specified by:

getQueryTimeout in interface java.sql.Statement

java.sql.SQLException

getResultSet

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

Specified by:

getResultSet in interface java.sql.Statement

java.sql.SQLException

getResultSetConcurrency

public int getResultSetConcurrency()
                            throws java.sql.SQLException

Specified by:

getResultSetConcurrency in interface java.sql.Statement

java.sql.SQLException

getResultSetType

public int getResultSetType()
                     throws java.sql.SQLException

Specified by:

getResultSetType in interface java.sql.Statement

java.sql.SQLException

getUpdateCount

public int getUpdateCount()
                   throws java.sql.SQLException

Specified by:

getUpdateCount in interface java.sql.Statement

java.sql.SQLException

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException

Specified by:

getWarnings in interface java.sql.Statement

java.sql.SQLException

passivate

protected void passivate()
                  throws java.sql.SQLException

java.sql.SQLException

setArray

public void setArray(int i,
                     java.sql.Array x)
              throws java.sql.SQLException

Specified by:

setArray in interface java.sql.PreparedStatement

java.sql.SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

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

java.sql.SQLException

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

java.sql.SQLException

setBlob

public void setBlob(int i,
                    java.sql.Blob x)
             throws java.sql.SQLException

Specified by:

setBlob in interface java.sql.PreparedStatement

java.sql.SQLException

setBoolean

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

Specified by:

setBoolean in interface java.sql.PreparedStatement

java.sql.SQLException

setByte

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

Specified by:

setByte in interface java.sql.PreparedStatement

java.sql.SQLException

setBytes

public void setBytes(int parameterIndex,
                     byte[] x)
              throws java.sql.SQLException

Specified by:

setBytes in interface java.sql.PreparedStatement

java.sql.SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

java.sql.SQLException

setClob

public void setClob(int i,
                    java.sql.Clob x)
             throws java.sql.SQLException

Specified by:

setClob in interface java.sql.PreparedStatement

java.sql.SQLException

setCursorName

public void setCursorName(java.lang.String name)
                   throws java.sql.SQLException

Specified by:

setCursorName in interface java.sql.Statement

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

java.sql.SQLException

setDate

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

Specified by:

setDate in interface java.sql.PreparedStatement

java.sql.SQLException

setDelegate

public void setDelegate(java.sql.PreparedStatement s)

Sets my delegate.

setDouble

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

Specified by:

setDouble in interface java.sql.PreparedStatement

java.sql.SQLException

setEscapeProcessing

public void setEscapeProcessing(boolean enable)
                         throws java.sql.SQLException

Specified by:

setEscapeProcessing in interface java.sql.Statement

java.sql.SQLException

setFetchDirection

public void setFetchDirection(int direction)
                       throws java.sql.SQLException

Specified by:

setFetchDirection in interface java.sql.Statement

java.sql.SQLException

setFetchSize

public void setFetchSize(int rows)
                  throws java.sql.SQLException

Specified by:

setFetchSize in interface java.sql.Statement

java.sql.SQLException

setFloat

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

Specified by:

setFloat in interface java.sql.PreparedStatement

java.sql.SQLException

setInt

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

Specified by:

setInt in interface java.sql.PreparedStatement

java.sql.SQLException

setLong

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

Specified by:

setLong in interface java.sql.PreparedStatement

java.sql.SQLException

setMaxFieldSize

public void setMaxFieldSize(int max)
                     throws java.sql.SQLException

Specified by:

setMaxFieldSize in interface java.sql.Statement

java.sql.SQLException

setMaxRows

public void setMaxRows(int max)
                throws java.sql.SQLException

Specified by:

setMaxRows in interface java.sql.Statement

java.sql.SQLException

setNull

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

Specified by:

setNull in interface java.sql.PreparedStatement

java.sql.SQLException

setNull

public void setNull(int paramIndex,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.SQLException

Specified by:

setNull in interface java.sql.PreparedStatement

java.sql.SQLException

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x)
               throws java.sql.SQLException

Specified by:

setObject in interface java.sql.PreparedStatement

java.sql.SQLException

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException

Specified by:

setObject in interface java.sql.PreparedStatement

java.sql.SQLException

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException

Specified by:

setObject in interface java.sql.PreparedStatement

java.sql.SQLException

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws java.sql.SQLException

Specified by:

setQueryTimeout in interface java.sql.Statement

java.sql.SQLException

setRef

public void setRef(int i,
                   java.sql.Ref x)
            throws java.sql.SQLException

Specified by:

setRef in interface java.sql.PreparedStatement

java.sql.SQLException

setShort

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

Specified by:

setShort in interface java.sql.PreparedStatement

java.sql.SQLException

setString

public void setString(int parameterIndex,
                      java.lang.String x)
               throws java.sql.SQLException

Specified by:

setString in interface java.sql.PreparedStatement

java.sql.SQLException

setTime

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

Specified by:

setTime in interface java.sql.PreparedStatement

java.sql.SQLException

setTime

public void setTime(int parameterIndex,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

Specified by:

setTime in interface java.sql.PreparedStatement

java.sql.SQLException

setTimestamp

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

Specified by:

setTimestamp in interface java.sql.PreparedStatement

java.sql.SQLException

setTimestamp

public void setTimestamp(int parameterIndex,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException

Specified by:

setTimestamp in interface java.sql.PreparedStatement

java.sql.SQLException