tyrex.resource.jdbc.xa
Class TyrexCallableStatementImpl

java.lang.Object
  |
  +--tyrex.resource.jdbc.xa.TyrexStatementImpl
        |
        +--tyrex.resource.jdbc.xa.TyrexPreparedStatementImpl
              |
              +--tyrex.resource.jdbc.xa.TyrexCallableStatementImpl
All Implemented Interfaces:
java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement

final class TyrexCallableStatementImpl
extends TyrexPreparedStatementImpl
implements java.sql.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
(package private) TyrexCallableStatementImpl(java.sql.CallableStatement statement, TyrexConnection connection)
          Create the TyrexCallableStatementImpl with the specified arguments.
 
Method Summary
 java.sql.Array getArray(int i)
          Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
 java.math.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.
 java.math.BigDecimal getBigDecimal(int parameterIndex, int scale)
          Deprecated.  
 java.sql.Blob getBlob(int i)
          Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
 boolean getBoolean(int parameterIndex)
          Gets the value of a JDBC BIT parameter as a boolean in the Java programming language.
 byte getByte(int parameterIndex)
          Gets the value of a JDBC TINYINT parameter as a byte in the Java programming language.
 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.
protected  java.sql.CallableStatement getCallableStatement()
          Return the callable statement.
 java.sql.Clob getClob(int i)
          Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
 java.sql.Date getDate(int parameterIndex)
          Gets the value of a JDBC DATE parameter as a java.sql.Date object.
 java.sql.Date getDate(int parameterIndex, java.util.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.
 double getDouble(int parameterIndex)
          Gets the value of a JDBC DOUBLE parameter as a double in the Java programming language.
 float getFloat(int parameterIndex)
          Gets the value of a JDBC FLOAT parameter as a float in the Java programming language.
 int getInt(int parameterIndex)
          Gets the value of a JDBC INTEGER parameter as an int in the Java programming language.
 long getLong(int parameterIndex)
          Gets the value of a JDBC BIGINT parameter as a long in the Java programming language.
 java.lang.Object getObject(int parameterIndex)
          Gets the value of a parameter as an Object in the Java programming language.
 java.lang.Object getObject(int i, java.util.Map map)
          Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
 java.sql.Ref getRef(int i)
          Gets the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
 short getShort(int parameterIndex)
          Gets the value of a JDBC SMALLINT parameter as a short in the Java programming language.
 java.lang.String getString(int parameterIndex)
          Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
 java.sql.Time getTime(int parameterIndex)
          Get the value of a JDBC TIME parameter as a java.sql.Time object.
 java.sql.Time getTime(int parameterIndex, java.util.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.
 java.sql.Timestamp getTimestamp(int parameterIndex)
          Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
 java.sql.Timestamp getTimestamp(int parameterIndex, java.util.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.
 void registerOutParameter(int parameterIndex, int sqlType)
          Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.
 void registerOutParameter(int parameterIndex, int sqlType, int scale)
          Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType.
 void registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName)
          Registers the designated output parameter.
 boolean wasNull()
          Indicates whether or not the last OUT parameter read had the value of SQL NULL.
 
Methods inherited from class tyrex.resource.jdbc.xa.TyrexPreparedStatementImpl
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getPreparedStatement, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream
 
Methods inherited from class tyrex.resource.jdbc.xa.TyrexStatementImpl
addBatch, cancel, clearBatch, clearWarnings, close, closeResultSet, execute, executeBatch, executeQuery, executeUpdate, finalize, getConnection, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetType, getStatement, getUpdateCount, getWarnings, resultSetIsClosed, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout, setResultSet
 
Methods inherited from class java.lang.Object
, clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream
 
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, executeBatch, executeQuery, executeUpdate, getConnection, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

Constructor Detail

TyrexCallableStatementImpl

TyrexCallableStatementImpl(java.sql.CallableStatement statement,
                           TyrexConnection connection)
                     throws java.sql.SQLException
Create the TyrexCallableStatementImpl with the specified arguments.
Parameters:
statement - the underlying statement
connection - the connection that created the statement.
Throws:
java.sql.SQLException - if there is a problem creating the statement
Method Detail

registerOutParameter

public final void registerOutParameter(int parameterIndex,
                                       int sqlType)
                                throws java.sql.SQLException
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 getObject(int) retrieves the value.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
See Also:
Types

registerOutParameter

public final void registerOutParameter(int parameterIndex,
                                       int sqlType,
                                       int scale)
                                throws java.sql.SQLException
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.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
See Also:
Types

wasNull

public final boolean wasNull()
                      throws java.sql.SQLException
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.
Specified by:
wasNull in interface java.sql.CallableStatement
Returns:
true if the last parameter read was SQL NULL; false otherwise
Throws:
java.sql.SQLException - if a database access error occurs

getString

public final java.lang.String getString(int parameterIndex)
                                 throws java.sql.SQLException
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.

Specified by:
getString in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getBoolean

public final boolean getBoolean(int parameterIndex)
                         throws java.sql.SQLException
Gets the value of a JDBC BIT parameter as a boolean in the Java programming language.
Specified by:
getBoolean in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getByte

public final byte getByte(int parameterIndex)
                   throws java.sql.SQLException
Gets the value of a JDBC TINYINT parameter as a byte in the Java programming language.
Specified by:
getByte in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getShort

public final short getShort(int parameterIndex)
                     throws java.sql.SQLException
Gets the value of a JDBC SMALLINT parameter as a short in the Java programming language.
Specified by:
getShort in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getInt

public final int getInt(int parameterIndex)
                 throws java.sql.SQLException
Gets the value of a JDBC INTEGER parameter as an int in the Java programming language.
Specified by:
getInt in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getLong

public final long getLong(int parameterIndex)
                   throws java.sql.SQLException
Gets the value of a JDBC BIGINT parameter as a long in the Java programming language.
Specified by:
getLong in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getFloat

public final float getFloat(int parameterIndex)
                     throws java.sql.SQLException
Gets the value of a JDBC FLOAT parameter as a float in the Java programming language.
Specified by:
getFloat in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getDouble

public final double getDouble(int parameterIndex)
                       throws java.sql.SQLException
Gets the value of a JDBC DOUBLE parameter as a double in the Java programming language.
Specified by:
getDouble in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getBigDecimal

public final java.math.BigDecimal getBigDecimal(int parameterIndex,
                                                int scale)
                                         throws java.sql.SQLException
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.
Specified by:
getBigDecimal in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getBytes

public final byte[] getBytes(int parameterIndex)
                      throws java.sql.SQLException
Gets the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
Specified by:
getBytes in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getDate

public final java.sql.Date getDate(int parameterIndex)
                            throws java.sql.SQLException
Gets the value of a JDBC DATE parameter as a java.sql.Date object.
Specified by:
getDate in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getTime

public final java.sql.Time getTime(int parameterIndex)
                            throws java.sql.SQLException
Get the value of a JDBC TIME parameter as a java.sql.Time object.
Specified by:
getTime in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getTimestamp

public final java.sql.Timestamp getTimestamp(int parameterIndex)
                                      throws java.sql.SQLException
Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
Specified by:
getTimestamp in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getObject

public final java.lang.Object getObject(int parameterIndex)
                                 throws java.sql.SQLException
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.

Specified by:
getObject in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
See Also:
Types

getBigDecimal

public final java.math.BigDecimal getBigDecimal(int parameterIndex)
                                         throws java.sql.SQLException
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.
Specified by:
getBigDecimal in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getObject

public final java.lang.Object getObject(int i,
                                        java.util.Map map)
                                 throws java.sql.SQLException
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.

Specified by:
getObject in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getRef

public final java.sql.Ref getRef(int i)
                          throws java.sql.SQLException
Gets the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
Specified by:
getRef in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getBlob

public final java.sql.Blob getBlob(int i)
                            throws java.sql.SQLException
Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
Specified by:
getBlob in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getClob

public final java.sql.Clob getClob(int i)
                            throws java.sql.SQLException
Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
Specified by:
getClob in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getArray

public final java.sql.Array getArray(int i)
                              throws java.sql.SQLException
Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
Specified by:
getArray in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getDate

public final java.sql.Date getDate(int parameterIndex,
                                   java.util.Calendar cal)
                            throws java.sql.SQLException
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.
Specified by:
getDate in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getTime

public final java.sql.Time getTime(int parameterIndex,
                                   java.util.Calendar cal)
                            throws java.sql.SQLException
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.
Specified by:
getTime in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

getTimestamp

public final java.sql.Timestamp getTimestamp(int parameterIndex,
                                             java.util.Calendar cal)
                                      throws java.sql.SQLException
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.
Specified by:
getTimestamp in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs

registerOutParameter

public final void registerOutParameter(int paramIndex,
                                       int sqlType,
                                       java.lang.String typeName)
                                throws java.sql.SQLException
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.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
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:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
Types, What Is in the JDBC 2.0 API

getCallableStatement

protected final java.sql.CallableStatement getCallableStatement()
                                                         throws java.sql.SQLException
Return the callable statement.
Returns:
the callable statement.
Throws:
java.sql.SQLException - if the statement is closed.


Intalio Inc. (C) 1999-2001. All rights reserved.