public final class CallableStatementWrapper extends PreparedStatementWrapper implements java.sql.CallableStatement
{?= 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."
| Modifier and Type | Field and Description |
|---|---|
private java.sql.CallableStatement |
delegate_ |
| Constructor and Description |
|---|
CallableStatementWrapper(java.sql.CallableStatement statement)
Create a wrapper
|
| Modifier and Type | Method and Description |
|---|---|
java.sql.Array |
getArray(int i)
Gets the value of a JDBC
ARRAY parameter as an Array object
in the Java programming language. |
java.sql.Array |
getArray(java.lang.String parameterName)
Retrieves the value of a JDBC
ARRAY parameter as an
Array object in the Java programming language. |
java.math.BigDecimal |
getBigDecimal(int parameterIndex)
Gets the value of a JDBC
NUMERIC parameter as a java.math.BigDecimal
object with as many digits to the right of the decimal point as the
value contains. |
java.math.BigDecimal |
getBigDecimal(int parameterIndex,
int scale)
Deprecated.
|
java.math.BigDecimal |
getBigDecimal(java.lang.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. |
java.sql.Blob |
getBlob(int i)
Gets the value of a JDBC
BLOB parameter as a Blob\ object
in the Java programming language. |
java.sql.Blob |
getBlob(java.lang.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(java.lang.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(java.lang.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(java.lang.String parameterName)
Retrieves the value of a JDBC
BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language. |
java.io.Reader |
getCharacterStream(int parameterIndex) |
java.io.Reader |
getCharacterStream(java.lang.String parameterName) |
java.sql.Clob |
getClob(int i)
Gets the value of a JDBC
CLOB parameter as a Clob
object in the Java programming language. |
java.sql.Clob |
getClob(java.lang.String parameterName)
Retrieves the value of a JDBC
CLOB parameter as a
Clob object in the Java programming language. |
java.sql.Date |
getDate(int parameterIndex)
Gets the value of a JDBC
DATE parameter as a java.sql.Date
object. |
java.sql.Date |
getDate(int parameterIndex,
java.util.Calendar cal)
Gets the value of a JDBC
DATE parameter as a java.sql.Date
object, using the given Calendar object to construct the
date. |
java.sql.Date |
getDate(java.lang.String parameterName)
Retrieves the value of a JDBC
DATE parameter as a
java.sql.Date object. |
java.sql.Date |
getDate(java.lang.String parameterName,
java.util.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String parameterName)
Retrieves the value of a JDBC
BIGINT parameter as a long
in the Java programming language. |
java.io.Reader |
getNCharacterStream(int parameterIndex) |
java.io.Reader |
getNCharacterStream(java.lang.String parameterName) |
java.sql.NClob |
getNClob(int parameterIndex) |
java.sql.NClob |
getNClob(java.lang.String parameterName) |
java.lang.String |
getNString(int parameterIndex) |
java.lang.String |
getNString(java.lang.String parameterName) |
java.lang.Object |
getObject(int parameterIndex)
Gets the value of a parameter as an
Object in the Java
programming language. |
<T> T |
getObject(int columnIndex,
java.lang.Class<T> arg0) |
java.lang.Object |
getObject(int i,
java.util.Map map)
Returns an object representing the value of OUT parameter
i
and uses map for the custom mapping of the parameter value. |
java.lang.Object |
getObject(java.lang.String parameterName)
Retrieves the value of a parameter as an
Object in the Java
programming language. |
<T> T |
getObject(java.lang.String parameterName,
java.lang.Class<T> arg0) |
java.lang.Object |
getObject(java.lang.String parameterName,
java.util.Map map)
Returns an object representing the value of OUT parameter
i and uses map for the custom
mapping of the parameter value. |
java.sql.Ref |
getRef(int i)
Gets the value of a JDBC
REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
java.sql.Ref |
getRef(java.lang.String parameterName)
Retrieves the value of a JDBC
REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
java.sql.RowId |
getRowId(int parameterIndex) |
java.sql.RowId |
getRowId(java.lang.String parameterName) |
short |
getShort(int parameterIndex)
Gets the value of a JDBC
SMALLINT parameter as a short
in the Java programming language. |
short |
getShort(java.lang.String parameterName)
Retrieves the value of a JDBC
SMALLINT parameter as a short
in the Java programming language. |
java.sql.SQLXML |
getSQLXML(int parameterIndex) |
java.sql.SQLXML |
getSQLXML(java.lang.String parameterName) |
java.lang.String |
getString(int parameterIndex)
Retrieves the value of a JDBC
CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in the
Java programming language. |
java.lang.String |
getString(java.lang.String parameterName)
Retrieves the value of a JDBC
CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language. |
java.sql.Time |
getTime(int parameterIndex)
Get the value of a JDBC
TIME parameter as a java.sql.Time
object. |
java.sql.Time |
getTime(int parameterIndex,
java.util.Calendar cal)
Gets the value of a JDBC
TIME parameter as a java.sql.Time
object, using the given Calendar object to construct the
time. |
java.sql.Time |
getTime(java.lang.String parameterName)
Retrieves the value of a JDBC
TIME parameter as a
java.sql.Time object. |
java.sql.Time |
getTime(java.lang.String parameterName,
java.util.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. |
java.sql.Timestamp |
getTimestamp(int parameterIndex)
Gets the value of a JDBC
TIMESTAMP parameter as a java.sql.Timestamp
object. |
java.sql.Timestamp |
getTimestamp(int parameterIndex,
java.util.Calendar cal)
Gets the value of a JDBC
TIMESTAMP parameter as a java.sql.Timestamp
object, using the given Calendar object to construct the
Timestamp object. |
java.sql.Timestamp |
getTimestamp(java.lang.String parameterName)
Retrieves the value of a JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
java.sql.Timestamp |
getTimestamp(java.lang.String parameterName,
java.util.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. |
java.net.URL |
getURL(int parameterIndex)
Retrieves the value of the designated JDBC
DATALINK parameter as a
java.net.URL object. |
java.net.URL |
getURL(java.lang.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,
java.lang.String typeName)
Registers the designated output parameter.
|
void |
registerOutParameter(java.lang.String parameterName,
int sqlType)
Registers the OUT parameter named
parameterName to the JDBC type
sqlType. |
void |
registerOutParameter(java.lang.String parameterName,
int sqlType,
int scale)
Registers the parameter named
parameterName to be of JDBC type
sqlType. |
void |
registerOutParameter(java.lang.String parameterName,
int sqlType,
java.lang.String typeName)
Registers the designated output parameter.
|
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x) |
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x,
long length) |
void |
setBigDecimal(java.lang.String parameterName,
java.math.BigDecimal x)
Sets the designated parameter to the given
java.math.BigDecimal value. |
void |
setBinaryStream(java.lang.String parameterName,
java.io.InputStream x) |
void |
setBinaryStream(java.lang.String parameterName,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBinaryStream(java.lang.String parameterName,
java.io.InputStream x,
long length) |
void |
setBlob(java.lang.String parameterName,
java.sql.Blob x) |
void |
setBlob(java.lang.String parameterName,
java.io.InputStream inputStream) |
void |
setBlob(java.lang.String parameterName,
java.io.InputStream inputStream,
long length) |
void |
setBoolean(java.lang.String parameterName,
boolean x)
Sets the designated parameter to the given Java
boolean value. |
void |
setByte(java.lang.String parameterName,
byte x)
Sets the designated parameter to the given Java
byte value. |
void |
setBytes(java.lang.String parameterName,
byte[] x)
Sets the designated parameter to the given Java array of bytes.
|
void |
setCharacterStream(java.lang.String parameterName,
java.io.Reader reader) |
void |
setCharacterStream(java.lang.String parameterName,
java.io.Reader reader,
int length)
Sets the designated parameter to the given
Reader
object, which is the given number of characters long. |
void |
setCharacterStream(java.lang.String parameterName,
java.io.Reader reader,
long length) |
void |
setClob(java.lang.String parameterName,
java.sql.Clob x) |
void |
setClob(java.lang.String parameterName,
java.io.Reader reader) |
void |
setClob(java.lang.String parameterName,
java.io.Reader reader,
long length) |
void |
setDate(java.lang.String parameterName,
java.sql.Date x)
Sets the designated parameter to the given
java.sql.Date value. |
void |
setDate(java.lang.String parameterName,
java.sql.Date x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Date value,
using the given Calendar object. |
void |
setDouble(java.lang.String parameterName,
double x)
Sets the designated parameter to the given Java
double value. |
void |
setFloat(java.lang.String parameterName,
float x)
Sets the designated parameter to the given Java
float value. |
void |
setInt(java.lang.String parameterName,
int x)
Sets the designated parameter to the given Java
int value. |
void |
setLong(java.lang.String parameterName,
long x)
Sets the designated parameter to the given Java
long value. |
void |
setNCharacterStream(java.lang.String parameterName,
java.io.Reader value) |
void |
setNCharacterStream(java.lang.String parameterName,
java.io.Reader value,
long length) |
void |
setNClob(java.lang.String parameterName,
java.sql.NClob value) |
void |
setNClob(java.lang.String parameterName,
java.io.Reader reader) |
void |
setNClob(java.lang.String parameterName,
java.io.Reader reader,
long length) |
void |
setNString(java.lang.String parameterName,
java.lang.String value) |
void |
setNull(java.lang.String parameterName,
int sqlType)
Sets the designated parameter to SQL
NULL. |
void |
setNull(java.lang.String parameterName,
int sqlType,
java.lang.String typeName)
Sets the designated parameter to SQL
NULL. |
void |
setObject(java.lang.String parameterName,
java.lang.Object x)
Sets the value of the designated parameter with the given object.
|
void |
setObject(java.lang.String parameterName,
java.lang.Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object.
|
void |
setObject(java.lang.String parameterName,
java.lang.Object x,
int targetSqlType,
int scale)
Sets the value of the designated parameter with the given object.
|
void |
setRowId(java.lang.String parameterName,
java.sql.RowId x) |
void |
setShort(java.lang.String parameterName,
short x)
Sets the designated parameter to the given Java
short value. |
void |
setSQLXML(java.lang.String parameterName,
java.sql.SQLXML xmlObject) |
void |
setString(java.lang.String parameterName,
java.lang.String x)
Sets the designated parameter to the given Java
String value. |
void |
setTime(java.lang.String parameterName,
java.sql.Time x)
Sets the designated parameter to the given
java.sql.Time value. |
void |
setTime(java.lang.String parameterName,
java.sql.Time x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Time value,
using the given Calendar object. |
void |
setTimestamp(java.lang.String parameterName,
java.sql.Timestamp x)
Sets the designated parameter to the given
java.sql.Timestamp value. |
void |
setTimestamp(java.lang.String parameterName,
java.sql.Timestamp x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Timestamp value,
using the given Calendar object. |
void |
setURL(java.lang.String parameterName,
java.net.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. |
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURLaddBatch, cancel, checkIsOpen, clearBatch, clearWarnings, close, closeOnCompletion, 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, isCloseOnCompletion, isPoolable, isWrapperFor, setConnection, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, unwrap, wrapResultSetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitregisterOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setObject, setObjectaddBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURLaddBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeoutpublic CallableStatementWrapper(java.sql.CallableStatement statement)
statement - The statement that is being wrappedpublic final java.lang.String getString(int parameterIndex)
throws java.sql.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 java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final boolean getBoolean(int parameterIndex)
throws java.sql.SQLException
BIT parameter as a boolean
in the Java programming language.getBoolean in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is false.java.sql.SQLException - if a database access error occurspublic final byte getByte(int parameterIndex)
throws java.sql.SQLException
TINYINT parameter as a byte
in the Java programming language.getByte in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is 0.java.sql.SQLException - if a database access error occurspublic final short getShort(int parameterIndex)
throws java.sql.SQLException
SMALLINT parameter as a short
in the Java programming language.getShort in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is 0.java.sql.SQLException - if a database access error occurspublic final int getInt(int parameterIndex)
throws java.sql.SQLException
INTEGER parameter as an int
in the Java programming language.getInt in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is 0.java.sql.SQLException - if a database access error occurspublic final long getLong(int parameterIndex)
throws java.sql.SQLException
BIGINT parameter as a long
in the Java programming language.getLong in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is 0.java.sql.SQLException - if a database access error occurspublic final float getFloat(int parameterIndex)
throws java.sql.SQLException
FLOAT parameter as a float
in the Java programming language.getFloat in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is 0.java.sql.SQLException - if a database access error occurspublic final double getDouble(int parameterIndex)
throws java.sql.SQLException
DOUBLE parameter as a double
in the Java programming language.getDouble in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is 0.java.sql.SQLException - if a database access error occurspublic final java.math.BigDecimal getBigDecimal(int parameterIndex,
int scale)
throws java.sql.SQLException
NUMERIC parameter as a java.math.BigDecimal
object with scale digits to the right of the decimal point.getBigDecimal in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onscale - the number of digits to the right of the decimal pointNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final byte[] getBytes(int parameterIndex)
throws java.sql.SQLException
BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language.getBytes in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final java.sql.Date getDate(int parameterIndex)
throws java.sql.SQLException
DATE parameter as a java.sql.Date
object.getDate in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final java.sql.Time getTime(int parameterIndex)
throws java.sql.SQLException
TIME parameter as a java.sql.Time
object.getTime in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final java.sql.Timestamp getTimestamp(int parameterIndex)
throws java.sql.SQLException
TIMESTAMP parameter as a java.sql.Timestamp
object.getTimestamp in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final java.lang.Object getObject(int parameterIndex)
throws java.sql.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 java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onjava.lang.Object holding the OUT parameter value.java.sql.SQLException - if a database access error occurspublic final java.math.BigDecimal getBigDecimal(int parameterIndex)
throws java.sql.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 java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
onNULL, the result is null.java.sql.SQLException - if a database access error occurspublic final java.lang.Object getObject(int i,
java.util.Map map)
throws java.sql.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 java.sql.CallableStatementi - the first parameter is 1, the second is 2, and so onmap - the mapping from SQL type names to Java classesjava.lang.Object holding the OUT parameter valuejava.sql.SQLException - if a database access error occurspublic final java.sql.Ref getRef(int i)
throws java.sql.SQLException
REF(<structured-type>)
parameter as a Ref object in the Java programming language.getRef in interface java.sql.CallableStatementi - the first parameter is 1, the second is 2, and so onRef object in the Java
programming language. If the value was SQL NULL, the
value null is returned.java.sql.SQLException - if a database access error occurspublic final java.sql.Blob getBlob(int i)
throws java.sql.SQLException
BLOB parameter as a Blob\ object
in the Java programming language.getBlob in interface java.sql.CallableStatementi - the first parameter is 1, the second is 2, and so onBlob object in the Java
programming language. If the value was SQL NULL, the
value null is returned.java.sql.SQLException - if a database access error occurspublic final java.sql.Clob getClob(int i)
throws java.sql.SQLException
CLOB parameter as a Clob
object in the Java programming language.getClob in interface java.sql.CallableStatementi - the first parameter is 1, the second is 2, and so onClob object in the Java
programming language. If the value was SQL NULL, the
value null is returned.java.sql.SQLException - if a database access error occurspublic final java.sql.Array getArray(int i)
throws java.sql.SQLException
ARRAY parameter as an Array object
in the Java programming language.getArray in interface java.sql.CallableStatementi - the first parameter is 1, the second is 2, and so onArray object in the Java
programming language. If the value was SQL NULL, the
value null is returned.java.sql.SQLException - if a database access error occurspublic final java.sql.Date getDate(int parameterIndex,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
oncal - the Calendar object the driver will use to
construct the dateNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final java.sql.Time getTime(int parameterIndex,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
oncal - the Calendar object the driver will use to
construct the timeNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final java.sql.Timestamp getTimestamp(int parameterIndex,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2, and so
oncal - the Calendar object the driver will use to
construct the timestampNULL, the
result is null.java.sql.SQLException - if a database access error occurspublic final void registerOutParameter(int parameterIndex,
int sqlType)
throws java.sql.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 java.sql.CallableStatementparameterIndex - 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.java.sql.SQLException - if a database access error occurspublic final void registerOutParameter(int parameterIndex,
int sqlType,
int scale)
throws java.sql.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 java.sql.CallableStatementparameterIndex - 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.java.sql.SQLException - if a database access error occurspublic final boolean wasNull()
throws java.sql.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 java.sql.CallableStatementtrue if the last parameter read was SQL NULL
; false otherwisejava.sql.SQLException - if a database access error occurspublic final void registerOutParameter(int paramIndex,
int sqlType,
java.lang.String typeName)
throws java.sql.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 java.sql.CallableStatementparamIndex - the first parameter is 1, the second is 2,...sqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL structured typejava.sql.SQLException - if a database access error occurspublic java.net.URL getURL(int parameterIndex)
throws java.sql.SQLException
DATALINK parameter as a
java.net.URL object.getURL in interface java.sql.CallableStatementparameterIndex - the first parameter is 1, the second is 2,...java.net.URL object that represents the
JDBC DATALINK value used as the designated
parameterjava.sql.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(java.lang.String parameterName,
java.net.URL val)
throws java.sql.SQLException
java.net.URL object.
The driver converts this to an SQL DATALINK value when
it sends it to the database.setURL in interface java.sql.CallableStatementparameterName - the name of the parameterval - the parameter valuejava.sql.SQLException - if a database access error occurs,
or if a URL is malformedpublic void setNull(java.lang.String parameterName,
int sqlType)
throws java.sql.SQLException
NULL.
Note: You must specify the parameter's SQL type.
setNull in interface java.sql.CallableStatementparameterName - the name of the parametersqlType - the SQL type code defined in java.sql.Typesjava.sql.SQLException - if a database access error occurspublic void setBoolean(java.lang.String parameterName,
boolean x)
throws java.sql.SQLException
boolean value.
The driver converts this
to an SQL BIT value when it sends it to the database.setBoolean in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setByte(java.lang.String parameterName,
byte x)
throws java.sql.SQLException
byte value.
The driver converts this
to an SQL TINYINT value when it sends it to the database.setByte in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setShort(java.lang.String parameterName,
short x)
throws java.sql.SQLException
short value.
The driver converts this
to an SQL SMALLINT value when it sends it to the database.setShort in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setInt(java.lang.String parameterName,
int x)
throws java.sql.SQLException
int value.
The driver converts this
to an SQL INTEGER value when it sends it to the database.setInt in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setLong(java.lang.String parameterName,
long x)
throws java.sql.SQLException
long value.
The driver converts this
to an SQL BIGINT value when it sends it to the database.setLong in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setFloat(java.lang.String parameterName,
float x)
throws java.sql.SQLException
float value.
The driver converts this
to an SQL FLOAT value when it sends it to the database.setFloat in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setDouble(java.lang.String parameterName,
double x)
throws java.sql.SQLException
double value.
The driver converts this
to an SQL DOUBLE value when it sends it to the database.setDouble in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setBigDecimal(java.lang.String parameterName,
java.math.BigDecimal x)
throws java.sql.SQLException
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.setBigDecimal in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setString(java.lang.String parameterName,
java.lang.String x)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setBytes(java.lang.String parameterName,
byte[] x)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setDate(java.lang.String parameterName,
java.sql.Date x)
throws java.sql.SQLException
java.sql.Date value.
The driver converts this
to an SQL DATE value when it sends it to the database.setDate in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setTime(java.lang.String parameterName,
java.sql.Time x)
throws java.sql.SQLException
java.sql.Time value.
The driver converts this
to an SQL TIME value when it sends it to the database.setTime in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setTimestamp(java.lang.String parameterName,
java.sql.Timestamp x)
throws java.sql.SQLException
java.sql.Timestamp value.
The driver
converts this to an SQL TIMESTAMP value when it sends it to the
database.setTimestamp in interface java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuejava.sql.SQLException - if a database access error occurspublic void setAsciiStream(java.lang.String parameterName,
java.io.InputStream x,
int length)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the Java input stream that contains the ASCII parameter valuelength - the number of bytes in the streamjava.sql.SQLException - if a database access error occurspublic void setBinaryStream(java.lang.String parameterName,
java.io.InputStream x,
int length)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the java input stream which contains the binary parameter valuelength - the number of bytes in the streamjava.sql.SQLException - if a database access error occurspublic void setObject(java.lang.String parameterName,
java.lang.Object x,
int targetSqlType,
int scale)
throws java.sql.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 java.sql.CallableStatementparameterName - 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.java.sql.SQLException - if a database access error occursTypespublic void setObject(java.lang.String parameterName,
java.lang.Object x,
int targetSqlType)
throws java.sql.SQLException
setObject
above, except that it assumes a scale of zero.setObject in interface java.sql.CallableStatementparameterName - 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 databasejava.sql.SQLException - if a database access error occurspublic void setObject(java.lang.String parameterName,
java.lang.Object x)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the object containing the input parameter valuejava.sql.SQLException - if a database access error occurs or if the given
Object parameter is ambiguouspublic void setCharacterStream(java.lang.String parameterName,
java.io.Reader reader,
int length)
throws java.sql.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 java.sql.CallableStatementparameterName - 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 streamjava.sql.SQLException - if a database access error occurspublic void setDate(java.lang.String parameterName,
java.sql.Date x,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the datejava.sql.SQLException - if a database access error occurspublic void setTime(java.lang.String parameterName,
java.sql.Time x,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timejava.sql.SQLException - if a database access error occurspublic void setTimestamp(java.lang.String parameterName,
java.sql.Timestamp x,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterx - the parameter valuecal - the Calendar object the driver will use
to construct the timestampjava.sql.SQLException - if a database access error occurspublic void setNull(java.lang.String parameterName,
int sqlType,
java.lang.String typeName)
throws java.sql.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 java.sql.CallableStatementparameterName - 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 valuejava.sql.SQLException - if a database access error occurspublic java.lang.String getString(java.lang.String parameterName)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is null.java.sql.SQLException - if a database access error occurssetString(java.lang.String, java.lang.String)public boolean getBoolean(java.lang.String parameterName)
throws java.sql.SQLException
BIT parameter as a
boolean in the Java programming language.getBoolean in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is false.java.sql.SQLException - if a database access error occurssetBoolean(java.lang.String, boolean)public byte getByte(java.lang.String parameterName)
throws java.sql.SQLException
TINYINT parameter as a byte
in the Java programming language.getByte in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is 0.java.sql.SQLException - if a database access error occurssetByte(java.lang.String, byte)public short getShort(java.lang.String parameterName)
throws java.sql.SQLException
SMALLINT parameter as a short
in the Java programming language.getShort in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is 0.java.sql.SQLException - if a database access error occurssetShort(java.lang.String, short)public int getInt(java.lang.String parameterName)
throws java.sql.SQLException
INTEGER parameter as an int
in the Java programming language.getInt in interface java.sql.CallableStatementparameterName - the name of the parameterNULL,
the result is 0.java.sql.SQLException - if a database access error occurssetInt(java.lang.String, int)public long getLong(java.lang.String parameterName)
throws java.sql.SQLException
BIGINT parameter as a long
in the Java programming language.getLong in interface java.sql.CallableStatementparameterName - the name of the parameterNULL,
the result is 0.java.sql.SQLException - if a database access error occurssetLong(java.lang.String, long)public float getFloat(java.lang.String parameterName)
throws java.sql.SQLException
FLOAT parameter as a float
in the Java programming language.getFloat in interface java.sql.CallableStatementparameterName - the name of the parameterNULL,
the result is 0.java.sql.SQLException - if a database access error occurssetFloat(java.lang.String, float)public double getDouble(java.lang.String parameterName)
throws java.sql.SQLException
DOUBLE parameter as a double
in the Java programming language.getDouble in interface java.sql.CallableStatementparameterName - the name of the parameterNULL,
the result is 0.java.sql.SQLException - if a database access error occurssetDouble(java.lang.String, double)public byte[] getBytes(java.lang.String parameterName)
throws java.sql.SQLException
BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language.getBytes in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result is
null.java.sql.SQLException - if a database access error occurssetBytes(java.lang.String, byte[])public java.sql.Date getDate(java.lang.String parameterName)
throws java.sql.SQLException
DATE parameter as a
java.sql.Date object.getDate in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is null.java.sql.SQLException - if a database access error occurspublic java.sql.Time getTime(java.lang.String parameterName)
throws java.sql.SQLException
TIME parameter as a
java.sql.Time object.getTime in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is null.java.sql.SQLException - if a database access error occurspublic java.sql.Timestamp getTimestamp(java.lang.String parameterName)
throws java.sql.SQLException
TIMESTAMP parameter as a
java.sql.Timestamp object.getTimestamp in interface java.sql.CallableStatementparameterName - the name of the parameterNULL, the result
is null.java.sql.SQLException - if a database access error occurspublic java.lang.Object getObject(java.lang.String parameterName)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterjava.lang.Object holding the OUT parameter value.java.sql.SQLException - if a database access error occursTypespublic java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parameterNULL, the result is null.java.sql.SQLException - if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)public java.lang.Object getObject(java.lang.String parameterName,
java.util.Map map)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parametermap - the mapping from SQL type names to Java classesjava.lang.Object holding the OUT parameter valuejava.sql.SQLException - if a database access error occurspublic java.sql.Ref getRef(java.lang.String parameterName)
throws java.sql.SQLException
REF(<structured-type>)
parameter as a Ref object in the Java programming language.getRef in interface java.sql.CallableStatementparameterName - the name of the parameterRef object in the
Java programming language. If the value was SQL NULL,
the value null is returned.java.sql.SQLException - if a database access error occurspublic java.sql.Blob getBlob(java.lang.String parameterName)
throws java.sql.SQLException
BLOB parameter as a
Blob object in the Java programming language.getBlob in interface java.sql.CallableStatementparameterName - the name of the parameterBlob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.java.sql.SQLException - if a database access error occurspublic java.sql.Clob getClob(java.lang.String parameterName)
throws java.sql.SQLException
CLOB parameter as a
Clob object in the Java programming language.getClob in interface java.sql.CallableStatementparameterName - the name of the parameterClob object in the
Java programming language. If the value was SQL NULL,
the value null is returned.java.sql.SQLException - if a database access error occurspublic java.sql.Array getArray(java.lang.String parameterName)
throws java.sql.SQLException
ARRAY parameter as an
Array object in the Java programming language.getArray in interface java.sql.CallableStatementparameterName - the name of the parameterArray object in
Java programming language. If the value was SQL NULL,
the value null is returned.java.sql.SQLException - if a database access error occurspublic java.sql.Date getDate(java.lang.String parameterName,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the dateNULL,
the result is null.java.sql.SQLException - if a database access error occurspublic java.sql.Time getTime(java.lang.String parameterName,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the timeNULL, the result is
null.java.sql.SQLException - if a database access error occurspublic java.sql.Timestamp getTimestamp(java.lang.String parameterName,
java.util.Calendar cal)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parametercal - the Calendar object the driver will use
to construct the timestampNULL, the result is
null.java.sql.SQLException - if a database access error occurspublic java.net.URL getURL(java.lang.String parameterName)
throws java.sql.SQLException
DATALINK parameter as a
java.net.URL object.getURL in interface java.sql.CallableStatementparameterName - the name of the parameterjava.net.URL object in the
Java programming language. If the value was SQL NULL, the
value null is returned.java.sql.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(java.lang.String parameterName,
int sqlType)
throws java.sql.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 java.sql.CallableStatementparameterName - 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.java.sql.SQLException - if a database access error occursTypespublic void registerOutParameter(java.lang.String parameterName,
int sqlType,
int scale)
throws java.sql.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 java.sql.CallableStatementparameterName - 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.java.sql.SQLException - if a database access error occursTypespublic void registerOutParameter(java.lang.String parameterName,
int sqlType,
java.lang.String typeName)
throws java.sql.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 java.sql.CallableStatementparameterName - the name of the parametersqlType - a value from TypestypeName - the fully-qualified name of an SQL structured typejava.sql.SQLException - if a database access error occursTypespublic <T> T getObject(java.lang.String parameterName,
java.lang.Class<T> arg0)
throws java.sql.SQLException
getObject in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic <T> T getObject(int columnIndex,
java.lang.Class<T> arg0)
throws java.sql.SQLException
getObject in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setNClob(java.lang.String parameterName,
java.io.Reader reader)
throws java.sql.SQLException
setNClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setBlob(java.lang.String parameterName,
java.io.InputStream inputStream)
throws java.sql.SQLException
setBlob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setClob(java.lang.String parameterName,
java.io.Reader reader)
throws java.sql.SQLException
setClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setNCharacterStream(java.lang.String parameterName,
java.io.Reader value)
throws java.sql.SQLException
setNCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setCharacterStream(java.lang.String parameterName,
java.io.Reader reader)
throws java.sql.SQLException
setCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setBinaryStream(java.lang.String parameterName,
java.io.InputStream x)
throws java.sql.SQLException
setBinaryStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setAsciiStream(java.lang.String parameterName,
java.io.InputStream x)
throws java.sql.SQLException
setAsciiStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setCharacterStream(java.lang.String parameterName,
java.io.Reader reader,
long length)
throws java.sql.SQLException
setCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setBinaryStream(java.lang.String parameterName,
java.io.InputStream x,
long length)
throws java.sql.SQLException
setBinaryStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setAsciiStream(java.lang.String parameterName,
java.io.InputStream x,
long length)
throws java.sql.SQLException
setAsciiStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setClob(java.lang.String parameterName,
java.sql.Clob x)
throws java.sql.SQLException
setClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setBlob(java.lang.String parameterName,
java.sql.Blob x)
throws java.sql.SQLException
setBlob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.io.Reader getCharacterStream(java.lang.String parameterName)
throws java.sql.SQLException
getCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.io.Reader getCharacterStream(int parameterIndex)
throws java.sql.SQLException
getCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.io.Reader getNCharacterStream(java.lang.String parameterName)
throws java.sql.SQLException
getNCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.io.Reader getNCharacterStream(int parameterIndex)
throws java.sql.SQLException
getNCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.lang.String getNString(java.lang.String parameterName)
throws java.sql.SQLException
getNString in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.lang.String getNString(int parameterIndex)
throws java.sql.SQLException
getNString in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.sql.SQLXML getSQLXML(java.lang.String parameterName)
throws java.sql.SQLException
getSQLXML in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.sql.SQLXML getSQLXML(int parameterIndex)
throws java.sql.SQLException
getSQLXML in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setSQLXML(java.lang.String parameterName,
java.sql.SQLXML xmlObject)
throws java.sql.SQLException
setSQLXML in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.sql.NClob getNClob(java.lang.String parameterName)
throws java.sql.SQLException
getNClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.sql.NClob getNClob(int parameterIndex)
throws java.sql.SQLException
getNClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setNClob(java.lang.String parameterName,
java.io.Reader reader,
long length)
throws java.sql.SQLException
setNClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setBlob(java.lang.String parameterName,
java.io.InputStream inputStream,
long length)
throws java.sql.SQLException
setBlob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setClob(java.lang.String parameterName,
java.io.Reader reader,
long length)
throws java.sql.SQLException
setClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setNClob(java.lang.String parameterName,
java.sql.NClob value)
throws java.sql.SQLException
setNClob in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setNCharacterStream(java.lang.String parameterName,
java.io.Reader value,
long length)
throws java.sql.SQLException
setNCharacterStream in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setNString(java.lang.String parameterName,
java.lang.String value)
throws java.sql.SQLException
setNString in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic void setRowId(java.lang.String parameterName,
java.sql.RowId x)
throws java.sql.SQLException
setRowId in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.sql.RowId getRowId(java.lang.String parameterName)
throws java.sql.SQLException
getRowId in interface java.sql.CallableStatementjava.sql.SQLExceptionpublic java.sql.RowId getRowId(int parameterIndex)
throws java.sql.SQLException
getRowId in interface java.sql.CallableStatementjava.sql.SQLException