tyrex.resource.jdbc.xa

Class TyrexPreparedStatementImpl

class TyrexPreparedStatementImpl extends TyrexStatementImpl implements PreparedStatement

This class implements java.sql.Statement so that it returned when prepareStatement is called on TyrexConnection object.

The reason for this class is for the method java.sql.Statement#getConnection to return the correct connection.

This class is thread safe.

Author: Riad Mohammed

Constructor Summary
TyrexPreparedStatementImpl(PreparedStatement statement, TyrexConnection connection)
Create the TyrexPreparedStatementImpl with the specified arguments.
Method Summary
voidaddBatch()
Adds a set of parameters to this PreparedStatement object's batch of commands.
voidclearParameters()
Clears the current parameter values immediately.
booleanexecute()
Executes any kind of SQL statement.
ResultSetexecuteQuery()
Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.
intexecuteUpdate()
Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object.
ResultSetMetaDatagetMetaData()
Gets the number, types and properties of a ResultSet object's columns.
ParameterMetaDatagetParameterMetaData()
protected PreparedStatementgetPreparedStatement()
Return the prepared statement.
voidsetArray(int i, Array x)
Sets the designated parameter to the given Array object.
voidsetAsciiStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.
voidsetBigDecimal(int parameterIndex, BigDecimal x)
Sets the designated parameter to a java.math.BigDecimal value.
voidsetBinaryStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.
voidsetBlob(int i, Blob x)
Sets the designated parameter to the given Blob object.
voidsetBoolean(int parameterIndex, boolean x)
Sets the designated parameter to a Java boolean value.
voidsetByte(int parameterIndex, byte x)
Sets the designated parameter to a Java byte value.
voidsetBytes(int parameterIndex, byte[] x)
Sets the designated parameter to a Java array of bytes.
voidsetCharacterStream(int parameterIndex, Reader reader, int length)
Sets the designated parameter to the given Reader object, which is the given number of characters long.
voidsetClob(int i, Clob x)
Sets the designated parameter to the given Clob object.
voidsetDate(int parameterIndex, Date x)
Sets the designated parameter to a value.
voidsetDate(int parameterIndex, Date x, Calendar cal)
Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
voidsetDouble(int parameterIndex, double x)
Sets the designated parameter to a Java double value.
voidsetFloat(int parameterIndex, float x)
Sets the designated parameter to a Java float value.
voidsetInt(int parameterIndex, int x)
Sets the designated parameter to a Java int value.
voidsetLong(int parameterIndex, long x)
Sets the designated parameter to a Java long value.
voidsetNull(int parameterIndex, int sqlType)
Sets the designated parameter to SQL NULL.
voidsetNull(int paramIndex, int sqlType, String typeName)
Sets the designated parameter to SQL NULL.
voidsetObject(int parameterIndex, Object x, int targetSqlType, int scale)

Sets the value of the designated parameter with the given object.

voidsetObject(int parameterIndex, Object x, int targetSqlType)
Sets the value of the designated parameter with the given object.
voidsetObject(int parameterIndex, Object x)

Sets the value of the designated parameter using the given object.

voidsetRef(int i, Ref x)
Sets the designated parameter to the given REF(<structured-type>) value.
voidsetShort(int parameterIndex, short x)
Sets the designated parameter to a Java short value.
voidsetString(int parameterIndex, String x)
Sets the designated parameter to a Java String value.
voidsetTime(int parameterIndex, Time x)
Sets the designated parameter to a java.sql.Time value.
voidsetTime(int parameterIndex, Time x, Calendar cal)
Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
voidsetTimestamp(int parameterIndex, Timestamp x)
Sets the designated parameter to a java.sql.Timestamp value.
voidsetTimestamp(int parameterIndex, Timestamp x, Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
voidsetUnicodeStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.
voidsetURL(int parameterIndex, URL x)

Constructor Detail

TyrexPreparedStatementImpl

TyrexPreparedStatementImpl(PreparedStatement statement, TyrexConnection connection)
Create the TyrexPreparedStatementImpl with the specified arguments.

Parameters: statement the underlying statement connection the connection that created the statement.

Throws: SQLException if there is a problem creating the statement

Method Detail

addBatch

public final void addBatch()
Adds a set of parameters to this PreparedStatement object's batch of commands.

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: Statement#addBatch What Is in the JDBC 2.0 API

clearParameters

public final void clearParameters()
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.

Throws: SQLException if a database access error occurs

execute

public final boolean execute()
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.

Throws: SQLException if a database access error occurs

See Also: Statement#execute

executeQuery

public final ResultSet executeQuery()
Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.

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()
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.

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

getMetaData

public final ResultSetMetaData getMetaData()
Gets the number, types and properties of a ResultSet object's columns.

Returns: the description of a ResultSet object's columns

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getParameterMetaData

public final ParameterMetaData getParameterMetaData()

getPreparedStatement

protected final PreparedStatement getPreparedStatement()
Return the prepared statement.

Returns: the prepared statement.

Throws: SQLException if the prepared statement is closed

setArray

public final void setArray(int i, Array x)
Sets the designated parameter to the given Array object. Sets an Array parameter.

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

See Also: What Is in the JDBC 2.0 API

setAsciiStream

public final void setAsciiStream(int parameterIndex, InputStream x, int length)
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.

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

setBigDecimal

public final void setBigDecimal(int parameterIndex, BigDecimal x)
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.

Parameters: parameterIndex the first parameter is 1, the second is 2, ... x the parameter value

Throws: SQLException if a database access error occurs

setBinaryStream

public final void setBinaryStream(int parameterIndex, InputStream x, int length)
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.

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

setBlob

public final void setBlob(int i, Blob x)
Sets the designated parameter to the given Blob object.

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

See Also: What Is in the JDBC 2.0 API

setBoolean

public final void setBoolean(int parameterIndex, boolean x)
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.

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)
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.

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)
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.

Parameters: parameterIndex the first parameter is 1, the second is 2, ... x the parameter value

Throws: SQLException if a database access error occurs

setCharacterStream

public final void setCharacterStream(int parameterIndex, Reader reader, int length)
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.

Parameters: parameterIndex the first parameter is 1, the second is 2, ... x 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

See Also: What Is in the JDBC 2.0 API

setClob

public final void setClob(int i, Clob x)
Sets the designated parameter to the given Clob object.

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

See Also: What Is in the JDBC 2.0 API

setDate

public final void setDate(int parameterIndex, Date x)
Sets the designated parameter to a value. The driver converts this to an SQL DATE value when it sends it to the database.

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, Calendar cal)
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.

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

See Also: What Is in the JDBC 2.0 API

setDouble

public final void setDouble(int parameterIndex, double x)
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.

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)
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.

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)
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.

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)
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.

Parameters: parameterIndex the first parameter is 1, the second is 2, ... x the parameter value

Throws: SQLException if a database access error occurs

setNull

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

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

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

setNull

public final void setNull(int paramIndex, int sqlType, String typeName)
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.

Parameters: parameterIndex 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

See Also: What Is in the JDBC 2.0 API

setObject

public final void setObject(int parameterIndex, Object x, int targetSqlType, int scale)

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.

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

See Also: Types

setObject

public final void setObject(int parameterIndex, Object x, int targetSqlType)
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.

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)

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.

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

setRef

public final void setRef(int i, Ref x)
Sets the designated parameter to the given REF(<structured-type>) value.

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

See Also: What Is in the JDBC 2.0 API

setShort

public final void setShort(int parameterIndex, short x)
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.

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)
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.

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)
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.

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, Calendar cal)
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.

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

See Also: What Is in the JDBC 2.0 API

setTimestamp

public final void setTimestamp(int parameterIndex, Timestamp x)
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.

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, Calendar cal)
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.

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

See Also: What Is in the JDBC 2.0 API

setUnicodeStream

public final void setUnicodeStream(int parameterIndex, InputStream x, int length)

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.

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

setURL

public final void setURL(int parameterIndex, URL x)
Original code is Copyright (c) 1999-2001, Intalio, Inc. All Rights Reserved. Contributions by MetaBoss team are Copyright (c) 2003-2005, Softaris Pty. Ltd. All Rights Reserved.