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:

java.lang.AutoCloseable, java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper

Direct Known Subclasses:

CallableStatementWrapper

public class PreparedStatementWrapper
extends StatementWrapper
implements java.sql.PreparedStatement

A wrapper for a PreparedStatement

Version:

$Revision: 1.3 $

Field Summary

Fields

Modifier and Type	Field and Description
private java.sql.PreparedStatement	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

Constructors

Constructor and Description
PreparedStatementWrapper(java.sql.PreparedStatement statement) Create a PreparedStatementWrapper

Method Summary

Modifier and Type	Method and Description
void	addBatch() Adds a set of parameters to this PreparedStatement object's batch of commands.
void	clearParameters() Clears the current parameter values immediately.
boolean	execute() Executes any kind of SQL statement.
java.sql.ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.
int	executeUpdate() Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object.
java.sql.ResultSetMetaData	getMetaData() Gets the number, types and properties of a ResultSet object's columns.
java.sql.ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters.
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)
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	setAsciiStream(int parameterIndex, java.io.InputStream x, long length)
void	setBigDecimal(int parameterIndex, java.math.BigDecimal x) Sets the designated parameter to a java.math.BigDecimal value.
void	setBinaryStream(int parameterIndex, java.io.InputStream x)
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	setBinaryStream(int parameterIndex, java.io.InputStream x, long length)
void	setBlob(int i, java.sql.Blob x) Sets the designated parameter to the given Blob object.
void	setBlob(int parameterIndex, java.io.InputStream inputStream)
void	setBlob(int parameterIndex, java.io.InputStream inputStream, long length)
void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to a Java boolean value.
void	setByte(int parameterIndex, byte x) Sets the designated parameter to a Java byte value.
void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter to a Java array of bytes.
void	setCharacterStream(int parameterIndex, java.io.Reader reader)
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	setCharacterStream(int parameterIndex, java.io.Reader reader, long length)
void	setClob(int i, java.sql.Clob x) Sets the designated parameter to the given Clob object.
void	setClob(int parameterIndex, java.io.Reader reader)
void	setClob(int parameterIndex, java.io.Reader reader, long length)
void	setDate(int parameterIndex, java.sql.Date x) Sets the designated parameter to a 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 a Java double value.
void	setFloat(int parameterIndex, float x) Sets the designated parameter to a Java float value.
void	setInt(int parameterIndex, int x) Sets the designated parameter to a Java int value.
void	setLong(int parameterIndex, long x) Sets the designated parameter to a Java long value.
void	setNCharacterStream(int parameterIndex, java.io.Reader value)
void	setNCharacterStream(int parameterIndex, java.io.Reader value, long length)
void	setNClob(int parameterIndex, java.sql.NClob value)
void	setNClob(int parameterIndex, java.io.Reader reader)
void	setNClob(int parameterIndex, java.io.Reader reader, long length)
void	setNString(int parameterIndex, java.lang.String 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(<structured-type>) value.
void	setRowId(int parameterIndex, java.sql.RowId x)
void	setShort(int parameterIndex, short x) Sets the designated parameter to a Java short value.
void	setSQLXML(int parameterIndex, java.sql.SQLXML xmlObject)
void	setString(int parameterIndex, java.lang.String x) Sets the designated parameter to a Java String value.
void	setTime(int parameterIndex, java.sql.Time x) Sets the designated parameter to a 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 a 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 com.gargoylesoftware.base.resource.jdbc.StatementWrapper

addBatch, cancel, checkIsOpen, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getDelegate, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isWrapperFor, setConnection, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, unwrap, wrapResultSet

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

executeLargeUpdate, setObject, setObject

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

delegate_

private final java.sql.PreparedStatement delegate_

Constructor Detail

PreparedStatementWrapper

public PreparedStatementWrapper(java.sql.PreparedStatement statement)

Create a PreparedStatementWrapper

Parameters:

statement - The PreparedStatement that we are wrapping

Method Detail

setNull

public final 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 final void setBoolean(int parameterIndex,
                             boolean x)
                      throws java.sql.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 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 final void setByte(int parameterIndex,
                          byte x)
                   throws java.sql.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 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 final void setShort(int parameterIndex,
                           short x)
                    throws java.sql.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 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 final void setInt(int parameterIndex,
                         int x)
                  throws java.sql.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 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 final void setLong(int parameterIndex,
                          long x)
                   throws java.sql.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 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 final void setFloat(int parameterIndex,
                           float x)
                    throws java.sql.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 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 final void setDouble(int parameterIndex,
                            double x)
                     throws java.sql.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 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 final void setBigDecimal(int parameterIndex,
                                java.math.BigDecimal x)
                         throws java.sql.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 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 final void setString(int parameterIndex,
                            java.lang.String x)
                     throws java.sql.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 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 final void setBytes(int parameterIndex,
                           byte[] x)
                    throws java.sql.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 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 final void setDate(int parameterIndex,
                          java.sql.Date x)
                   throws java.sql.SQLException

Sets the designated parameter to a 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 final void setTime(int parameterIndex,
                          java.sql.Time x)
                   throws java.sql.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 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 final void setTimestamp(int parameterIndex,
                               java.sql.Timestamp x)
                        throws java.sql.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 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 final 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

public final 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. 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 java.sql.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:

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

setBinaryStream

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

setObject

public final 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 datatabase- 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 final 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 final 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, 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 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

setCharacterStream

public final 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 reader which contains the UNICODE data

length - the number of characters in the stream

Throws:

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

Since:

1.2

setRef

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

Sets the designated parameter to the given REF(<structured-type>) value.

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

Since:

1.2

setBlob

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

Sets the designated parameter to the given Blob object.

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

Since:

1.2

setClob

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

Sets the designated parameter to the given Clob object.

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

Since:

1.2

setArray

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

Sets the designated parameter to the given Array object. Sets an Array parameter.

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

Since:

1.2

setDate

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

Since:

1.2

setTime

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

Since:

1.2

setTimestamp

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

Since:

1.2

setNull

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

Since:

1.2

getMetaData

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

Gets the number, types and properties of a ResultSet object's columns.

Specified by:

getMetaData in interface java.sql.PreparedStatement

Returns:

the description of a ResultSet object's columns

Throws:

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

Since:

1.2

executeQuery

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

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

Specified by:

executeQuery in interface java.sql.PreparedStatement

Returns:

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

Throws:

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

executeUpdate

public final int executeUpdate()
                        throws java.sql.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 java.sql.PreparedStatement

Returns:

either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing

Throws:

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

clearParameters

public final void clearParameters()
                           throws java.sql.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 java.sql.PreparedStatement

Throws:

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

execute

public final boolean execute()
                      throws java.sql.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 java.sql.PreparedStatement

Returns:

Unknown

Throws:

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

addBatch

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

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

Since:

1.4

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:

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

Since:

1.4

See Also:

ParameterMetaData

setNClob

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

Specified by:

setNClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBlob

public void setBlob(int parameterIndex,
                    java.io.InputStream inputStream)
             throws java.sql.SQLException

Specified by:

setBlob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setClob

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

Specified by:

setClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
                                java.io.Reader value)
                         throws java.sql.SQLException

Specified by:

setNCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setCharacterStream

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

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBinaryStream

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

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setAsciiStream

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

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setCharacterStream

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

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBinaryStream

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

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setAsciiStream

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

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setSQLXML

public void setSQLXML(int parameterIndex,
                      java.sql.SQLXML xmlObject)
               throws java.sql.SQLException

Specified by:

setSQLXML in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNClob

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

Specified by:

setNClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBlob

public void setBlob(int parameterIndex,
                    java.io.InputStream inputStream,
                    long length)
             throws java.sql.SQLException

Specified by:

setBlob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setClob

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

Specified by:

setClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNClob

public void setNClob(int parameterIndex,
                     java.sql.NClob value)
              throws java.sql.SQLException

Specified by:

setNClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
                                java.io.Reader value,
                                long length)
                         throws java.sql.SQLException

Specified by:

setNCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNString

public void setNString(int parameterIndex,
                       java.lang.String value)
                throws java.sql.SQLException

Specified by:

setNString in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setRowId

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

Specified by:

setRowId in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException