org.rakeshv.dbutils
Class PreparedStatementDecorator

java.lang.Object
  org.rakeshv.dbutils.StatementDecorator
      org.rakeshv.dbutils.PreparedStatementDecorator

All Implemented Interfaces:

java.sql.PreparedStatement, java.sql.Statement

Direct Known Subclasses:

CallableStatementDecorator

public class PreparedStatementDecorator
extends StatementDecorator
implements java.sql.PreparedStatement

A decorator around a PreparedStatement to enable caching and reuse of PreparedStatement objects. These work only if the underlying Connection is kept open, as is the case with connection pools or when using the ConnectionDecorator.

Copyright 2005 Rakesh Vidyadharan

Version:

$Id: ConnectionFactory.java,v 1.2 2005/10/29 22:27:38 rakesh Exp $

Author:

Rakesh Vidyadharan 2005-11-18

Field Summary

private java.sql.PreparedStatement	statement The PreparedStatement that this object decorates.
protected Statistics	statistics Statistics for this statement.

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

protected	PreparedStatementDecorator() Default constructor.
	PreparedStatementDecorator(java.sql.PreparedStatement statement) Create a new instance of the class using the specified PreparedStatement object that will be decorated.

Method Summary

void	addBatch() Adds a set of parameters to this PreparedStatement object's batch of commands.
void	clearParameters() Clears the current parameter values immediately.
void	close() Over-ridden to not close the getStatement().
boolean	execute() Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL getStatement().
java.sql.ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
int	executeUpdate() Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL getStatement().
java.sql.ResultSetMetaData	getMetaData() Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.
java.sql.ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters.
java.sql.PreparedStatement	getStatement() Returns the statement object this class decorates.
Statistics	getStatistics() Returns statistics.
void	setArray(int i, java.sql.Array x) Sets the designated parameter to the given Array object.
void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(int parameterIndex, java.math.BigDecimal x) Sets the designated parameter to the given java.math.BigDecimal value.
void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBlob(int i, java.sql.Blob x) Sets the designated parameter to the given Blob object.
void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to the given Java boolean value.
void	setByte(int parameterIndex, byte x) Sets the designated parameter to the given Java byte value.
void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length) Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setClob(int i, java.sql.Clob x) Sets the designated parameter to the given Clob object.
void	setDate(int parameterIndex, java.sql.Date x) Sets the designated parameter to the given java.sql.Date value.
void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	setDouble(int parameterIndex, double x) Sets the designated parameter to the given Java double value.
void	setFloat(int parameterIndex, float x) Sets the designated parameter to the given Java float value.
void	setInt(int parameterIndex, int x) Sets the designated parameter to the given Java int value.
void	setLong(int parameterIndex, long x) Sets the designated parameter to the given Java long value.
void	setNull(int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL.
void	setNull(int paramIndex, int sqlType, java.lang.String typeName) Sets the designated parameter to SQL NULL.
void	setObject(int parameterIndex, java.lang.Object x) Sets the value of the designated parameter using the given object.
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType) Sets the value of the designated parameter with the given object.
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) Sets the value of the designated parameter with the given object.
void	setRef(int i, java.sql.Ref x) Sets the designated parameter to the given REF() value.
void	setShort(int parameterIndex, short x) Sets the designated parameter to the given Java short value.
protected void	setStatistics(Statistics statistics) Set statistics.
void	setString(int parameterIndex, java.lang.String x) Sets the designated parameter to the given Java String value.
void	setTime(int parameterIndex, java.sql.Time x) Sets the designated parameter to the given java.sql.Time value.
void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
void	setTimestamp(int parameterIndex, java.sql.Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value.
void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
void	setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) Deprecated.
void	setURL(int parameterIndex, java.net.URL x) Sets the designated parameter to the given java.net.URL value.

Methods inherited from class org.rakeshv.dbutils.StatementDecorator

addBatch, cancel, clearBatch, clearWarnings, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Field Detail

statement

private java.sql.PreparedStatement statement

The PreparedStatement that this object decorates.

statistics

protected Statistics statistics

Statistics for this statement.

Constructor Detail

PreparedStatementDecorator

protected PreparedStatementDecorator()

Default constructor. Cannot be instantiated.

PreparedStatementDecorator

public PreparedStatementDecorator(java.sql.PreparedStatement statement)

Create a new instance of the class using the specified PreparedStatement object that will be decorated.

Parameters:

statement - The PreparedStatement that is to be decorated.

Method Detail

executeQuery

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

Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.

Specified by:

executeQuery in interface java.sql.PreparedStatement

Returns:

ResultSet A ResultSet object that contains the data produced by the query; never null

Throws:

java.sql.SQLException - If a database access error occurs or the SQL statement does not return a ResultSet object

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL getStatement().

Specified by:

executeUpdate in interface java.sql.PreparedStatement

Returns:

int Either (1) the row count for INSERT, UPDATE, or DELETE statements or (2) 0 for SQL statements that return nothing

Throws:

java.sql.SQLException - If a database access error occurs or the SQL statement returns a ResultSet object

setNull

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

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Specified by:

setNull in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

sqlType - The SQL type code defined in java.sql.Types

Throws:

java.sql.SQLException - If a database access error occurs

setBoolean

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

Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

Specified by:

setBoolean in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setByte

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

Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Specified by:

setByte in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setShort

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

Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Specified by:

setShort in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setInt

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

Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Specified by:

setInt in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setLong

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

Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Specified by:

setLong in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setFloat

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

Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Specified by:

setFloat in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setDouble

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

Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Specified by:

setDouble in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setBigDecimal

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

Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Specified by:

setBigDecimal in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setString

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

Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Specified by:

setString in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setBytes

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

Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Specified by:

setBytes in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setDate

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

Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

Specified by:

setDate in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setTime

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

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Specified by:

setTime in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setTimestamp

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

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Specified by:

setTimestamp in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

Throws:

java.sql.SQLException - If a database access error occurs

setAsciiStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The Java input stream that contains the ASCII parameter value

length - The number of bytes in the stream

Throws:

java.sql.SQLException - If a database access error occurs

setUnicodeStream

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

Deprecated.

Sets the designated parameter to the given input stream, which will have the specified number of bytes. A Unicode character has two bytes, with the first byte being the high byte, and the second being the low byte. When a very large Unicode value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from Unicode to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setUnicodeStream in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - A java.io.InputStream object that contains the Unicode parameter value as two-byte Unicode characters

length - The number of bytes in the stream

Throws:

java.sql.SQLException - If a database access error occurs

setBinaryStream

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

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The java input stream which contains the binary parameter value

length - The number of bytes in the stream

Throws:

java.sql.SQLException - If a database access error occurs

clearParameters

public void clearParameters()
                     throws java.sql.SQLException

Clears the current parameter values immediately.

In general, parameter values remain in force for repeated use of a getStatement(). Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters.

Specified by:

clearParameters in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException - If a database access error occurs

setObject

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

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used.

The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass database-specific abstract data types.

Specified by:

setObject in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The object containing the input parameter value

targetSqlType - The SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.

scale - For java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.

Throws:

java.sql.SQLException - If a database access error occurs

setObject

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

Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.

Specified by:

setObject in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The object containing the input parameter value

targetSqlType - The SQL type (as defined in java.sql.Types) to be sent to the database

Throws:

java.sql.SQLException - If a database access error occurs

setObject

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

Sets the value of the designated parameter using the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types.

The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface SQLData, the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.

Specified by:

setObject in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The object containing the input parameter value

Throws:

java.sql.SQLException - If a database access error occurs or the type of the given object is ambiguous

execute

public boolean execute()
                throws java.sql.SQLException

Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL getStatement(). Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery and executeUpdate.

The execute method returns a boolean to indicate the form of the first result. You must call either the method getResultSet or getUpdateCount to retrieve the result; you must call getMoreResults to move to any subsequent result(s).

Specified by:

execute in interface java.sql.PreparedStatement

Returns:

boolean true if the first result is a ResultSet object; false if the first result is an update count or there is no result

Throws:

java.sql.SQLException - If a database access error occurs or an argument is supplied to this method

addBatch

public void addBatch()
              throws java.sql.SQLException

Adds a set of parameters to this PreparedStatement object's batch of commands.

Specified by:

addBatch in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException - If a database access error occurs

setCharacterStream

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

Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

reader - The java.io.Reader object that contains the Unicode data

length - The number of characters in the stream

Throws:

java.sql.SQLException - If a database access error occurs

setRef

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

Sets the designated parameter to the given REF() value. The driver converts this to an SQL REF value when it sends it to the database.

Specified by:

setRef in interface java.sql.PreparedStatement

Parameters:

i - The first parameter is 1, the second is 2, ...

x - An SQL REF value

Throws:

java.sql.SQLException - If a database access error occurs

setBlob

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

Sets the designated parameter to the given Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.

Specified by:

setBlob in interface java.sql.PreparedStatement

Parameters:

i - The first parameter is 1, the second is 2, ...

x - A Blob object that maps an SQL BLOB value

Throws:

java.sql.SQLException - If a database access error occurs

setClob

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

Sets the designated parameter to the given Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.

Specified by:

setClob in interface java.sql.PreparedStatement

Parameters:

i - The first parameter is 1, the second is 2, ...

x - A Clob object that maps an SQL CLOB value

Throws:

java.sql.SQLException - If a database access error occurs

setArray

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

Sets the designated parameter to the given Array object. The driver converts this to an SQL ARRAY value when it sends it to the database.

Specified by:

setArray in interface java.sql.PreparedStatement

Parameters:

i - The first parameter is 1, the second is 2, ...

x - An Array object that maps an SQL ARRAY value

Throws:

java.sql.SQLException - If a database access error occurs

getMetaData

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

Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.

Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData on a PreparedStatement object rather than waiting to execute it and then invoking the ResultSet.getMetaData method on the ResultSet object that is returned.

NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.

Specified by:

getMetaData in interface java.sql.PreparedStatement

Returns:

ResultSetMetaData The description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object

Throws:

java.sql.SQLException - If a database access error occurs

setDate

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

Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:

setDate in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

cal - The Calendar object the driver will use to construct the date

Throws:

java.sql.SQLException - If a database access error occurs

setTime

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

Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:

setTime in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

cal - The Calendar object the driver will use to construct the time

Throws:

java.sql.SQLException - If a database access error occurs

setTimestamp

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

Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP value, which the driver then sends to the database. With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:

setTimestamp in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The parameter value

cal - The Calendar object the driver will use to construct the timestamp

Throws:

java.sql.SQLException - If a database access error occurs

setNull

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

Sets the designated parameter to SQL NULL. This version of the method setNull should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.

Specified by:

setNull in interface java.sql.PreparedStatement

Parameters:

paramIndex - - The first parameter is 1, the second is 2, ...

sqlType - A value from java.sql.Types

typeName - The fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF

Throws:

java.sql.SQLException - If a database access error occurs

setURL

public void setURL(int parameterIndex,
                   java.net.URL x)
            throws java.sql.SQLException

Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database.

Specified by:

setURL in interface java.sql.PreparedStatement

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The java.net.URL object to be set

Throws:

java.sql.SQLException - If a database access error occurs

getParameterMetaData

public java.sql.ParameterMetaData getParameterMetaData()
                                                throws java.sql.SQLException

Retrieves the number, types and properties of this PreparedStatement object's parameters.

Specified by:

getParameterMetaData in interface java.sql.PreparedStatement

Returns:

ParameterMetaData A ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters

Throws:

java.sql.SQLException - If a database access error occurs

close

public void close()
           throws java.sql.SQLException

Over-ridden to not close the getStatement(). Clears the parameters using clearParameters().

Specified by:

close in interface java.sql.Statement

Overrides:

close in class StatementDecorator

Throws:

java.sql.SQLException - If a database access error occurs

getStatement

public java.sql.PreparedStatement getStatement()

Returns the statement object this class decorates.

Specified by:

getStatement in class StatementDecorator

Returns:

PreparedStatement The value/reference of/to statement

getStatistics

public final Statistics getStatistics()

Returns statistics.

Returns:

Statistics The value/reference of/to statistics.

setStatistics

protected final void setStatistics(Statistics statistics)

Set statistics.

Parameters:

statistics - The value to set.