Package com.gargoylesoftware.base.resource.jdbc

Class PreparedStatementWrapper

java.lang.Object
com.gargoylesoftware.base.resource.jdbc.StatementWrapper
com.gargoylesoftware.base.resource.jdbc.PreparedStatementWrapper
All Implemented Interfaces:
AutoCloseable, PreparedStatement, Statement, Wrapper
Direct Known Subclasses:
CallableStatementWrapper
public class PreparedStatementWrapper extends StatementWrapper implements PreparedStatement
A wrapper for a PreparedStatement
Version:
$Revision: 1.3 $

  • Field Details

  • Constructor Details

    • PreparedStatementWrapper

      public PreparedStatementWrapper(PreparedStatement statement)
      Create a PreparedStatementWrapper
      Parameters:
      statement - The PreparedStatement that we are wrapping

  • Method Details

    • setNull

      public final void setNull(int parameterIndex, int sqlType) throws SQLException
      Sets the designated parameter to SQL NULL.

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

      Specified by:
      setNull in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      sqlType - the SQL type code defined in java.sql.Types
      Throws:
      SQLException - if a database access error occurs

    • setBoolean

      public final void setBoolean(int parameterIndex, boolean x) throws SQLException
      Sets the designated parameter to a Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.
      Specified by:
      setBoolean in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setByte

      public final void setByte(int parameterIndex, byte x) throws SQLException
      Sets the designated parameter to a Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.
      Specified by:
      setByte in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setShort

      public final void setShort(int parameterIndex, short x) throws SQLException
      Sets the designated parameter to a Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.
      Specified by:
      setShort in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setInt

      public final void setInt(int parameterIndex, int x) throws SQLException
      Sets the designated parameter to a Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.
      Specified by:
      setInt in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setLong

      public final void setLong(int parameterIndex, long x) throws SQLException
      Sets the designated parameter to a Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.
      Specified by:
      setLong in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setFloat

      public final void setFloat(int parameterIndex, float x) throws SQLException
      Sets the designated parameter to a Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.
      Specified by:
      setFloat in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setDouble

      public final void setDouble(int parameterIndex, double x) throws SQLException
      Sets the designated parameter to a Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.
      Specified by:
      setDouble in interface PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setBigDecimal

      public final void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException
      Sets the designated parameter to a 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setString

      public final void setString(int parameterIndex, String x) throws SQLException
      Sets the designated parameter to a 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setBytes

      public final void setBytes(int parameterIndex, byte[] x) throws SQLException
      Sets the designated parameter to a 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setDate

      public final void setDate(int parameterIndex, Date x) throws SQLException
      Sets the designated parameter to a invalid input: '<'codeinvalid input: '<'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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setTime

      public final void setTime(int parameterIndex, Time x) throws SQLException
      Sets the designated parameter to a 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setTimestamp

      public final void setTimestamp(int parameterIndex, Timestamp x) throws SQLException
      Sets the designated parameter to a 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the parameter value
      Throws:
      SQLException - if a database access error occurs

    • setAsciiStream

      public final void setAsciiStream(int parameterIndex, InputStream x, int length) throws 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 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:
      SQLException - if a database access error occurs

    • setUnicodeStream

      public final void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException
      Deprecated.
      Sets the designated parameter to the given input stream, which will have the specified number of bytes. 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. The byte format of the Unicode stream must be Java UTF-8, as defined in the Java Virtual Machine Specification.

      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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the java input stream which contains the UNICODE parameter value
      length - the number of bytes in the stream
      Throws:
      SQLException - if a database access error occurs

    • setBinaryStream

      public final void setBinaryStream(int parameterIndex, InputStream x, int length) throws 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 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:
      SQLException - if a database access error occurs

    • setObject

      public final void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws 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 datatabase- specific abstract data types.

      Specified by:
      setObject in interface 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:
      SQLException - if a database access error occurs

    • setObject

      public final void setObject(int parameterIndex, Object x, int targetSqlType) throws 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 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:
      SQLException - if a database access error occurs

    • setObject

      public final void setObject(int parameterIndex, Object x) throws 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, then 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the object containing the input parameter value
      Throws:
      SQLException - if a database access error occurs

    • setCharacterStream

      public final void setCharacterStream(int parameterIndex, Reader reader, int length) throws 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      reader - the java reader which contains the UNICODE data
      length - the number of characters in the stream
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setRef

      public final void setRef(int i, Ref x) throws SQLException
      Sets the designated parameter to the given REF(<structured-type>) value.
      Specified by:
      setRef in interface PreparedStatement
      Parameters:
      i - the first parameter is 1, the second is 2, ...
      x - an SQL REF value
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setBlob

      public final void setBlob(int i, Blob x) throws SQLException
      Sets the designated parameter to the given Blob object.
      Specified by:
      setBlob in interface PreparedStatement
      Parameters:
      i - the first parameter is 1, the second is 2, ...
      x - a Blob object that maps an SQL BLOB value
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setClob

      public final void setClob(int i, Clob x) throws SQLException
      Sets the designated parameter to the given Clob object.
      Specified by:
      setClob in interface PreparedStatement
      Parameters:
      i - the first parameter is 1, the second is 2, ...
      x - a Clob object that maps an SQL CLOB value
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setArray

      public final void setArray(int i, Array x) throws SQLException
      Sets the designated parameter to the given Array object. Sets an Array parameter.
      Specified by:
      setArray in interface PreparedStatement
      Parameters:
      i - the first parameter is 1, the second is 2, ...
      x - an Array object that maps an SQL ARRAY value
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setDate

      public final void setDate(int parameterIndex, Date x, Calendar cal) throws 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 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 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:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setTime

      public final void setTime(int parameterIndex, Time x, Calendar cal) throws 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 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 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:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setTimestamp

      public final void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws 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 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 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:
      SQLException - if a database access error occurs
      Since:
      1.2

    • setNull

      public final void setNull(int paramIndex, int sqlType, String typeName) throws 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 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:
      SQLException - if a database access error occurs
      Since:
      1.2

    • getMetaData

      public final ResultSetMetaData getMetaData() throws SQLException
      Gets the number, types and properties of a ResultSet object's columns.
      Specified by:
      getMetaData in interface PreparedStatement
      Returns:
      the description of a ResultSet object's columns
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.2

    • executeQuery

      public final ResultSet executeQuery() throws SQLException
      Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.
      Specified by:
      executeQuery in interface PreparedStatement
      Returns:
      a ResultSet object that contains the data produced by the query; never null
      Throws:
      SQLException - if a database access error occurs

    • executeUpdate

      public final int executeUpdate() throws SQLException
      Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.
      Specified by:
      executeUpdate in interface PreparedStatement
      Returns:
      either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing
      Throws:
      SQLException - if a database access error occurs

    • clearParameters

      public final void clearParameters() throws SQLException
      Clears the current parameter values immediately.

      In general, parameter values remain in force for repeated use of a statement. 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 PreparedStatement
      Throws:
      SQLException - if a database access error occurs

    • execute

      public final boolean execute() throws SQLException
      Executes any kind of SQL statement. 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.
      Specified by:
      execute in interface PreparedStatement
      Returns:
      Unknown
      Throws:
      SQLException - if a database access error occurs

    • addBatch

      public final void addBatch() throws SQLException
      Adds a set of parameters to this PreparedStatement object's batch of commands.
      Specified by:
      addBatch in interface PreparedStatement
      Throws:
      SQLException - if a database access error occurs

    • setURL

      public void setURL(int parameterIndex, URL x) throws 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 PreparedStatement
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the java.net.URL object to be set
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4

    • getParameterMetaData

      public ParameterMetaData getParameterMetaData() throws SQLException
      Retrieves the number, types and properties of this PreparedStatement object's parameters.
      Specified by:
      getParameterMetaData in interface PreparedStatement
      Returns:
      a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4
      See Also:

    • setNClob

      public void setNClob(int parameterIndex, Reader reader) throws SQLException
      Specified by:
      setNClob in interface PreparedStatement
      Throws:
      SQLException

    • setBlob

      public void setBlob(int parameterIndex, InputStream inputStream) throws SQLException
      Specified by:
      setBlob in interface PreparedStatement
      Throws:
      SQLException

    • setClob

      public void setClob(int parameterIndex, Reader reader) throws SQLException
      Specified by:
      setClob in interface PreparedStatement
      Throws:
      SQLException

    • setNCharacterStream

      public void setNCharacterStream(int parameterIndex, Reader value) throws SQLException
      Specified by:
      setNCharacterStream in interface PreparedStatement
      Throws:
      SQLException

    • setCharacterStream

      public void setCharacterStream(int parameterIndex, Reader reader) throws SQLException
      Specified by:
      setCharacterStream in interface PreparedStatement
      Throws:
      SQLException

    • setBinaryStream

      public void setBinaryStream(int parameterIndex, InputStream x) throws SQLException
      Specified by:
      setBinaryStream in interface PreparedStatement
      Throws:
      SQLException

    • setAsciiStream

      public void setAsciiStream(int parameterIndex, InputStream x) throws SQLException
      Specified by:
      setAsciiStream in interface PreparedStatement
      Throws:
      SQLException

    • setCharacterStream

      public void setCharacterStream(int parameterIndex, Reader reader, long length) throws SQLException
      Specified by:
      setCharacterStream in interface PreparedStatement
      Throws:
      SQLException

    • setBinaryStream

      public void setBinaryStream(int parameterIndex, InputStream x, long length) throws SQLException
      Specified by:
      setBinaryStream in interface PreparedStatement
      Throws:
      SQLException

    • setAsciiStream

      public void setAsciiStream(int parameterIndex, InputStream x, long length) throws SQLException
      Specified by:
      setAsciiStream in interface PreparedStatement
      Throws:
      SQLException

    • setSQLXML

      public void setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException
      Specified by:
      setSQLXML in interface PreparedStatement
      Throws:
      SQLException

    • setNClob

      public void setNClob(int parameterIndex, Reader reader, long length) throws SQLException
      Specified by:
      setNClob in interface PreparedStatement
      Throws:
      SQLException

    • setBlob

      public void setBlob(int parameterIndex, InputStream inputStream, long length) throws SQLException
      Specified by:
      setBlob in interface PreparedStatement
      Throws:
      SQLException

    • setClob

      public void setClob(int parameterIndex, Reader reader, long length) throws SQLException
      Specified by:
      setClob in interface PreparedStatement
      Throws:
      SQLException

    • setNClob

      public void setNClob(int parameterIndex, NClob value) throws SQLException
      Specified by:
      setNClob in interface PreparedStatement
      Throws:
      SQLException

    • setNCharacterStream

      public void setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException
      Specified by:
      setNCharacterStream in interface PreparedStatement
      Throws:
      SQLException

    • setNString

      public void setNString(int parameterIndex, String value) throws SQLException
      Specified by:
      setNString in interface PreparedStatement
      Throws:
      SQLException

    • setRowId

      public void setRowId(int parameterIndex, RowId x) throws SQLException
      Specified by:
      setRowId in interface PreparedStatement
      Throws:
      SQLException