tyrex.resource.jdbc.xa
final class TyrexCallableStatementImpl extends TyrexPreparedStatementImpl implements CallableStatement
The reason for this class is for the method java.sql.Statement#getConnection to return the correct connection.
This class is thread safe.
Constructor Summary | |
---|---|
TyrexCallableStatementImpl(CallableStatement statement, TyrexConnection connection)
Create the TyrexCallableStatementImpl with the
specified arguments.
|
Method Summary | |
---|---|
Array | getArray(int i)
Gets the value of a JDBC ARRAY parameter as an
Array object in the Java programming language. |
Array | getArray(String parameterName) |
BigDecimal | getBigDecimal(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. |
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. |
BigDecimal | getBigDecimal(String parameterName) |
Blob | getBlob(int i)
Gets the value of a JDBC BLOB parameter as a
Blob object in the Java programming language. |
Blob | getBlob(String parameterName) |
boolean | getBoolean(int parameterIndex)
Gets the value of a JDBC BIT parameter as a boolean
in the Java programming language. |
boolean | getBoolean(String parameterName) |
byte | getByte(int parameterIndex)
Gets the value of a JDBC TINYINT parameter as a byte
in the Java programming language. |
byte | getByte(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 CallableStatement | getCallableStatement()
Return the callable statement.
|
Clob | getClob(int i)
Gets the value of a JDBC CLOB parameter as a
Clob object in the Java programming language. |
Clob | getClob(String parameterName) |
Date | getDate(int parameterIndex)
Gets the value of a JDBC DATE parameter as a
java.sql.Date object. |
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.
|
Date | getDate(String parameterName, Calendar cal) |
Date | getDate(String parameterName) |
double | getDouble(int parameterIndex)
Gets the value of a JDBC DOUBLE parameter as a double
in the Java programming language. |
double | getDouble(String parameterName) |
float | getFloat(int parameterIndex)
Gets the value of a JDBC FLOAT parameter as a float
in the Java programming language. |
float | getFloat(String parameterName) |
int | getInt(int parameterIndex)
Gets the value of a JDBC INTEGER parameter as an int
in the Java programming language. |
int | getInt(String parameterName) |
long | getLong(int parameterIndex)
Gets the value of a JDBC BIGINT parameter as a long
in the Java programming language. |
long | getLong(String parameterName) |
Object | getObject(int parameterIndex)
Gets the value of a parameter as an Object in the Java
programming language.
|
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.
|
Object | getObject(String parameterName, Map map) |
Object | getObject(String parameterName) |
Ref | getRef(int i)
Gets the value of a JDBC REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
Ref | getRef(String parameterName) |
short | getShort(int parameterIndex)
Gets the value of a JDBC SMALLINT parameter as a short
in the Java programming language. |
short | getShort(String parameterName) |
String | getString(int parameterIndex)
Retrieves the value of a JDBC CHAR , VARCHAR ,
or LONGVARCHAR parameter as a String in
the Java programming language.
|
String | getString(String parameterName) |
Time | getTime(int parameterIndex)
Get the value of a JDBC TIME parameter as a
java.sql.Time object. |
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.
|
Time | getTime(String parameterName, Calendar cal) |
Time | getTime(String parameterName) |
Timestamp | getTimestamp(int parameterIndex)
Gets the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object. |
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.
|
Timestamp | getTimestamp(String parameterName, Calendar cal) |
Timestamp | getTimestamp(String parameterName) |
URL | getURL(int parameterIndex) |
URL | getURL(String parameterName) |
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, String typeName)
Registers the designated output parameter. |
void | registerOutParameter(String parameterName, int sqlType, int scale) |
void | registerOutParameter(String parameterName, int sqlType, String typeName) |
void | registerOutParameter(String parameterName, int sqlType) |
void | setAsciiStream(String parameterName, InputStream x, int length) |
void | setBigDecimal(String parameterName, BigDecimal x) |
void | setBinaryStream(String parameterName, InputStream x, int length) |
void | setBoolean(String parameterName, boolean x) |
void | setByte(String parameterName, byte x) |
void | setBytes(String parameterName, byte[] x) |
void | setCharacterStream(String parameterName, Reader reader, int length) |
void | setDate(String parameterName, Date x, Calendar cal) |
void | setDate(String parameterName, Date x) |
void | setDouble(String parameterName, double x) |
void | setFloat(String parameterName, float x) |
void | setInt(String parameterName, int x) |
void | setLong(String parameterName, long x) |
void | setNull(String parameterName, int sqlType, String typeName) |
void | setNull(String parameterName, int sqlType) |
void | setObject(String parameterName, Object x, int targetSqlType, int scale) |
void | setObject(String parameterName, Object x, int targetSqlType) |
void | setObject(String parameterName, Object x) |
void | setShort(String parameterName, short x) |
void | setString(String parameterName, String x) |
void | setTime(String parameterName, Time x, Calendar cal) |
void | setTime(String parameterName, Time x) |
void | setTimestamp(String parameterName, Timestamp x, Calendar cal) |
void | setTimestamp(String parameterName, Timestamp x) |
void | setURL(String parameterName, URL val) |
boolean | wasNull()
Indicates whether or not the last OUT parameter read had the value of
SQL NULL . |
Parameters: statement the underlying statement connection the connection that created the statement.
Throws: SQLException if there is a problem creating the statement
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
Deprecated:
Gets the value of a JDBCNUMERIC
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
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
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
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
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
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
Returns: the callable statement.
Throws: SQLException if the statement is closed.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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