|
log4jdbc3 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.log4jdbc.StatementSpy
net.sf.log4jdbc.PreparedStatementSpy
net.sf.log4jdbc.CallableStatementSpy
Wraps a CallableStatement and reports method calls, returns and exceptions.
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
| Field Summary |
| Fields inherited from class net.sf.log4jdbc.PreparedStatementSpy |
argTrace, rdbmsSpecifics, realPreparedStatement |
| Fields inherited from class net.sf.log4jdbc.StatementSpy |
connectionSpy, currentBatch, realStatement |
| Fields inherited from interface java.sql.Statement |
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
| Constructor Summary | |
CallableStatementSpy(String sql,
ConnectionSpy connectionSpy,
CallableStatement realCallableStatement)
Create a CallableStatementSpy to spy upon a CallableStatement. |
|
| Method Summary | |
Array |
getArray(int i)
Retrieves the value of the designated JDBC ARRAY parameter as an
Array object in the Java programming language. |
Array |
getArray(String parameterName)
Retrieves the value of a JDBC ARRAY parameter as an
Array object in the Java programming language. |
BigDecimal |
getBigDecimal(int parameterIndex)
Retrieves the value of the designated 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(int parameterIndex,
int scale)
Retrieves the value of the designated JDBC NUMERIC parameter as a
java.math.BigDecimal object with scale digits to
the right of the decimal point. |
BigDecimal |
getBigDecimal(String parameterName)
Retrieves 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. |
Blob |
getBlob(int i)
Retrieves the value of the designated JDBC BLOB parameter as a
Blob object in the Java programming language. |
Blob |
getBlob(String parameterName)
Retrieves the value of a JDBC BLOB parameter as a
Blob object in the Java programming language. |
boolean |
getBoolean(int parameterIndex)
Retrieves the value of the designated JDBC BIT parameter as a
boolean in the Java programming language. |
boolean |
getBoolean(String parameterName)
Retrieves the value of a JDBC BIT parameter as a
boolean in the Java programming language. |
byte |
getByte(int parameterIndex)
Retrieves the value of the designated JDBC TINYINT parameter
as a byte in the Java programming language. |
byte |
getByte(String parameterName)
Retrieves the value of a JDBC TINYINT parameter as a byte
in the Java programming language. |
byte[] |
getBytes(int parameterIndex)
Retrieves the value of the designated JDBC BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language. |
byte[] |
getBytes(String parameterName)
Retrieves the value of a JDBC BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language. |
String |
getClassType()
Get the type of class being spied upon. |
Clob |
getClob(int i)
Retrieves the value of the designated JDBC CLOB parameter as a
Clob object in the Java programming language. |
Clob |
getClob(String parameterName)
Retrieves the value of a JDBC CLOB parameter as a
Clob object in the Java programming language. |
Date |
getDate(int parameterIndex)
Retrieves the value of the designated JDBC DATE parameter as a
java.sql.Date object. |
Date |
getDate(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date. |
Date |
getDate(String parameterName)
Retrieves the value of a JDBC DATE parameter as a
java.sql.Date object. |
Date |
getDate(String parameterName,
Calendar cal)
Retrieves 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)
Retrieves the value of the designated JDBC DOUBLE parameter as a double
in the Java programming language. |
double |
getDouble(String parameterName)
Retrieves the value of a JDBC DOUBLE parameter as a double
in the Java programming language. |
float |
getFloat(int parameterIndex)
Retrieves the value of the designated JDBC FLOAT parameter
as a float in the Java programming language. |
float |
getFloat(String parameterName)
Retrieves the value of a JDBC FLOAT parameter as a float
in the Java programming language. |
int |
getInt(int parameterIndex)
Retrieves the value of the designated JDBC INTEGER parameter
as an int in the Java programming language. |
int |
getInt(String parameterName)
Retrieves the value of a JDBC INTEGER parameter as an int
in the Java programming language. |
long |
getLong(int parameterIndex)
Retrieves the value of the designated JDBC BIGINT parameter
as a long in the Java programming language. |
long |
getLong(String parameterName)
Retrieves the value of a JDBC BIGINT parameter as a long
in the Java programming language. |
Object |
getObject(int parameterIndex)
Retrieves the value of the designated 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)
Retrieves the value of a parameter as an Object in the Java
programming language. |
Object |
getObject(String parameterName,
Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom
mapping of the parameter value. |
Ref |
getRef(int i)
Retrieves the value of the designated JDBC REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
Ref |
getRef(String parameterName)
Retrieves the value of a JDBC REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
short |
getShort(int parameterIndex)
Retrieves the value of the designated JDBC SMALLINT parameter
as a short in the Java programming language. |
short |
getShort(String parameterName)
Retrieves the value of a JDBC SMALLINT parameter as a short
in the Java programming language. |
String |
getString(int parameterIndex)
Retrieves the value of the designated JDBC CHAR,
VARCHAR, or LONGVARCHAR parameter as a
String in the Java programming language. |
String |
getString(String parameterName)
Retrieves the value of a JDBC CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language. |
Time |
getTime(int parameterIndex)
Retrieves the value of the designated JDBC TIME parameter as a
java.sql.Time object. |
Time |
getTime(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time. |
Time |
getTime(String parameterName)
Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object. |
Time |
getTime(String parameterName,
Calendar cal)
Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time. |
Timestamp |
getTimestamp(int parameterIndex)
Retrieves the value of the designated JDBC TIMESTAMP parameter as a
java.sql.Timestamp object. |
Timestamp |
getTimestamp(int parameterIndex,
Calendar cal)
Retrieves the value of the designated JDBC TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object. |
Timestamp |
getTimestamp(String parameterName)
Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object. |
Timestamp |
getTimestamp(String parameterName,
Calendar cal)
Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object. |
URL |
getURL(int parameterIndex)
Retrieves the value of the designated JDBC DATALINK parameter as a
java.net.URL object. |
URL |
getURL(String parameterName)
Retrieves the value of a JDBC DATALINK parameter as a
java.net.URL 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,
String typeName)
Registers the designated output parameter. |
void |
registerOutParameter(String parameterName,
int sqlType)
Registers the OUT parameter named parameterName to the JDBC type
sqlType. |
void |
registerOutParameter(String parameterName,
int sqlType,
int scale)
Registers the parameter named parameterName to be of JDBC type
sqlType. |
void |
registerOutParameter(String parameterName,
int sqlType,
String typeName)
Registers the designated output parameter. |
protected void |
reportAllReturns(String methodCall,
String msg)
Report (for logging) that a method returned. |
void |
setAsciiStream(String parameterName,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBigDecimal(String parameterName,
BigDecimal x)
Sets the designated parameter to the given java.math.BigDecimal value. |
void |
setBinaryStream(String parameterName,
InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBoolean(String parameterName,
boolean x)
Sets the designated parameter to the given Java boolean value. |
void |
setByte(String parameterName,
byte x)
Sets the designated parameter to the given Java byte value. |
void |
setBytes(String parameterName,
byte[] x)
Sets the designated parameter to the given Java array of bytes. |
void |
setCharacterStream(String parameterName,
Reader reader,
int length)
Sets the designated parameter to the given Reader
object, which is the given number of characters long. |
void |
setDate(String parameterName,
Date x)
Sets the designated parameter to the given java.sql.Date value. |
void |
setDate(String parameterName,
Date x,
Calendar cal)
Sets the designated parameter to the given java.sql.Date value,
using the given Calendar object. |
void |
setDouble(String parameterName,
double x)
Sets the designated parameter to the given Java double value. |
void |
setFloat(String parameterName,
float x)
Sets the designated parameter to the given Java float value. |
void |
setInt(String parameterName,
int x)
Sets the designated parameter to the given Java int value. |
void |
setLong(String parameterName,
long x)
Sets the designated parameter to the given Java long value. |
void |
setNull(String parameterName,
int sqlType)
Sets the designated parameter to SQL NULL. |
void |
setNull(String parameterName,
int sqlType,
String typeName)
Sets the designated parameter to SQL NULL. |
void |
setObject(String parameterName,
Object x)
Sets the value of the designated parameter with the given object. |
void |
setObject(String parameterName,
Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object. |
void |
setObject(String parameterName,
Object x,
int targetSqlType,
int scale)
Sets the value of the designated parameter with the given object. |
void |
setShort(String parameterName,
short x)
Sets the designated parameter to the given Java short value. |
void |
setString(String parameterName,
String x)
Sets the designated parameter to the given Java String value. |
void |
setTime(String parameterName,
Time x)
Sets the designated parameter to the given java.sql.Time value. |
void |
setTime(String parameterName,
Time x,
Calendar cal)
Sets the designated parameter to the given java.sql.Time value,
using the given Calendar object. |
void |
setTimestamp(String parameterName,
Timestamp x)
Sets the designated parameter to the given java.sql.Timestamp value. |
void |
setTimestamp(String parameterName,
Timestamp x,
Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp value,
using the given Calendar object. |
void |
setURL(String parameterName,
URL val)
Sets the designated parameter to the given java.net.URL object. |
boolean |
wasNull()
Retrieves whether the last OUT parameter read had the value of SQL NULL. |
| Methods inherited from class net.sf.log4jdbc.PreparedStatementSpy |
addBatch, argTraceSet, clearParameters, dumpedSql, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, 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, setURL |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface java.sql.PreparedStatement |
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, 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, setURL |
| Constructor Detail |
public CallableStatementSpy(String sql,
ConnectionSpy connectionSpy,
CallableStatement realCallableStatement)
sql - The SQL used for this CallableStatementconnectionSpy - The ConnectionSpy which produced this CallableStatementSpyrealCallableStatement - The real CallableStatement that is being spied upon| Method Detail |
protected void reportAllReturns(String methodCall,
String msg)
StatementSpy
reportAllReturns in class PreparedStatementSpypublic String getClassType()
Spy
getClassType in interface SpygetClassType in class PreparedStatementSpy
public Date getDate(int parameterIndex)
throws SQLException
CallableStatementDATE parameter as a
java.sql.Date object.
getDate in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is null.CallableStatement.setDate(java.lang.String, java.sql.Date)
public Date getDate(int parameterIndex,
Calendar cal)
throws SQLException
CallableStatementDATE 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.
getDate in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the date
NULL, the result
is null.CallableStatement.setDate(java.lang.String, java.sql.Date)
public Ref getRef(String parameterName)
throws SQLException
CallableStatementREF(<structured-type>)
parameter as a Ref object in the Java programming language.
getRef in interface CallableStatementSQLExceptionparameterName - the name of the parameter
Ref object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
public Time getTime(String parameterName)
throws SQLException
CallableStatementTIME parameter as a
java.sql.Time object.
getTime in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is null.CallableStatement.setTime(java.lang.String, java.sql.Time)
public void setTime(String parameterName,
Time x)
throws SQLException
CallableStatementjava.sql.Time value.
The driver converts this
to an SQL TIME value when it sends it to the database.
setTime in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getTime(int)
public Blob getBlob(int i)
throws SQLException
CallableStatementBLOB parameter as a
Blob object in the Java programming language.
getBlob in interface CallableStatementSQLExceptioni - the first parameter is 1, the second is 2, and so on
Blob object in the
Java programming language. If the value was SQL NULL, the value
null is returned.
public Clob getClob(int i)
throws SQLException
CallableStatementCLOB parameter as a
Clob object in the Java programming language.
getClob in interface CallableStatementSQLExceptioni - the first parameter is 1, the second is 2, and
so on
Clob object in the
Java programming language. If the value was SQL NULL, the
value null is returned.
public Array getArray(int i)
throws SQLException
CallableStatementARRAY parameter as an
Array object in the Java programming language.
getArray in interface CallableStatementSQLExceptioni - the first parameter is 1, the second is 2, and
so on
Array object in
the Java programming language. If the value was SQL NULL, the
value null is returned.
public byte[] getBytes(int parameterIndex)
throws SQLException
CallableStatementBINARY or
VARBINARY parameter as an array of byte
values in the Java programming language.
getBytes in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is null.CallableStatement.setBytes(java.lang.String, byte[])
public double getDouble(int parameterIndex)
throws SQLException
CallableStatementDOUBLE parameter as a double
in the Java programming language.
getDouble in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is 0.CallableStatement.setDouble(java.lang.String, double)
public int getInt(int parameterIndex)
throws SQLException
CallableStatementINTEGER parameter
as an int in the Java programming language.
getInt in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is 0.CallableStatement.setInt(java.lang.String, int)
public boolean wasNull()
throws SQLException
CallableStatementNULL. Note that this method should be called only after
calling a getter method; otherwise, there is no value to use in
determining whether it is null or not.
wasNull in interface CallableStatementSQLException
true if the last parameter read was SQL
NULL; false otherwise
public Time getTime(int parameterIndex)
throws SQLException
CallableStatementTIME parameter as a
java.sql.Time object.
getTime in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is null.CallableStatement.setTime(java.lang.String, java.sql.Time)
public Time getTime(int parameterIndex,
Calendar cal)
throws SQLException
CallableStatementTIME 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.
getTime in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the time
NULL, the result
is null.CallableStatement.setTime(java.lang.String, java.sql.Time)
public Timestamp getTimestamp(String parameterName)
throws SQLException
CallableStatementTIMESTAMP parameter as a
java.sql.Timestamp object.
getTimestamp in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is null.CallableStatement.setTimestamp(java.lang.String, java.sql.Timestamp)
public void setTimestamp(String parameterName,
Timestamp x)
throws SQLException
CallableStatementjava.sql.Timestamp value.
The driver
converts this to an SQL TIMESTAMP value when it sends it to the
database.
setTimestamp in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getTimestamp(int)
public String getString(int parameterIndex)
throws SQLException
CallableStatementCHAR,
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.
getString in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result
is null.CallableStatement.setString(java.lang.String, java.lang.String)
public void registerOutParameter(int parameterIndex,
int sqlType)
throws SQLException
CallableStatementparameterIndex 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
CallableStatement.getObject(int) retrieves the value.
registerOutParameter in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - 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.Types
public void registerOutParameter(int parameterIndex,
int sqlType,
int scale)
throws SQLException
CallableStatementparameterIndex 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.
registerOutParameter in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so onsqlType - the 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.Types
public void registerOutParameter(int paramIndex,
int sqlType,
String typeName)
throws SQLException
CallableStatementregisterOutParameter
should be used for a user-defined or REF output parameter. Examples
of user-defined 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-defined 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-defined and REF parameters.
Although it is intended for user-defined and REF parameters,
this method may be used to register a parameter of any JDBC type.
If the parameter does not have a user-defined or REF type, the
typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
registerOutParameter in interface CallableStatementSQLExceptionparamIndex - the first parameter is 1, the second is 2,...sqlType - a value from TypestypeName - the fully-qualified name of an SQL structured typeTypes
public byte getByte(String parameterName)
throws SQLException
CallableStatementTINYINT parameter as a byte
in the Java programming language.
getByte in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is 0.CallableStatement.setByte(java.lang.String, byte)
public double getDouble(String parameterName)
throws SQLException
CallableStatementDOUBLE parameter as a double
in the Java programming language.
getDouble in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL,
the result is 0.CallableStatement.setDouble(java.lang.String, double)
public float getFloat(String parameterName)
throws SQLException
CallableStatementFLOAT parameter as a float
in the Java programming language.
getFloat in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL,
the result is 0.CallableStatement.setFloat(java.lang.String, float)
public int getInt(String parameterName)
throws SQLException
CallableStatementINTEGER parameter as an int
in the Java programming language.
getInt in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL,
the result is 0.CallableStatement.setInt(java.lang.String, int)
public long getLong(String parameterName)
throws SQLException
CallableStatementBIGINT parameter as a long
in the Java programming language.
getLong in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL,
the result is 0.CallableStatement.setLong(java.lang.String, long)
public short getShort(String parameterName)
throws SQLException
CallableStatementSMALLINT parameter as a short
in the Java programming language.
getShort in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is 0.CallableStatement.setShort(java.lang.String, short)
public boolean getBoolean(String parameterName)
throws SQLException
CallableStatementBIT parameter as a
boolean in the Java programming language.
getBoolean in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is false.CallableStatement.setBoolean(java.lang.String, boolean)
public byte[] getBytes(String parameterName)
throws SQLException
CallableStatementBINARY or VARBINARY
parameter as an array of byte values in the Java
programming language.
getBytes in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result is
null.CallableStatement.setBytes(java.lang.String, byte[])
public void setByte(String parameterName,
byte x)
throws SQLException
CallableStatementbyte value.
The driver converts this
to an SQL TINYINT value when it sends it to the database.
setByte in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getByte(int)
public void setDouble(String parameterName,
double x)
throws SQLException
CallableStatementdouble value.
The driver converts this
to an SQL DOUBLE value when it sends it to the database.
setDouble in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getDouble(int)
public void setFloat(String parameterName,
float x)
throws SQLException
CallableStatementfloat value.
The driver converts this
to an SQL FLOAT value when it sends it to the database.
setFloat in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getFloat(int)
public void registerOutParameter(String parameterName,
int sqlType)
throws SQLException
CallableStatementparameterName 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
CallableStatement.getObject(int) retrieves the value.
registerOutParameter in interface CallableStatementSQLExceptionparameterName - the name of the parametersqlType - 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.Types
public void setInt(String parameterName,
int x)
throws SQLException
CallableStatementint value.
The driver converts this
to an SQL INTEGER value when it sends it to the database.
setInt in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getInt(int)
public void setNull(String parameterName,
int sqlType)
throws SQLException
CallableStatementNULL.
Note: You must specify the parameter's SQL type.
setNull in interface CallableStatementSQLExceptionparameterName - the name of the parametersqlType - the SQL type code defined in java.sql.Types
public void registerOutParameter(String parameterName,
int sqlType,
int scale)
throws SQLException
CallableStatementparameterName 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.
registerOutParameter in interface CallableStatementSQLExceptionparameterName - the name of the parametersqlType - 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.Types
public void setLong(String parameterName,
long x)
throws SQLException
CallableStatementlong value.
The driver converts this
to an SQL BIGINT value when it sends it to the database.
setLong in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getLong(int)
public void setShort(String parameterName,
short x)
throws SQLException
CallableStatementshort value.
The driver converts this
to an SQL SMALLINT value when it sends it to the database.
setShort in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getShort(int)
public void setBoolean(String parameterName,
boolean x)
throws SQLException
CallableStatementboolean value.
The driver converts this
to an SQL BIT value when it sends it to the database.
setBoolean in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getBoolean(int)
public void setBytes(String parameterName,
byte[] x)
throws SQLException
CallableStatementVARBINARY or
LONGVARBINARY (depending on the argument's size relative
to the driver's limits on VARBINARY values) when it sends
it to the database.
setBytes in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getBytes(int)
public boolean getBoolean(int parameterIndex)
throws SQLException
CallableStatementBIT parameter as a
boolean in the Java programming language.
getBoolean in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL,
the result is false.CallableStatement.setBoolean(java.lang.String, boolean)
public Timestamp getTimestamp(int parameterIndex)
throws SQLException
CallableStatementTIMESTAMP parameter as a
java.sql.Timestamp object.
getTimestamp in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is null.CallableStatement.setTimestamp(java.lang.String, java.sql.Timestamp)
public void setAsciiStream(String parameterName,
InputStream x,
int length)
throws SQLException
CallableStatementLONGVARCHAR
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.
setAsciiStream in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the Java input stream that contains the ASCII parameter valuelength - the number of bytes in the stream
public void setBinaryStream(String parameterName,
InputStream x,
int length)
throws SQLException
CallableStatementLONGVARBINARY
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.
setBinaryStream in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the java input stream which contains the binary parameter valuelength - the number of bytes in the stream
public void setCharacterStream(String parameterName,
Reader reader,
int length)
throws SQLException
CallableStatementReader
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.
setCharacterStream in interface CallableStatementSQLExceptionparameterName - the name of the parameterreader - the java.io.Reader object that
contains the UNICODE data used as the designated parameterlength - the number of characters in the stream
public Object getObject(String parameterName)
throws SQLException
CallableStatementObject in the Java
programming language. If the value is an SQL NULL, the
driver returns a Java null.
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.
getObject in interface CallableStatementSQLExceptionparameterName - the name of the parameter
java.lang.Object holding the OUT parameter value.Types,
CallableStatement.setObject(java.lang.String, java.lang.Object, int, int)
public void setObject(String parameterName,
Object x)
throws SQLException
CallableStatementObject; 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, 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.
setObject in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the object containing the input parameter valueCallableStatement.getObject(int)
public void setObject(String parameterName,
Object x,
int targetSqlType)
throws SQLException
CallableStatementsetObject
above, except that it assumes a scale of zero.
setObject in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the object containing the input parameter valuetargetSqlType - the SQL type (as defined in java.sql.Types) to be
sent to the databaseCallableStatement.getObject(int)
public void setObject(String parameterName,
Object x,
int targetSqlType,
int scale)
throws SQLException
CallableStatementjava.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.
setObject in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the object containing the input parameter valuetargetSqlType - 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.Types,
CallableStatement.getObject(int)
public Timestamp getTimestamp(int parameterIndex,
Calendar cal)
throws SQLException
CallableStatementTIMESTAMP 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.
getTimestamp in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so oncal - the Calendar object the driver will use
to construct the timestamp
NULL, the result
is null.CallableStatement.setTimestamp(java.lang.String, java.sql.Timestamp)
public Object getObject(String parameterName,
Map map)
throws SQLException
CallableStatementi 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.
getObject in interface CallableStatementSQLExceptionparameterName - the name of the parametermap - the mapping from SQL type names to Java classes
java.lang.Object holding the OUT parameter valueCallableStatement.setObject(java.lang.String, java.lang.Object, int, int)
public Date getDate(String parameterName,
Calendar cal)
throws SQLException
CallableStatementDATE 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.
getDate in interface CallableStatementSQLExceptionparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the date
NULL,
the result is null.CallableStatement.setDate(java.lang.String, java.sql.Date)
public Time getTime(String parameterName,
Calendar cal)
throws SQLException
CallableStatementTIME 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.
getTime in interface CallableStatementSQLExceptionparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the time
NULL, the result is
null.CallableStatement.setTime(java.lang.String, java.sql.Time)
public Timestamp getTimestamp(String parameterName,
Calendar cal)
throws SQLException
CallableStatementTIMESTAMP 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.
getTimestamp in interface CallableStatementSQLExceptionparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the timestamp
NULL, the result is
null.CallableStatement.setTimestamp(java.lang.String, java.sql.Timestamp)
public void setDate(String parameterName,
Date x,
Calendar cal)
throws SQLException
CallableStatementjava.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.
setDate in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the dateCallableStatement.getDate(int)
public void setTime(String parameterName,
Time x,
Calendar cal)
throws SQLException
CallableStatementjava.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.
setTime in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timeCallableStatement.getTime(int)
public void setTimestamp(String parameterName,
Timestamp x,
Calendar cal)
throws SQLException
CallableStatementjava.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.
setTimestamp in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timestampCallableStatement.getTimestamp(int)
public short getShort(int parameterIndex)
throws SQLException
CallableStatementSMALLINT parameter
as a short in the Java programming language.
getShort in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is 0.CallableStatement.setShort(java.lang.String, short)
public long getLong(int parameterIndex)
throws SQLException
CallableStatementBIGINT parameter
as a long in the Java programming language.
getLong in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is 0.CallableStatement.setLong(java.lang.String, long)
public float getFloat(int parameterIndex)
throws SQLException
CallableStatementFLOAT parameter
as a float in the Java programming language.
getFloat in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is 0.CallableStatement.setFloat(java.lang.String, float)
public Ref getRef(int i)
throws SQLException
CallableStatementREF(<structured-type>)
parameter as a Ref object in the Java programming language.
getRef in interface CallableStatementSQLExceptioni - the first parameter is 1, the second is 2,
and so on
Ref object in the
Java programming language. If the value was SQL NULL, the value
null is returned.
public BigDecimal getBigDecimal(int parameterIndex,
int scale)
throws SQLException
CallableStatementNUMERIC parameter as a
java.math.BigDecimal object with scale digits to
the right of the decimal point.
getBigDecimal in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so onscale - the number of digits to the right of the decimal point
NULL, the result
is null.CallableStatement.setBigDecimal(java.lang.String, java.math.BigDecimal)
public URL getURL(int parameterIndex)
throws SQLException
CallableStatementDATALINK parameter as a
java.net.URL object.
getURL in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,...
java.net.URL object that represents the
JDBC DATALINK value used as the designated
parameterCallableStatement.setURL(java.lang.String, java.net.URL)
public BigDecimal getBigDecimal(int parameterIndex)
throws SQLException
CallableStatementNUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.
getBigDecimal in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result is null.CallableStatement.setBigDecimal(java.lang.String, java.math.BigDecimal)
public byte getByte(int parameterIndex)
throws SQLException
CallableStatementTINYINT parameter
as a byte in the Java programming language.
getByte in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
NULL, the result
is 0.CallableStatement.setByte(java.lang.String, byte)
public Object getObject(int parameterIndex)
throws SQLException
CallableStatementObject
in the Java programming language. If the value is an SQL NULL,
the driver returns a Java null.
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.
getObject in interface CallableStatementSQLExceptionparameterIndex - the first parameter is 1, the second is 2,
and so on
java.lang.Object holding the OUT parameter valueTypes,
CallableStatement.setObject(java.lang.String, java.lang.Object, int, int)
public Object getObject(int i,
Map map)
throws SQLException
CallableStatementi 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.
getObject in interface CallableStatementSQLExceptioni - the first parameter is 1, the second is 2, and so onmap - the mapping from SQL type names to Java classes
java.lang.Object holding the OUT parameter valueCallableStatement.setObject(java.lang.String, java.lang.Object, int, int)
public String getString(String parameterName)
throws SQLException
CallableStatementCHAR, 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.
getString in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is null.CallableStatement.setString(java.lang.String, java.lang.String)
public void registerOutParameter(String parameterName,
int sqlType,
String typeName)
throws SQLException
CallableStatementregisterOutParameter
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.
registerOutParameter in interface CallableStatementSQLExceptionparameterName - the name of the parametersqlType - a value from TypestypeName - the fully-qualified name of an SQL structured typeTypes
public void setNull(String parameterName,
int sqlType,
String typeName)
throws SQLException
CallableStatementNULL.
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.
setNull in interface CallableStatementSQLExceptionparameterName - the name of the parametersqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or
SQL REF value
public void setString(String parameterName,
String x)
throws SQLException
CallableStatementString 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.
setString in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getString(int)
public BigDecimal getBigDecimal(String parameterName)
throws SQLException
CallableStatementNUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.
getBigDecimal in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result is null.CallableStatement.setBigDecimal(java.lang.String, java.math.BigDecimal)
public void setBigDecimal(String parameterName,
BigDecimal x)
throws SQLException
CallableStatementjava.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.
setBigDecimal in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getBigDecimal(int, int)
public URL getURL(String parameterName)
throws SQLException
CallableStatementDATALINK parameter as a
java.net.URL object.
getURL in interface CallableStatementSQLExceptionparameterName - the name of the parameter
java.net.URL object in the
Java programming language. If the value was SQL NULL, the
value null is returned.CallableStatement.setURL(java.lang.String, java.net.URL)
public void setURL(String parameterName,
URL val)
throws SQLException
CallableStatementjava.net.URL object.
The driver converts this to an SQL DATALINK value when
it sends it to the database.
setURL in interface CallableStatementSQLExceptionparameterName - the name of the parameterval - the parameter valueCallableStatement.getURL(int)
public Array getArray(String parameterName)
throws SQLException
CallableStatementARRAY parameter as an
Array object in the Java programming language.
getArray in interface CallableStatementSQLExceptionparameterName - the name of the parameter
Array object in
Java programming language. If the value was SQL NULL,
the value null is returned.
public Blob getBlob(String parameterName)
throws SQLException
CallableStatementBLOB parameter as a
Blob object in the Java programming language.
getBlob in interface CallableStatementSQLExceptionparameterName - the name of the parameter
Blob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
public Clob getClob(String parameterName)
throws SQLException
CallableStatementCLOB parameter as a
Clob object in the Java programming language.
getClob in interface CallableStatementSQLExceptionparameterName - the name of the parameter
Clob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.
public Date getDate(String parameterName)
throws SQLException
CallableStatementDATE parameter as a
java.sql.Date object.
getDate in interface CallableStatementSQLExceptionparameterName - the name of the parameter
NULL, the result
is null.CallableStatement.setDate(java.lang.String, java.sql.Date)
public void setDate(String parameterName,
Date x)
throws SQLException
CallableStatementjava.sql.Date value.
The driver converts this
to an SQL DATE value when it sends it to the database.
setDate in interface CallableStatementSQLExceptionparameterName - the name of the parameterx - the parameter valueCallableStatement.getDate(int)
|
log4jdbc3 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||