tyrex.resource.jdbc.xa

Class TyrexCallableStatementImpl

final class TyrexCallableStatementImpl extends TyrexPreparedStatementImpl implements CallableStatement

This class implements java.sql.CallableStatement so that it returned when prepareCall 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
TyrexCallableStatementImpl(CallableStatement statement, TyrexConnection connection)
Create the TyrexCallableStatementImpl with the specified arguments.
Method Summary
ArraygetArray(int i)
Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
ArraygetArray(String parameterName)
BigDecimalgetBigDecimal(int parameterIndex, int scale)
Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.
BigDecimalgetBigDecimal(int parameterIndex)
Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.
BigDecimalgetBigDecimal(String parameterName)
BlobgetBlob(int i)
Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
BlobgetBlob(String parameterName)
booleangetBoolean(int parameterIndex)
Gets the value of a JDBC BIT parameter as a boolean in the Java programming language.
booleangetBoolean(String parameterName)
bytegetByte(int parameterIndex)
Gets the value of a JDBC TINYINT parameter as a byte in the Java programming language.
bytegetByte(String parameterName)
byte[]getBytes(int parameterIndex)
Gets the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
byte[]getBytes(String parameterName)
protected CallableStatementgetCallableStatement()
Return the callable statement.
ClobgetClob(int i)
Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
ClobgetClob(String parameterName)
DategetDate(int parameterIndex)
Gets the value of a JDBC DATE parameter as a java.sql.Date object.
DategetDate(int parameterIndex, Calendar cal)
Gets the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
DategetDate(String parameterName, Calendar cal)
DategetDate(String parameterName)
doublegetDouble(int parameterIndex)
Gets the value of a JDBC DOUBLE parameter as a double in the Java programming language.
doublegetDouble(String parameterName)
floatgetFloat(int parameterIndex)
Gets the value of a JDBC FLOAT parameter as a float in the Java programming language.
floatgetFloat(String parameterName)
intgetInt(int parameterIndex)
Gets the value of a JDBC INTEGER parameter as an int in the Java programming language.
intgetInt(String parameterName)
longgetLong(int parameterIndex)
Gets the value of a JDBC BIGINT parameter as a long in the Java programming language.
longgetLong(String parameterName)
ObjectgetObject(int parameterIndex)
Gets the value of a parameter as an Object in the Java programming language.
ObjectgetObject(int i, Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
ObjectgetObject(String parameterName, Map map)
ObjectgetObject(String parameterName)
RefgetRef(int i)
Gets the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
RefgetRef(String parameterName)
shortgetShort(int parameterIndex)
Gets the value of a JDBC SMALLINT parameter as a short in the Java programming language.
shortgetShort(String parameterName)
StringgetString(int parameterIndex)
Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
StringgetString(String parameterName)
TimegetTime(int parameterIndex)
Get the value of a JDBC TIME parameter as a java.sql.Time object.
TimegetTime(int parameterIndex, Calendar cal)
Gets the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
TimegetTime(String parameterName, Calendar cal)
TimegetTime(String parameterName)
TimestampgetTimestamp(int parameterIndex)
Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
TimestampgetTimestamp(int parameterIndex, Calendar cal)
Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
TimestampgetTimestamp(String parameterName, Calendar cal)
TimestampgetTimestamp(String parameterName)
URLgetURL(int parameterIndex)
URLgetURL(String parameterName)
voidregisterOutParameter(int parameterIndex, int sqlType)
Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.
voidregisterOutParameter(int parameterIndex, int sqlType, int scale)
Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType.
voidregisterOutParameter(int paramIndex, int sqlType, String typeName)
Registers the designated output parameter.
voidregisterOutParameter(String parameterName, int sqlType, int scale)
voidregisterOutParameter(String parameterName, int sqlType, String typeName)
voidregisterOutParameter(String parameterName, int sqlType)
voidsetAsciiStream(String parameterName, InputStream x, int length)
voidsetBigDecimal(String parameterName, BigDecimal x)
voidsetBinaryStream(String parameterName, InputStream x, int length)
voidsetBoolean(String parameterName, boolean x)
voidsetByte(String parameterName, byte x)
voidsetBytes(String parameterName, byte[] x)
voidsetCharacterStream(String parameterName, Reader reader, int length)
voidsetDate(String parameterName, Date x, Calendar cal)
voidsetDate(String parameterName, Date x)
voidsetDouble(String parameterName, double x)
voidsetFloat(String parameterName, float x)
voidsetInt(String parameterName, int x)
voidsetLong(String parameterName, long x)
voidsetNull(String parameterName, int sqlType, String typeName)
voidsetNull(String parameterName, int sqlType)
voidsetObject(String parameterName, Object x, int targetSqlType, int scale)
voidsetObject(String parameterName, Object x, int targetSqlType)
voidsetObject(String parameterName, Object x)
voidsetShort(String parameterName, short x)
voidsetString(String parameterName, String x)
voidsetTime(String parameterName, Time x, Calendar cal)
voidsetTime(String parameterName, Time x)
voidsetTimestamp(String parameterName, Timestamp x, Calendar cal)
voidsetTimestamp(String parameterName, Timestamp x)
voidsetURL(String parameterName, URL val)
booleanwasNull()
Indicates whether or not the last OUT parameter read had the value of SQL NULL.

Constructor Detail

TyrexCallableStatementImpl

TyrexCallableStatementImpl(CallableStatement statement, TyrexConnection connection)
Create the TyrexCallableStatementImpl 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

getArray

public final Array getArray(int i)
Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.

Parameters: i the first parameter is 1, the second is 2, and so on

Returns: the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getArray

public Array getArray(String parameterName)

getBigDecimal

public final BigDecimal getBigDecimal(int parameterIndex, int scale)

Deprecated:

Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on scale the number of digits to the right of the decimal point

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getBigDecimal

public final BigDecimal getBigDecimal(int parameterIndex)
Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value in full precision. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getBigDecimal

public BigDecimal getBigDecimal(String parameterName)

getBlob

public final Blob getBlob(int i)
Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.

Parameters: i the first parameter is 1, the second is 2, and so on

Returns: the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getBlob

public Blob getBlob(String parameterName)

getBoolean

public final boolean getBoolean(int parameterIndex)
Gets the value of a JDBC BIT parameter as a boolean in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is false.

Throws: SQLException if a database access error occurs

getBoolean

public boolean getBoolean(String parameterName)

getByte

public final byte getByte(int parameterIndex)
Gets the value of a JDBC TINYINT parameter as a byte in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

getByte

public byte getByte(String parameterName)

getBytes

public final byte[] getBytes(int parameterIndex)
Gets the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getBytes

public byte[] getBytes(String parameterName)

getCallableStatement

protected final CallableStatement getCallableStatement()
Return the callable statement.

Returns: the callable statement.

Throws: SQLException if the statement is closed.

getClob

public final Clob getClob(int i)
Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.

Parameters: i the first parameter is 1, the second is 2, and so on

Returns: the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getClob

public Clob getClob(String parameterName)

getDate

public final Date getDate(int parameterIndex)
Gets the value of a JDBC DATE parameter as a java.sql.Date object.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getDate

public final Date getDate(int parameterIndex, Calendar cal)
Gets the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on cal the Calendar object the driver will use to construct the date

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getDate

public Date getDate(String parameterName, Calendar cal)

getDate

public Date getDate(String parameterName)

getDouble

public final double getDouble(int parameterIndex)
Gets the value of a JDBC DOUBLE parameter as a double in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

getDouble

public double getDouble(String parameterName)

getFloat

public final float getFloat(int parameterIndex)
Gets the value of a JDBC FLOAT parameter as a float in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

getFloat

public float getFloat(String parameterName)

getInt

public final int getInt(int parameterIndex)
Gets the value of a JDBC INTEGER parameter as an int in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

getInt

public int getInt(String parameterName)

getLong

public final long getLong(int parameterIndex)
Gets the value of a JDBC BIGINT parameter as a long in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

getLong

public long getLong(String parameterName)

getObject

public final Object getObject(int parameterIndex)
Gets the value of a parameter as an Object in the Java programming language.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: A java.lang.Object holding the OUT parameter value.

Throws: SQLException if a database access error occurs

See Also: Types

getObject

public final Object getObject(int i, Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

Parameters: i the first parameter is 1, the second is 2, and so on map the mapping from SQL type names to Java classes

Returns: a java.lang.Object holding the OUT parameter value

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getObject

public Object getObject(String parameterName, Map map)

getObject

public Object getObject(String parameterName)

getRef

public final Ref getRef(int i)
Gets the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.

Parameters: i the first parameter is 1, the second is 2, and so on

Returns: the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: What Is in the JDBC 2.0 API

getRef

public Ref getRef(String parameterName)

getShort

public final short getShort(int parameterIndex)
Gets the value of a JDBC SMALLINT parameter as a short in the Java programming language.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

getShort

public short getShort(String parameterName)

getString

public final String getString(int parameterIndex)
Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC CHAR, the String object returned has exactly the same value the JDBC CHAR value had in the database, including any padding added by the database.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getString

public String getString(String parameterName)

getTime

public final Time getTime(int parameterIndex)
Get the value of a JDBC TIME parameter as a java.sql.Time object.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getTime

public final Time getTime(int parameterIndex, Calendar cal)
Gets the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on cal the Calendar object the driver will use to construct the time

Returns: the parameter value; if the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getTime

public Time getTime(String parameterName, Calendar cal)

getTime

public Time getTime(String parameterName)

getTimestamp

public final Timestamp getTimestamp(int parameterIndex)
Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getTimestamp

public final Timestamp getTimestamp(int parameterIndex, Calendar cal)
Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object. With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on cal the Calendar object the driver will use to construct the timestamp

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getTimestamp

public Timestamp getTimestamp(String parameterName, Calendar cal)

getTimestamp

public Timestamp getTimestamp(String parameterName)

getURL

public URL getURL(int parameterIndex)

getURL

public URL getURL(String parameterName)

registerOutParameter

public final void registerOutParameter(int parameterIndex, int sqlType)
Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method TyrexCallableStatementImpl retrieves the value.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on sqlType the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version of registerOutParameter that accepts a scale value should be used.

Throws: SQLException if a database access error occurs

See Also: Types

registerOutParameter

public final void registerOutParameter(int parameterIndex, int sqlType, int scale)
Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on sqlType SQL type code defined by java.sql.Types. scale the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws: SQLException if a database access error occurs

See Also: Types

registerOutParameter

public final void registerOutParameter(int paramIndex, int sqlType, String typeName)
Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types. Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getXXX method whose Java type XXX corresponds to the parameter's registered SQL type.

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 structured type

Throws: SQLException if a database access error occurs

Since: 1.2

See Also: Types What Is in the JDBC 2.0 API

registerOutParameter

public void registerOutParameter(String parameterName, int sqlType, int scale)

registerOutParameter

public void registerOutParameter(String parameterName, int sqlType, String typeName)

registerOutParameter

public void registerOutParameter(String parameterName, int sqlType)

setAsciiStream

public void setAsciiStream(String parameterName, InputStream x, int length)

setBigDecimal

public void setBigDecimal(String parameterName, BigDecimal x)

setBinaryStream

public void setBinaryStream(String parameterName, InputStream x, int length)

setBoolean

public void setBoolean(String parameterName, boolean x)

setByte

public void setByte(String parameterName, byte x)

setBytes

public void setBytes(String parameterName, byte[] x)

setCharacterStream

public void setCharacterStream(String parameterName, Reader reader, int length)

setDate

public void setDate(String parameterName, Date x, Calendar cal)

setDate

public void setDate(String parameterName, Date x)

setDouble

public void setDouble(String parameterName, double x)

setFloat

public void setFloat(String parameterName, float x)

setInt

public void setInt(String parameterName, int x)

setLong

public void setLong(String parameterName, long x)

setNull

public void setNull(String parameterName, int sqlType, String typeName)

setNull

public void setNull(String parameterName, int sqlType)

setObject

public void setObject(String parameterName, Object x, int targetSqlType, int scale)

setObject

public void setObject(String parameterName, Object x, int targetSqlType)

setObject

public void setObject(String parameterName, Object x)

setShort

public void setShort(String parameterName, short x)

setString

public void setString(String parameterName, String x)

setTime

public void setTime(String parameterName, Time x, Calendar cal)

setTime

public void setTime(String parameterName, Time x)

setTimestamp

public void setTimestamp(String parameterName, Timestamp x, Calendar cal)

setTimestamp

public void setTimestamp(String parameterName, Timestamp x)

setURL

public void setURL(String parameterName, URL val)

wasNull

public final boolean wasNull()
Indicates whether or not the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getXXX method; otherwise, there is no value to use in determining whether it is null or not.

Returns: true if the last parameter read was SQL NULL; false otherwise

Throws: SQLException if a database access error occurs

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.