|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.gargoylesoftware.base.resource.jdbc.StatementWrapper com.gargoylesoftware.base.resource.jdbc.PreparedStatementWrapper com.gargoylesoftware.base.resource.jdbc.CallableStatementWrapper
The interface used to execute SQL stored procedures. JDBC provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.
{?= call <procedure-name>[<arg1>,<arg2>, ...]} {call <procedure-name>[<arg1>,<arg2>, ...]}
IN parameter values are set using the set methods inherited from
PreparedStatement. The type of all OUT parameters must be registered prior
to executing the stored procedure; their values are retrieved after
execution via the get
methods provided here.
A CallableStatement
can return one ResultSet or multiple ResultSet
objects. Multiple ResultSet
objects are handled using
operations inherited from Statement.
For maximum portability, a call's ResultSet
objects and update
counts should be processed prior to getting the values of output parameters.
Methods that are new in the JDBC 2.0 API are marked "Since 1.2."
Field Summary |
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 | |
CallableStatementWrapper(CallableStatement statement)
Create a wrapper |
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)
Retrieves the value of a JDBC ARRAY parameter as an
Array object in the Java programming language. |
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(int parameterIndex,
int scale)
Deprecated. |
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)
Gets the value of a 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)
Gets the value of a 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)
Gets the value of a 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)
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)
Retrieves the value of a JDBC BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language. |
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)
Retrieves the value of a JDBC CLOB parameter as a
Clob object in the Java programming language. |
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)
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)
Gets the value of a 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)
Gets the value of a 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)
Gets the value of a 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)
Gets the value of a 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)
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)
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)
Gets the value of a 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)
Gets the value of a 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 a 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)
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)
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)
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)
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. |
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()
Indicates whether or not the last OUT parameter read had the value of SQL NULL . |
Methods inherited from class com.gargoylesoftware.base.resource.jdbc.PreparedStatementWrapper |
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 |
Methods inherited from class com.gargoylesoftware.base.resource.jdbc.StatementWrapper |
addBatch, cancel, checkIsOpen, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getDelegate, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, setConnection, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout, wrapResultSet |
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 CallableStatementWrapper(CallableStatement statement)
statement
- The statement that is being wrappedMethod Detail |
public final String getString(int parameterIndex) throws SQLException
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.
getString
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is null
.
SQLException
- if a database access error occurspublic final boolean getBoolean(int parameterIndex) throws SQLException
BIT
parameter as a boolean
in the Java programming language.
getBoolean
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is false
.
SQLException
- if a database access error occurspublic final byte getByte(int parameterIndex) throws SQLException
TINYINT
parameter as a byte
in the Java programming language.
getByte
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is 0.
SQLException
- if a database access error occurspublic final short getShort(int parameterIndex) throws SQLException
SMALLINT
parameter as a short
in the Java programming language.
getShort
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is 0.
SQLException
- if a database access error occurspublic final int getInt(int parameterIndex) throws SQLException
INTEGER
parameter as an int
in the Java programming language.
getInt
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is 0.
SQLException
- if a database access error occurspublic final long getLong(int parameterIndex) throws SQLException
BIGINT
parameter as a long
in the Java programming language.
getLong
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is 0.
SQLException
- if a database access error occurspublic final float getFloat(int parameterIndex) throws SQLException
FLOAT
parameter as a float
in the Java programming language.
getFloat
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is 0.
SQLException
- if a database access error occurspublic final double getDouble(int parameterIndex) throws SQLException
DOUBLE
parameter as a double
in the Java programming language.
getDouble
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is 0.
SQLException
- if a database access error occurspublic final BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException
NUMERIC
parameter as a java.math.BigDecimal
object with scale digits to the right of the decimal point.
getBigDecimal
in interface CallableStatement
parameterIndex
- 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
.
SQLException
- if a database access error occurspublic final byte[] getBytes(int parameterIndex) throws SQLException
BINARY
or VARBINARY
parameter as an array of byte
values in the Java
programming language.
getBytes
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is null
.
SQLException
- if a database access error occurspublic final Date getDate(int parameterIndex) throws SQLException
DATE
parameter as a java.sql.Date
object.
getDate
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is null
.
SQLException
- if a database access error occurspublic final Time getTime(int parameterIndex) throws SQLException
TIME
parameter as a java.sql.Time
object.
getTime
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is null
.
SQLException
- if a database access error occurspublic final Timestamp getTimestamp(int parameterIndex) throws SQLException
TIMESTAMP
parameter as a java.sql.Timestamp
object.
getTimestamp
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the
result is null
.
SQLException
- if a database access error occurspublic final Object getObject(int parameterIndex) throws SQLException
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.
getObject
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
java.lang.Object
holding the OUT parameter value.
SQLException
- if a database access error occurspublic final BigDecimal getBigDecimal(int parameterIndex) throws SQLException
NUMERIC
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 CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
on
NULL
, the result is null
.
SQLException
- if a database access error occurspublic final Object getObject(int i, Map map) throws SQLException
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.
getObject
in interface CallableStatement
i
- 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 value
SQLException
- if a database access error occurspublic final Ref getRef(int i) throws SQLException
REF(<structured-type>)
parameter as a Ref object in the Java programming language.
getRef
in interface CallableStatement
i
- 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.
SQLException
- if a database access error occurspublic final Blob getBlob(int i) throws SQLException
BLOB
parameter as a Blob\ object
in the Java programming language.
getBlob
in interface CallableStatement
i
- 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.
SQLException
- if a database access error occurspublic final Clob getClob(int i) throws SQLException
CLOB
parameter as a Clob
object in the Java programming language.
getClob
in interface CallableStatement
i
- 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.
SQLException
- if a database access error occurspublic final Array getArray(int i) throws SQLException
ARRAY
parameter as an Array object
in the Java programming language.
getArray
in interface CallableStatement
i
- 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.
SQLException
- if a database access error occurspublic final Date getDate(int parameterIndex, Calendar cal) throws SQLException
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.
getDate
in interface CallableStatement
parameterIndex
- 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
.
SQLException
- if a database access error occurspublic final Time getTime(int parameterIndex, Calendar cal) throws SQLException
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.
getTime
in interface CallableStatement
parameterIndex
- 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
.
SQLException
- if a database access error occurspublic final Timestamp getTimestamp(int parameterIndex, Calendar cal) throws SQLException
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.
getTimestamp
in interface CallableStatement
parameterIndex
- 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
.
SQLException
- if a database access error occurspublic final void registerOutParameter(int parameterIndex, int sqlType) throws SQLException
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 retrieves the
value.
registerOutParameter
in interface CallableStatement
parameterIndex
- 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.
SQLException
- if a database access error occurspublic final void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException
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
.
registerOutParameter
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so
onsqlType
- 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.
SQLException
- if a database access error occurspublic final boolean wasNull() throws SQLException
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.
wasNull
in interface CallableStatement
true
if the last parameter read was SQL NULL
; false
otherwise
SQLException
- if a database access error occurspublic final void registerOutParameter(int paramIndex, int sqlType, String typeName) throws SQLException
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.
registerOutParameter
in interface CallableStatement
paramIndex
- the first parameter is 1, the second is 2,...sqlType
- a value from java.sql.TypestypeName
- the fully-qualified name of an SQL structured type
SQLException
- if a database access error occurspublic URL getURL(int parameterIndex) throws SQLException
DATALINK
parameter as a
java.net.URL
object.
getURL
in interface CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,...
java.net.URL
object that represents the
JDBC DATALINK
value used as the designated
parameter
SQLException
- if a database access error occurs,
or if the URL being returned is
not a valid URL on the Java platformsetURL(java.lang.String, java.net.URL)
public void setURL(String parameterName, URL val) throws SQLException
java.net.URL
object.
The driver converts this to an SQL DATALINK
value when
it sends it to the database.
setURL
in interface CallableStatement
parameterName
- the name of the parameterval
- the parameter value
SQLException
- if a database access error occurs,
or if a URL is malformedpublic void setNull(String parameterName, int sqlType) throws SQLException
NULL
.
Note: You must specify the parameter's SQL type.
setNull
in interface CallableStatement
parameterName
- the name of the parametersqlType
- the SQL type code defined in java.sql.Types
SQLException
- if a database access error occurspublic void setBoolean(String parameterName, boolean x) throws SQLException
boolean
value.
The driver converts this
to an SQL BIT
value when it sends it to the database.
setBoolean
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setByte(String parameterName, byte x) throws SQLException
byte
value.
The driver converts this
to an SQL TINYINT
value when it sends it to the database.
setByte
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setShort(String parameterName, short x) throws SQLException
short
value.
The driver converts this
to an SQL SMALLINT
value when it sends it to the database.
setShort
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setInt(String parameterName, int x) throws SQLException
int
value.
The driver converts this
to an SQL INTEGER
value when it sends it to the database.
setInt
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setLong(String parameterName, long x) throws SQLException
long
value.
The driver converts this
to an SQL BIGINT
value when it sends it to the database.
setLong
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setFloat(String parameterName, float x) throws SQLException
float
value.
The driver converts this
to an SQL FLOAT
value when it sends it to the database.
setFloat
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setDouble(String parameterName, double x) throws SQLException
double
value.
The driver converts this
to an SQL DOUBLE
value when it sends it to the database.
setDouble
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setBigDecimal(String parameterName, BigDecimal x) throws SQLException
java.math.BigDecimal
value.
The driver converts this to an SQL NUMERIC
value when
it sends it to the database.
setBigDecimal
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setString(String parameterName, String x) throws SQLException
String
value.
The driver converts this
to an SQL VARCHAR
or LONGVARCHAR
value
(depending on the argument's
size relative to the driver's limits on VARCHAR
values)
when it sends it to the database.
setString
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setBytes(String parameterName, byte[] x) throws SQLException
VARBINARY
or
LONGVARBINARY
(depending on the argument's size relative
to the driver's limits on VARBINARY
values) when it sends
it to the database.
setBytes
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setDate(String parameterName, Date x) throws SQLException
java.sql.Date
value.
The driver converts this
to an SQL DATE
value when it sends it to the database.
setDate
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setTime(String parameterName, Time x) throws SQLException
java.sql.Time
value.
The driver converts this
to an SQL TIME
value when it sends it to the database.
setTime
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setTimestamp(String parameterName, Timestamp x) throws SQLException
java.sql.Timestamp
value.
The driver
converts this to an SQL TIMESTAMP
value when it sends it to the
database.
setTimestamp
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter value
SQLException
- if a database access error occurspublic void setAsciiStream(String parameterName, InputStream x, int length) throws SQLException
LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream
. Data will be read from the stream
as needed until end-of-file is reached. The JDBC driver will
do any necessary conversion from ASCII to the database char format.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
setAsciiStream
in interface CallableStatement
parameterName
- the name of the parameterx
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream
SQLException
- if a database access error occurspublic void setBinaryStream(String parameterName, InputStream x, int length) throws SQLException
LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream
object. The data will be read from the stream
as needed until end-of-file is reached.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
setBinaryStream
in interface CallableStatement
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream
SQLException
- if a database access error occurspublic void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException
java.lang
equivalent objects should be used.
The given Java object will be converted to the given targetSqlType
before being sent to the database.
If the object has a custom mapping (is of a class implementing the
interface SQLData
),
the JDBC driver should call the method SQLData.writeSQL
to write it
to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref
, Blob
, Clob
, Struct
,
or Array
, the driver should pass it to the database as a
value of the corresponding SQL type.
Note that this method may be used to pass datatabase- specific abstract data types.
setObject
in interface CallableStatement
parameterName
- 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.
SQLException
- if a database access error occursTypes
public void setObject(String parameterName, Object x, int targetSqlType) throws SQLException
setObject
above, except that it assumes a scale of zero.
setObject
in interface CallableStatement
parameterName
- 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
SQLException
- if a database access error occurspublic void setObject(String parameterName, Object x) throws SQLException
Object
; therefore, the
java.lang
equivalent objects should be used for built-in types.
The JDBC specification specifies a standard mapping from
Java Object
types to SQL types. The given argument
will be converted to the corresponding SQL type before being
sent to the database.
Note that this method may be used to pass datatabase-
specific abstract data types, by using a driver-specific Java
type.
If the object is of a class implementing the interface SQLData
,
the JDBC driver should call the method SQLData.writeSQL
to write it to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref
, Blob
, Clob
, Struct
,
or Array
, 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 CallableStatement
parameterName
- the name of the parameterx
- the object containing the input parameter value
SQLException
- if a database access error occurs or if the given
Object
parameter is ambiguouspublic void setCharacterStream(String parameterName, Reader reader, int length) throws SQLException
Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader
object. The data will be read from the stream
as needed until end-of-file is reached. The JDBC driver will
do any necessary conversion from UNICODE to the database char format.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
setCharacterStream
in interface CallableStatement
parameterName
- 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
SQLException
- if a database access error occurspublic void setDate(String parameterName, Date x, Calendar cal) throws SQLException
java.sql.Date
value,
using the given Calendar
object. The driver uses
the Calendar
object to construct an SQL DATE
value,
which the driver then sends to the database. With a
a Calendar
object, the driver can calculate the date
taking into account a custom timezone. If no
Calendar
object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
setDate
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use
to construct the date
SQLException
- if a database access error occurspublic void setTime(String parameterName, Time x, Calendar cal) throws SQLException
java.sql.Time
value,
using the given Calendar
object. The driver uses
the Calendar
object to construct an SQL TIME
value,
which the driver then sends to the database. With a
a Calendar
object, the driver can calculate the time
taking into account a custom timezone. If no
Calendar
object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
setTime
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use
to construct the time
SQLException
- if a database access error occurspublic void setTimestamp(String parameterName, Timestamp x, Calendar cal) throws SQLException
java.sql.Timestamp
value,
using the given Calendar
object. The driver uses
the Calendar
object to construct an SQL TIMESTAMP
value,
which the driver then sends to the database. With a
a Calendar
object, the driver can calculate the timestamp
taking into account a custom timezone. If no
Calendar
object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
setTimestamp
in interface CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use
to construct the timestamp
SQLException
- if a database access error occurspublic void setNull(String parameterName, int sqlType, String typeName) throws SQLException
NULL
.
This version of the method setNull
should
be used for user-defined types and REF type parameters. Examples
of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
named array types.
Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
setNull
in interface CallableStatement
parameterName
- the name of the parametersqlType
- a value from java.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or
SQL REF
value
SQLException
- if a database access error occurspublic String getString(String parameterName) throws SQLException
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.
getString
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is null
.
SQLException
- if a database access error occurssetString(java.lang.String, java.lang.String)
public boolean getBoolean(String parameterName) throws SQLException
BIT
parameter as a
boolean
in the Java programming language.
getBoolean
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is false
.
SQLException
- if a database access error occurssetBoolean(java.lang.String, boolean)
public byte getByte(String parameterName) throws SQLException
TINYINT
parameter as a byte
in the Java programming language.
getByte
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is 0
.
SQLException
- if a database access error occurssetByte(java.lang.String, byte)
public short getShort(String parameterName) throws SQLException
SMALLINT
parameter as a short
in the Java programming language.
getShort
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is 0
.
SQLException
- if a database access error occurssetShort(java.lang.String, short)
public int getInt(String parameterName) throws SQLException
INTEGER
parameter as an int
in the Java programming language.
getInt
in interface CallableStatement
parameterName
- the name of the parameter
NULL
,
the result is 0
.
SQLException
- if a database access error occurssetInt(java.lang.String, int)
public long getLong(String parameterName) throws SQLException
BIGINT
parameter as a long
in the Java programming language.
getLong
in interface CallableStatement
parameterName
- the name of the parameter
NULL
,
the result is 0
.
SQLException
- if a database access error occurssetLong(java.lang.String, long)
public float getFloat(String parameterName) throws SQLException
FLOAT
parameter as a float
in the Java programming language.
getFloat
in interface CallableStatement
parameterName
- the name of the parameter
NULL
,
the result is 0
.
SQLException
- if a database access error occurssetFloat(java.lang.String, float)
public double getDouble(String parameterName) throws SQLException
DOUBLE
parameter as a double
in the Java programming language.
getDouble
in interface CallableStatement
parameterName
- the name of the parameter
NULL
,
the result is 0
.
SQLException
- if a database access error occurssetDouble(java.lang.String, double)
public byte[] getBytes(String parameterName) throws SQLException
BINARY
or VARBINARY
parameter as an array of byte
values in the Java
programming language.
getBytes
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result is
null
.
SQLException
- if a database access error occurssetBytes(java.lang.String, byte[])
public Date getDate(String parameterName) throws SQLException
DATE
parameter as a
java.sql.Date
object.
getDate
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is null
.
SQLException
- if a database access error occurspublic Time getTime(String parameterName) throws SQLException
TIME
parameter as a
java.sql.Time
object.
getTime
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is null
.
SQLException
- if a database access error occurspublic Timestamp getTimestamp(String parameterName) throws SQLException
TIMESTAMP
parameter as a
java.sql.Timestamp
object.
getTimestamp
in interface CallableStatement
parameterName
- the name of the parameter
NULL
, the result
is null
.
SQLException
- if a database access error occurspublic Object getObject(String parameterName) throws SQLException
Object
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 CallableStatement
parameterName
- the name of the parameter
java.lang.Object
holding the OUT parameter value.
SQLException
- if a database access error occursTypes
public BigDecimal getBigDecimal(String parameterName) throws SQLException
NUMERIC
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 CallableStatement
parameterName
- the name of the parameter
NULL
, the result is null
.
SQLException
- if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)
public Object getObject(String parameterName, Map map) throws SQLException
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.
getObject
in interface CallableStatement
parameterName
- the name of the parametermap
- the mapping from SQL type names to Java classes
java.lang.Object
holding the OUT parameter value
SQLException
- if a database access error occurspublic Ref getRef(String parameterName) throws SQLException
REF(<structured-type>)
parameter as a Ref
object in the Java programming language.
getRef
in interface CallableStatement
parameterName
- the name of the parameter
Ref
object in the
Java programming language. If the value was SQL NULL
,
the value null
is returned.
SQLException
- if a database access error occurspublic Blob getBlob(String parameterName) throws SQLException
BLOB
parameter as a
Blob
object in the Java programming language.
getBlob
in interface CallableStatement
parameterName
- the name of the parameter
Blob
object in the
Java programming language. If the value was SQL NULL
,
the value null
is returned.
SQLException
- if a database access error occurspublic Clob getClob(String parameterName) throws SQLException
CLOB
parameter as a
Clob
object in the Java programming language.
getClob
in interface CallableStatement
parameterName
- the name of the parameter
Clob
object in the
Java programming language. If the value was SQL NULL
,
the value null
is returned.
SQLException
- if a database access error occurspublic Array getArray(String parameterName) throws SQLException
ARRAY
parameter as an
Array
object in the Java programming language.
getArray
in interface CallableStatement
parameterName
- the name of the parameter
Array
object in
Java programming language. If the value was SQL NULL
,
the value null
is returned.
SQLException
- if a database access error occurspublic Date getDate(String parameterName, Calendar cal) throws SQLException
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.
getDate
in interface CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use
to construct the date
NULL
,
the result is null
.
SQLException
- if a database access error occurspublic Time getTime(String parameterName, Calendar cal) throws SQLException
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.
getTime
in interface CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use
to construct the time
NULL
, the result is
null
.
SQLException
- if a database access error occurspublic Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException
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.
getTimestamp
in interface CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use
to construct the timestamp
NULL
, the result is
null
.
SQLException
- if a database access error occurspublic URL getURL(String parameterName) throws SQLException
DATALINK
parameter as a
java.net.URL
object.
getURL
in interface CallableStatement
parameterName
- 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.
SQLException
- if a database access error occurs,
or if there is a problem with the URLsetURL(java.lang.String, java.net.URL)
public void registerOutParameter(String parameterName, int sqlType) throws SQLException
parameterName
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 retrieves the value.
registerOutParameter
in interface CallableStatement
parameterName
- 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.
SQLException
- if a database access error occursTypes
public void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException
parameterName
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 CallableStatement
parameterName
- 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.
SQLException
- if a database access error occursTypes
public void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException
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.
registerOutParameter
in interface CallableStatement
parameterName
- the name of the parametersqlType
- a value from Types
typeName
- the fully-qualified name of an SQL structured type
SQLException
- if a database access error occursTypes
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |