public class CallableStatementWrapper extends PreparedStatementWrapper implements java.sql.CallableStatement
Constructor and Description |
---|
CallableStatementWrapper(ConnectionWrapper parent,
java.sql.CallableStatement statement)
Create the statement
|
Modifier and Type | Method and Description |
---|---|
java.sql.Array |
getArray(int parameterIndex)
Retrieves the value of the designated 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)
Retrieves the value of the designated JDBC
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains. |
java.math.BigDecimal |
getBigDecimal(int parameterIndex,
int scale)
Deprecated.
use
getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName) |
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 parameterIndex)
Retrieves the value of the designated 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)
Retrieves the value of the designated JDBC
BIT
or BOOLEAN parameter as a
boolean in the Java programming language. |
boolean |
getBoolean(java.lang.String parameterName)
Retrieves the value of a JDBC
BIT or BOOLEAN
parameter as a
boolean in the Java programming language. |
byte |
getByte(int parameterIndex)
Retrieves the value of the designated JDBC
TINYINT parameter
as a byte in the Java programming language. |
byte |
getByte(java.lang.String parameterName)
Retrieves the value of a JDBC
TINYINT parameter as a byte
in the Java programming language. |
byte[] |
getBytes(int parameterIndex)
Retrieves the value of the designated JDBC
BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language. |
byte[] |
getBytes(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)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
java.io.Reader |
getCharacterStream(java.lang.String parameterName)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
java.sql.Clob |
getClob(int parameterIndex)
Retrieves the value of the designated JDBC
CLOB parameter as a
java.sql.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
java.sql.Clob object in the Java programming language. |
java.sql.Date |
getDate(int parameterIndex)
Retrieves the value of the designated JDBC
DATE parameter as a
java.sql.Date object. |
java.sql.Date |
getDate(int parameterIndex,
java.util.Calendar cal)
Retrieves the value of the designated JDBC
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date. |
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)
Retrieves the value of the designated 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)
Retrieves the value of the designated 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)
Retrieves the value of the designated 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)
Retrieves the value of the designated 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)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
java.io.Reader |
getNCharacterStream(java.lang.String parameterName)
Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language. |
java.sql.NClob |
getNClob(int parameterIndex)
Retrieves the value of the designated JDBC
NCLOB parameter as a
java.sql.NClob object in the Java programming language. |
java.sql.NClob |
getNClob(java.lang.String parameterName)
Retrieves the value of a JDBC
NCLOB parameter as a
java.sql.NClob object in the Java programming language. |
java.lang.String |
getNString(int parameterIndex)
Retrieves the value of the designated
NCHAR ,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language. |
java.lang.String |
getNString(java.lang.String parameterName)
Retrieves the value of the designated
NCHAR ,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language. |
java.lang.Object |
getObject(int parameterIndex)
Retrieves the value of the designated parameter as an
Object
in the Java programming language. |
<T> T |
getObject(int parameterIndex,
java.lang.Class<T> type)
Returns an object representing the value of OUT parameter
parameterIndex and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. |
java.lang.Object |
getObject(int parameterIndex,
java.util.Map<java.lang.String,java.lang.Class<?>> map)
Returns an object representing the value of OUT parameter
parameterIndex 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> type)
Returns an object representing the value of OUT parameter
parameterName and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. |
java.lang.Object |
getObject(java.lang.String parameterName,
java.util.Map<java.lang.String,java.lang.Class<?>> map)
Returns an object representing the value of OUT parameter
parameterName and uses map for the custom
mapping of the parameter value. |
java.sql.Ref |
getRef(int parameterIndex)
Retrieves the value of the designated 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)
Retrieves the value of the designated JDBC
ROWID parameter as a
java.sql.RowId object. |
java.sql.RowId |
getRowId(java.lang.String parameterName)
Retrieves the value of the designated JDBC
ROWID parameter as a
java.sql.RowId object. |
short |
getShort(int parameterIndex)
Retrieves the value of the designated 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)
Retrieves the value of the designated
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language. |
java.sql.SQLXML |
getSQLXML(java.lang.String parameterName)
Retrieves the value of the designated
SQL XML parameter as a
java.sql.SQLXML object in the Java programming language. |
java.lang.String |
getString(int parameterIndex)
Retrieves the value of the designated 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)
Retrieves the value of the designated JDBC
TIME parameter as a
java.sql.Time object. |
java.sql.Time |
getTime(int parameterIndex,
java.util.Calendar cal)
Retrieves the value of the designated JDBC
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time. |
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)
Retrieves the value of the designated JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
java.sql.Timestamp |
getTimestamp(int parameterIndex,
java.util.Calendar cal)
Retrieves the value of the designated JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object. |
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 parameterIndex,
int sqlType,
java.lang.String typeName)
Registers the designated output parameter.
|
void |
registerOutParameter(int parameterIndex,
java.sql.SQLType sqlType)
Registers the OUT parameter in ordinal position
parameterIndex to the JDBC type
sqlType . |
void |
registerOutParameter(int parameterIndex,
java.sql.SQLType sqlType,
int scale)
Registers the parameter in ordinal position
parameterIndex to be of JDBC type
sqlType . |
void |
registerOutParameter(int parameterIndex,
java.sql.SQLType 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 |
registerOutParameter(java.lang.String parameterName,
java.sql.SQLType sqlType)
Registers the OUT parameter named
parameterName to the JDBC type
sqlType . |
void |
registerOutParameter(java.lang.String parameterName,
java.sql.SQLType sqlType,
int scale)
Registers the parameter named
parameterName to be of JDBC type
sqlType . |
void |
registerOutParameter(java.lang.String parameterName,
java.sql.SQLType sqlType,
java.lang.String typeName)
Registers the designated output parameter.
|
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x)
Sets the designated parameter to the given input stream.
|
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)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
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)
Sets the designated parameter to the given input stream.
|
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)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBlob(java.lang.String parameterName,
java.sql.Blob x)
Sets the designated parameter to the given
java.sql.Blob object. |
void |
setBlob(java.lang.String parameterName,
java.io.InputStream inputStream)
Sets the designated parameter to a
InputStream object. |
void |
setBlob(java.lang.String parameterName,
java.io.InputStream inputStream,
long length)
Sets the designated parameter to a
InputStream object. |
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)
Sets the designated parameter to the given
Reader
object. |
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)
Sets the designated parameter to the given
Reader
object, which is the given number of characters long. |
void |
setClob(java.lang.String parameterName,
java.sql.Clob x)
Sets the designated parameter to the given
java.sql.Clob object. |
void |
setClob(java.lang.String parameterName,
java.io.Reader reader)
Sets the designated parameter to a
Reader object. |
void |
setClob(java.lang.String parameterName,
java.io.Reader reader,
long length)
Sets the designated parameter to a
Reader object. |
void |
setDate(java.lang.String parameterName,
java.sql.Date x)
Sets the designated parameter to the given
java.sql.Date value
using the default time zone of the virtual machine that is running
the application. |
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)
Sets the designated parameter to a
Reader object. |
void |
setNCharacterStream(java.lang.String parameterName,
java.io.Reader value,
long length)
Sets the designated parameter to a
Reader object. |
void |
setNClob(java.lang.String parameterName,
java.sql.NClob value)
Sets the designated parameter to a
java.sql.NClob object. |
void |
setNClob(java.lang.String parameterName,
java.io.Reader reader)
Sets the designated parameter to a
Reader object. |
void |
setNClob(java.lang.String parameterName,
java.io.Reader reader,
long length)
Sets the designated parameter to a
Reader object. |
void |
setNString(java.lang.String parameterName,
java.lang.String value)
Sets the designated parameter to the given
String object. |
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 |
setObject(java.lang.String parameterName,
java.lang.Object x,
java.sql.SQLType targetSqlType)
Sets the value of the designated parameter with the given object.
|
void |
setObject(java.lang.String parameterName,
java.lang.Object x,
java.sql.SQLType targetSqlType,
int scaleOrLength)
Sets the value of the designated parameter with the given object.
|
void |
setRowId(java.lang.String parameterName,
java.sql.RowId x)
Sets the designated parameter to the given
java.sql.RowId object. |
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)
Sets the designated parameter to the given
java.sql.SQLXML object. |
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()
Retrieves whether the last OUT parameter read had the value of
SQL
NULL . |
addBatch, 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, setURL
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getCallStack, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getGuid, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isWrapperFor, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, unwrap
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addBatch, 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, setURL
addBatch, 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, setQueryTimeout
public CallableStatementWrapper(ConnectionWrapper parent, java.sql.CallableStatement statement)
parent
- The connection that created this statement.statement
- This class basically wraps this object.public 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(int)
retrieves the value.
registerOutParameter
in interface java.sql.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.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if sqlType
is
a ARRAY
, BLOB
, CLOB
,
DATALINK
, JAVA_OBJECT
, NCHAR
,
NCLOB
, NVARCHAR
, LONGNVARCHAR
,
REF
, ROWID
, SQLXML
or STRUCT
data type and the JDBC driver does not support
this data typeTypes
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws java.sql.SQLException
parameterIndex
to be of 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.
This version of registerOutParameter
should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL
.
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onsqlType
- the SQL type code defined by java.sql.Types
.scale
- the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if sqlType
is
a ARRAY
, BLOB
, CLOB
,
DATALINK
, JAVA_OBJECT
, NCHAR
,
NCLOB
, NVARCHAR
, LONGNVARCHAR
,
REF
, ROWID
, SQLXML
or STRUCT
data type and the JDBC driver does not support
this data typeTypes
public boolean wasNull() throws java.sql.SQLException
NULL
. Note that this method should be called only after
calling a getter method; otherwise, there is no value to use in
determining whether it is null
or not.wasNull
in interface java.sql.CallableStatement
true
if the last parameter read was SQL
NULL
; false
otherwisejava.sql.SQLException
- if a database access error occurs or
this method is called on a closed CallableStatement
public 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 SQL
CHAR
value had in the
database, including any padding added by the database.
getString
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
,
the result
is null
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setString(java.lang.String, java.lang.String)
public boolean getBoolean(int parameterIndex) throws java.sql.SQLException
BIT
or BOOLEAN
parameter as a
boolean
in the Java programming language.getBoolean
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
,
the result is false
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setBoolean(java.lang.String, boolean)
public byte getByte(int parameterIndex) throws java.sql.SQLException
TINYINT
parameter
as a byte
in the Java programming language.getByte
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setByte(java.lang.String, byte)
public short getShort(int parameterIndex) throws java.sql.SQLException
SMALLINT
parameter
as a short
in the Java programming language.getShort
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setShort(java.lang.String, short)
public int getInt(int parameterIndex) throws java.sql.SQLException
INTEGER
parameter
as an int
in the Java programming language.getInt
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setInt(java.lang.String, int)
public long getLong(int parameterIndex) throws java.sql.SQLException
BIGINT
parameter
as a long
in the Java programming language.getLong
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setLong(java.lang.String, long)
public float getFloat(int parameterIndex) throws java.sql.SQLException
FLOAT
parameter
as a float
in the Java programming language.getFloat
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setFloat(java.lang.String, float)
public double getDouble(int parameterIndex) throws java.sql.SQLException
DOUBLE
parameter as a double
in the Java programming language.getDouble
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setDouble(java.lang.String, double)
@Deprecated public java.math.BigDecimal getBigDecimal(int parameterIndex, int scale) throws java.sql.SQLException
getBigDecimal(int parameterIndex)
or getBigDecimal(String parameterName)
NUMERIC
parameter as a
java.math.BigDecimal
object with scale digits to
the right of the decimal point.getBigDecimal
in interface java.sql.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetBigDecimal(java.lang.String, java.math.BigDecimal)
public 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.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setBytes(java.lang.String, byte[])
public java.sql.Date getDate(int parameterIndex) throws java.sql.SQLException
DATE
parameter as a
java.sql.Date
object.getDate
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setDate(java.lang.String, java.sql.Date)
public java.sql.Time getTime(int parameterIndex) throws java.sql.SQLException
TIME
parameter as a
java.sql.Time
object.getTime
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setTime(java.lang.String, java.sql.Time)
public java.sql.Timestamp getTimestamp(int parameterIndex) throws java.sql.SQLException
TIMESTAMP
parameter as a
java.sql.Timestamp
object.getTimestamp
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setTimestamp(java.lang.String, java.sql.Timestamp)
public java.lang.Object getObject(int parameterIndex) 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.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onjava.lang.Object
holding the OUT parameter valuejava.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
Types
,
setObject(java.lang.String, java.lang.Object, int, int)
public 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.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result is null
.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setBigDecimal(java.lang.String, java.math.BigDecimal)
public java.lang.Object getObject(int parameterIndex, java.util.Map<java.lang.String,java.lang.Class<?>> map) throws java.sql.SQLException
parameterIndex
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.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetObject(java.lang.String, java.lang.Object, int, int)
public java.sql.Ref getRef(int parameterIndex) throws java.sql.SQLException
REF(<structured-type>)
parameter as a Ref
object in the Java programming language.getRef
in interface java.sql.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.Blob getBlob(int parameterIndex) throws java.sql.SQLException
BLOB
parameter as a
Blob
object in the Java programming language.getBlob
in interface java.sql.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.Clob getClob(int parameterIndex) throws java.sql.SQLException
CLOB
parameter as a
java.sql.Clob
object in the Java programming language.getClob
in interface java.sql.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.Array getArray(int parameterIndex) throws java.sql.SQLException
ARRAY
parameter as an
Array
object in the Java programming language.getArray
in interface java.sql.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setDate(java.lang.String, java.sql.Date)
public 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.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setTime(java.lang.String, java.sql.Time)
public 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.CallableStatement
parameterIndex
- 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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
setTimestamp(java.lang.String, java.sql.Timestamp)
public void registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLException
registerOutParameter
should be used for a user-defined or REF
output parameter. Examples
of user-defined types include: STRUCT
, DISTINCT
,
JAVA_OBJECT
, and named array types.
All OUT parameters must be registered before a stored procedure is executed.
For a user-defined parameter, the fully-qualified SQL
type name of the parameter should also be given, while a REF
parameter requires that the fully-qualified type name of the
referenced type be given. A JDBC driver that does not need the
type code and type name information may ignore it. To be portable,
however, applications should always provide these values for
user-defined and REF
parameters.
Although it is intended for user-defined and REF
parameters,
this method may be used to register a parameter of any JDBC type.
If the parameter does not have a user-defined or REF
type, the
typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,...sqlType
- a value from Types
typeName
- the fully-qualified name of an SQL structured typejava.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if sqlType
is
a ARRAY
, BLOB
, CLOB
,
DATALINK
, JAVA_OBJECT
, NCHAR
,
NCLOB
, NVARCHAR
, LONGNVARCHAR
,
REF
, ROWID
, SQLXML
or STRUCT
data type and the JDBC driver does not support
this data typeTypes
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(int)
retrieves the value.
registerOutParameter
in interface java.sql.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.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if sqlType
is
a ARRAY
, BLOB
, CLOB
,
DATALINK
, JAVA_OBJECT
, NCHAR
,
NCLOB
, NVARCHAR
, LONGNVARCHAR
,
REF
, ROWID
, SQLXML
or STRUCT
data type and the JDBC driver does not support
this data type or if the JDBC driver does not support
this methodTypes
public void registerOutParameter(java.lang.String parameterName, int sqlType, int scale) throws java.sql.SQLException
parameterName
to be of 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.
This version of registerOutParameter
should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL
.
registerOutParameter
in interface java.sql.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.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if sqlType
is
a ARRAY
, BLOB
, CLOB
,
DATALINK
, JAVA_OBJECT
, NCHAR
,
NCLOB
, NVARCHAR
, LONGNVARCHAR
,
REF
, ROWID
, SQLXML
or STRUCT
data type and the JDBC driver does not support
this data type or if the JDBC driver does not support
this methodTypes
public 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.
All OUT parameters must be registered before a stored procedure is executed.
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.CallableStatement
parameterName
- the name of the parametersqlType
- a value from Types
typeName
- the fully-qualified name of an SQL structured typejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if sqlType
is
a ARRAY
, BLOB
, CLOB
,
DATALINK
, JAVA_OBJECT
, NCHAR
,
NCLOB
, NVARCHAR
, LONGNVARCHAR
,
REF
, ROWID
, SQLXML
or STRUCT
data type and the JDBC driver does not support
this data type or if the JDBC driver does not support
this methodTypes
public java.net.URL getURL(int parameterIndex) throws java.sql.SQLException
DATALINK
parameter as a
java.net.URL
object.getURL
in interface java.sql.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
parameterjava.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs,
this method is called on a closed CallableStatement
,
or if the URL being returned is
not a valid URL on the Java platformjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetURL(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.CallableStatement
parameterName
- the name of the parameterval
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs;
this method is called on a closed CallableStatement
or if a URL is malformedjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetURL(int)
public 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.CallableStatement
parameterName
- the name of the parametersqlType
- the SQL type code defined in java.sql.Types
java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setBoolean(java.lang.String parameterName, boolean x) throws java.sql.SQLException
boolean
value.
The driver converts this
to an SQL BIT
or BOOLEAN
value when it sends it to the database.setBoolean
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetBoolean(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetByte(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetShort(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetInt(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetLong(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetFloat(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetDouble(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetBigDecimal(int, int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetString(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetBytes(int)
public void setDate(java.lang.String parameterName, java.sql.Date x) throws java.sql.SQLException
java.sql.Date
value
using the default time zone of the virtual machine that is running
the application.
The driver converts this
to an SQL DATE
value when it sends it to the database.setDate
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetDate(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetTime(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetTimestamp(int)
public 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale) throws java.sql.SQLException
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
, NClob
,
Struct
, java.net.URL
,
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.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.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified targetSqlTypeTypes
,
getObject(int)
public void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType) throws java.sql.SQLException
setObject(String parameterName,
Object x, int targetSqlType, int scaleOrLength)
,
except that it assumes a scale of zero.setObject
in interface java.sql.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 databasejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified targetSqlTypegetObject(int)
public void setObject(java.lang.String parameterName, java.lang.Object x) throws java.sql.SQLException
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
, NClob
,
Struct
, java.net.URL
,
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.
Note: Not all databases allow for a non-typed Null to be sent to
the backend. For maximum portability, the setNull
or the
setObject(String parameterName, Object x, int sqlType)
method should be used
instead of setObject(String parameterName, Object x)
.
setObject
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the object containing the input parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs,
this method is called on a closed CallableStatement
or if the given
Object
parameter is ambiguousjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetObject(int)
public 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.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 streamjava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use
to construct the datejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetDate(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use
to construct the timejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetTime(int)
public 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.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use
to construct the timestampjava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodgetTimestamp(int)
public 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.
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.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
valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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 SQL
CHAR
value had in the
database, including any padding added by the database.
getString
in interface java.sql.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetString(java.lang.String, java.lang.String)
public boolean getBoolean(java.lang.String parameterName) throws java.sql.SQLException
BIT
or BOOLEAN
parameter as a
boolean
in the Java programming language.getBoolean
in interface java.sql.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is false
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetBoolean(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.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is 0
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetByte(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.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is 0
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetShort(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.CallableStatement
parameterName
- the name of the parameterNULL
,
the result is 0
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetInt(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.CallableStatement
parameterName
- the name of the parameterNULL
,
the result is 0
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetLong(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.CallableStatement
parameterName
- the name of the parameterNULL
,
the result is 0
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetFloat(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.CallableStatement
parameterName
- the name of the parameterNULL
,
the result is 0
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetDouble(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.CallableStatement
parameterName
- the name of the parameterNULL
, the result is
null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetBytes(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.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetDate(java.lang.String, java.sql.Date)
public 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.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetTime(java.lang.String, java.sql.Time)
public 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.CallableStatement
parameterName
- the name of the parameterNULL
, the result
is null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetTimestamp(java.lang.String, java.sql.Timestamp)
public 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.CallableStatement
parameterName
- the name of the parameterjava.lang.Object
holding the OUT parameter value.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodTypes
,
setObject(java.lang.String, java.lang.Object, int, int)
public 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.CallableStatement
parameterName
- the name of the parameterNULL
, the result is null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetBigDecimal(java.lang.String, java.math.BigDecimal)
public java.lang.Object getObject(java.lang.String parameterName, java.util.Map<java.lang.String,java.lang.Class<?>> map) throws java.sql.SQLException
parameterName
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.CallableStatement
parameterName
- the name of the parametermap
- the mapping from SQL type names to Java classesjava.lang.Object
holding the OUT parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetObject(java.lang.String, java.lang.Object, int, int)
public 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.Clob getClob(java.lang.String parameterName) throws java.sql.SQLException
CLOB
parameter as a
java.sql.Clob
object in the Java programming language.getClob
in interface java.sql.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic 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.CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use
to construct the dateNULL
,
the result is null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetDate(java.lang.String, java.sql.Date)
public 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.CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use
to construct the timeNULL
, the result is
null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetTime(java.lang.String, java.sql.Time)
public 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.CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use
to construct the timestampNULL
, the result is
null
.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetTimestamp(java.lang.String, java.sql.Timestamp)
public 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs,
this method is called on a closed CallableStatement
,
or if there is a problem with the URLjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetURL(java.lang.String, java.net.URL)
public java.sql.RowId getRowId(int parameterIndex) throws java.sql.SQLException
ROWID
parameter as a
java.sql.RowId
object.getRowId
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,...RowId
object that represents the JDBC ROWID
value is used as the designated parameter. If the parameter contains
a SQL NULL
, then a null
value is returned.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.RowId getRowId(java.lang.String parameterName) throws java.sql.SQLException
ROWID
parameter as a
java.sql.RowId
object.getRowId
in interface java.sql.CallableStatement
parameterName
- the name of the parameterRowId
object that represents the JDBC ROWID
value is used as the designated parameter. If the parameter contains
a SQL NULL
, then a null
value is returned.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setRowId(java.lang.String parameterName, java.sql.RowId x) throws java.sql.SQLException
java.sql.RowId
object. The
driver converts this to a SQL ROWID
when it sends it to the
database.setRowId
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setNString(java.lang.String parameterName, java.lang.String value) throws java.sql.SQLException
String
object.
The driver converts this to a SQL NCHAR
or
NVARCHAR
or LONGNVARCHAR
setNString
in interface java.sql.CallableStatement
parameterName
- the name of the parameter to be setvalue
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length) throws java.sql.SQLException
Reader
object. The
Reader
reads the data till end-of-file is reached. The
driver does the necessary conversion from Java character format to
the national character set in the database.setNCharacterStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameter to be setvalue
- the parameter valuelength
- the number of characters in the parameter data.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setNClob(java.lang.String parameterName, java.sql.NClob value) throws java.sql.SQLException
java.sql.NClob
object. The object
implements the java.sql.NClob
interface. This NClob
object maps to a SQL NCLOB
.setNClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameter to be setvalue
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setClob(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLException
Reader
object. The reader
must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the CallableStatement
is executed.
This method differs from the setCharacterStream (int, Reader, int)
method
because it informs the driver that the parameter value should be sent to
the server as a CLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR
or a CLOB
setClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameter to be setreader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the length specified is less than zero;
a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length) throws java.sql.SQLException
InputStream
object. The inputstream
must contain the number
of characters specified by length, otherwise a SQLException
will be
generated when the CallableStatement
is executed.
This method differs from the setBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB
. When the setBinaryStream
method is used,
the driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARBINARY
or a BLOB
setBlob
in interface java.sql.CallableStatement
parameterName
- the name of the parameter to be set
the second is 2, ...inputStream
- An object that contains the data to set the parameter
value to.length
- the number of bytes in the parameter data.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the length specified
is less than zero; if the number of bytes in the inputstream does not match
the specified length; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setNClob(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLException
Reader
object. The reader
must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the CallableStatement
is executed.
This method differs from the setCharacterStream (int, Reader, int)
method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR
or a NCLOB
setNClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameter to be setreader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the length specified is less than zero;
if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.NClob getNClob(int parameterIndex) throws java.sql.SQLException
NCLOB
parameter as a
java.sql.NClob
object in the Java programming language.getNClob
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and
so onNClob
object in the
Java programming language. If the value was SQL NULL
, the
value null
is returned.java.sql.SQLException
- if the parameterIndex is not valid;
if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.NClob getNClob(java.lang.String parameterName) throws java.sql.SQLException
NCLOB
parameter as a
java.sql.NClob
object in the Java programming language.getNClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameterNClob
object in the
Java programming language. If the value was SQL NULL
,
the value null
is returned.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setSQLXML(java.lang.String parameterName, java.sql.SQLXML xmlObject) throws java.sql.SQLException
java.sql.SQLXML
object. The driver converts this to an
SQL XML
value when it sends it to the database.setSQLXML
in interface java.sql.CallableStatement
parameterName
- the name of the parameterxmlObject
- a SQLXML
object that maps an SQL XML
valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs;
this method is called on a closed CallableStatement
or
the java.xml.transform.Result
,
Writer
or OutputStream
has not been closed for the SQLXML
objectjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.SQLXML getSQLXML(int parameterIndex) throws java.sql.SQLException
SQL XML
parameter as a
java.sql.SQLXML
object in the Java programming language.getSQLXML
in interface java.sql.CallableStatement
parameterIndex
- index of the first parameter is 1, the second is 2, ...SQLXML
object that maps an SQL XML
valuejava.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.SQLXML getSQLXML(java.lang.String parameterName) throws java.sql.SQLException
SQL XML
parameter as a
java.sql.SQLXML
object in the Java programming language.getSQLXML
in interface java.sql.CallableStatement
parameterName
- the name of the parameterSQLXML
object that maps an SQL XML
valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.lang.String getNString(int parameterIndex) throws java.sql.SQLException
NCHAR
,
NVARCHAR
or LONGNVARCHAR
parameter as
a String
in the Java programming language.
For the fixed-length type JDBC NCHAR
,
the String
object
returned has exactly the same value the SQL
NCHAR
value had in the
database, including any padding added by the database.
getNString
in interface java.sql.CallableStatement
parameterIndex
- index of the first parameter is 1, the second is 2, ...String
object that maps an
NCHAR
, NVARCHAR
or LONGNVARCHAR
valuejava.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetNString(java.lang.String, java.lang.String)
public java.lang.String getNString(java.lang.String parameterName) throws java.sql.SQLException
NCHAR
,
NVARCHAR
or LONGNVARCHAR
parameter as
a String
in the Java programming language.
For the fixed-length type JDBC NCHAR
,
the String
object
returned has exactly the same value the SQL
NCHAR
value had in the
database, including any padding added by the database.
getNString
in interface java.sql.CallableStatement
parameterName
- the name of the parameterString
object that maps an
NCHAR
, NVARCHAR
or LONGNVARCHAR
valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodsetNString(java.lang.String, java.lang.String)
public java.io.Reader getNCharacterStream(int parameterIndex) throws java.sql.SQLException
java.io.Reader
object in the Java programming language.
It is intended for use when
accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
parameters.getNCharacterStream
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, ...java.io.Reader
object that contains the parameter
value; if the value is SQL NULL
, the value returned is
null
in the Java programming language.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.io.Reader getNCharacterStream(java.lang.String parameterName) throws java.sql.SQLException
java.io.Reader
object in the Java programming language.
It is intended for use when
accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
parameters.getNCharacterStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameterjava.io.Reader
object that contains the parameter
value; if the value is SQL NULL
, the value returned is
null
in the Java programming languagejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.io.Reader getCharacterStream(int parameterIndex) throws java.sql.SQLException
java.io.Reader
object in the Java programming language.getCharacterStream
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, ...java.io.Reader
object that contains the parameter
value; if the value is SQL NULL
, the value returned is
null
in the Java programming language.java.sql.SQLException
- if the parameterIndex is not valid; if a database access error occurs or
this method is called on a closed CallableStatement
public java.io.Reader getCharacterStream(java.lang.String parameterName) throws java.sql.SQLException
java.io.Reader
object in the Java programming language.getCharacterStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameterjava.io.Reader
object that contains the parameter
value; if the value is SQL NULL
, the value returned is
null
in the Java programming languagejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setBlob(java.lang.String parameterName, java.sql.Blob x) throws java.sql.SQLException
java.sql.Blob
object.
The driver converts this to an SQL BLOB
value when it
sends it to the database.setBlob
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- a Blob
object that maps an SQL BLOB
valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setClob(java.lang.String parameterName, java.sql.Clob x) throws java.sql.SQLException
java.sql.Clob
object.
The driver converts this to an SQL CLOB
value when it
sends it to the database.setClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- a Clob
object that maps an SQL CLOB
valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, long 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, long 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.CallableStatement
parameterName
- 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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, long 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.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 streamjava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setAsciiStream(java.lang.String parameterName, java.io.InputStream x) 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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.
setAsciiStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the Java input stream that contains the ASCII parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic void setBinaryStream(java.lang.String parameterName, java.io.InputStream x) 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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.
setBinaryStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic void setCharacterStream(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLException
Reader
object.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.
setCharacterStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameterreader
- the java.io.Reader
object that contains the
Unicode datajava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic void setNCharacterStream(java.lang.String parameterName, java.io.Reader value) throws java.sql.SQLException
Reader
object. The
Reader
reads the data till end-of-file is reached. The
driver does the necessary conversion from Java character format to
the national character set in the database.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNCharacterStream
which takes a length parameter.
setNCharacterStream
in interface java.sql.CallableStatement
parameterName
- the name of the parametervalue
- the parameter valuejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the driver does not support national
character sets; if the driver can detect that a data conversion
error could occur; if a database access error occurs; or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic void setClob(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLException
Reader
object.
This method differs from the setCharacterStream (int, Reader)
method
because it informs the driver that the parameter value should be sent to
the server as a CLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR
or a CLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setClob
which takes a length parameter.
setClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameterreader
- An object that contains the data to set the parameter value to.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or this method is called on
a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic void setBlob(java.lang.String parameterName, java.io.InputStream inputStream) throws java.sql.SQLException
InputStream
object.
This method differs from the setBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB
. When the setBinaryStream
method is used,
the driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARBINARY
or a BLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBlob
which takes a length parameter.
setBlob
in interface java.sql.CallableStatement
parameterName
- the name of the parameterinputStream
- An object that contains the data to set the parameter
value to.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic void setNClob(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLException
Reader
object.
This method differs from the setCharacterStream (int, Reader)
method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR
or a NCLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNClob
which takes a length parameter.
setNClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameterreader
- An object that contains the data to set the parameter value to.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if the driver does not support national character sets;
if the driver can detect that a data conversion
error could occur; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic <T> T getObject(int parameterIndex, java.lang.Class<T> type) throws java.sql.SQLException
Returns an object representing the value of OUT parameter
parameterIndex
and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. If the conversion is not
supported or null is specified for the type, a
SQLException
is thrown.
At a minimum, an implementation must support the conversions defined in
Appendix B, Table B-3 and conversion of appropriate user defined SQL
types to a Java type which implements SQLData
, or Struct
.
Additional conversions may be supported and are vendor defined.
getObject
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so ontype
- Class representing the Java data type to convert the
designated parameter to.type
holding the OUT parameter valuejava.sql.SQLException
- if conversion is not supported, type is null or
another error occurs. The getCause() method of the
exception may provide a more detailed exception, for example, if
a conversion error occursjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic <T> T getObject(java.lang.String parameterName, java.lang.Class<T> type) throws java.sql.SQLException
Returns an object representing the value of OUT parameter
parameterName
and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. If the conversion is not
supported or null is specified for the type, a
SQLException
is thrown.
At a minimum, an implementation must support the conversions defined in
Appendix B, Table B-3 and conversion of appropriate user defined SQL
types to a Java type which implements SQLData
, or Struct
.
Additional conversions may be supported and are vendor defined.
getObject
in interface java.sql.CallableStatement
parameterName
- the name of the parametertype
- Class representing the Java data type to convert
the designated parameter to.type
holding the OUT parameter
valuejava.sql.SQLException
- if conversion is not supported, type is null or
another error occurs. The getCause() method of the
exception may provide a more detailed exception, for example, if
a conversion error occursjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic void setObject(java.lang.String parameterName, java.lang.Object x, java.sql.SQLType targetSqlType, int scaleOrLength) throws java.sql.SQLException
Sets the value of the designated parameter with the given object.
If the second argument is an InputStream
then the stream
must contain the number of bytes specified by scaleOrLength.
If the second argument is a Reader
then the reader must
contain the number of characters specified
by scaleOrLength. If these conditions are not true the driver
will generate a
SQLException
when the prepared statement is executed.
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
, NClob
,
Struct
, java.net.URL
,
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 database-specific abstract data types.
The default implementation will throw SQLFeatureNotSupportedException
setObject
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the object containing the input parameter valuetargetSqlType
- the SQL type to be
sent to the database. The scale argument may further qualify this type.scaleOrLength
- for java.sql.JDBCType.DECIMAL
or java.sql.JDBCType.NUMERIC types
,
this is the number of digits after the decimal point. For
Java Object types InputStream
and Reader
,
this is the length
of the data in the stream or reader. For all other types,
this value will be ignored.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs
or this method is called on a closed CallableStatement
or
if the Java Object specified by x is an InputStream
or Reader object and the value of the scale parameter is less
than zerojava.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified targetSqlTypeJDBCType
,
SQLType
public void setObject(java.lang.String parameterName, java.lang.Object x, java.sql.SQLType targetSqlType) throws java.sql.SQLException
setObject(String parameterName,
Object x, SQLType targetSqlType, int scaleOrLength)
,
except that it assumes a scale of zero.
The default implementation will throw SQLFeatureNotSupportedException
setObject
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the object containing the input parameter valuetargetSqlType
- the SQL type to be sent to the databasejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs
or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified targetSqlTypeJDBCType
,
SQLType
public void registerOutParameter(int parameterIndex, java.sql.SQLType 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
may be JDBCType.OTHER
or a SQLType
that is supported by
the JDBC driver. The method
getObject(int)
retrieves the value.
The default implementation will throw SQLFeatureNotSupportedException
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onsqlType
- the JDBC type code defined by SQLType
to use to
register the OUT Parameter.
If the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL
, the version of
registerOutParameter
that accepts a scale value
should be used.java.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified sqlTypeJDBCType
,
SQLType
public void registerOutParameter(int parameterIndex, java.sql.SQLType sqlType, int scale) throws java.sql.SQLException
parameterIndex
to be of 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.
This version of registerOutParameter
should be
used when the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL
.
The default implementation will throw SQLFeatureNotSupportedException
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onsqlType
- the JDBC type code defined by SQLType
to use to
register the OUT Parameter.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 the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified sqlTypeJDBCType
,
SQLType
public void registerOutParameter(int parameterIndex, java.sql.SQLType sqlType, java.lang.String typeName) throws java.sql.SQLException
registerOutParameter
should be used for a user-defined or REF
output parameter.
Examples
of user-defined types include: STRUCT
, DISTINCT
,
JAVA_OBJECT
, and named array types.
All OUT parameters must be registered before a stored procedure is executed.
For a user-defined parameter, the fully-qualified SQL
type name of the parameter should also be given, while a REF
parameter requires that the fully-qualified type name of the
referenced type be given. A JDBC driver that does not need the
type code and type name information may ignore it. To be portable,
however, applications should always provide these values for
user-defined and REF
parameters.
Although it is intended for user-defined and REF
parameters,
this method may be used to register a parameter of any JDBC type.
If the parameter does not have a user-defined or REF
type, the
typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
The default implementation will throw SQLFeatureNotSupportedException
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,...sqlType
- the JDBC type code defined by SQLType
to use to
register the OUT Parameter.typeName
- the fully-qualified name of an SQL structured typejava.sql.SQLException
- if the parameterIndex is not valid;
if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified sqlTypeJDBCType
,
SQLType
public void registerOutParameter(java.lang.String parameterName, java.sql.SQLType 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 JDBCType.OTHER
or a SQLType
that is supported
by the JDBC driver.. The method
getObject(int)
retrieves the value.
The default implementation will throw SQLFeatureNotSupportedException
registerOutParameter
in interface java.sql.CallableStatement
parameterName
- the name of the parametersqlType
- the JDBC type code defined by SQLType
to use to
register the OUT Parameter.
If the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL
, the version of
registerOutParameter
that accepts a scale value
should be used.java.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified sqlType
or if the JDBC driver does not support
this methodJDBCType
,
SQLType
public void registerOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, int scale) throws java.sql.SQLException
parameterName
to be of 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.
This version of registerOutParameter
should be
used when the parameter is of JDBC type JDBCType.NUMERIC
or JDBCType.DECIMAL
.
The default implementation will throw SQLFeatureNotSupportedException
registerOutParameter
in interface java.sql.CallableStatement
parameterName
- the name of the parametersqlType
- the JDBC type code defined by SQLType
to use to
register the OUT Parameter.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 parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified sqlType
or if the JDBC driver does not support
this methodJDBCType
,
SQLType
public void registerOutParameter(java.lang.String parameterName, java.sql.SQLType 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.
All OUT parameters must be registered before a stored procedure is executed.
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.
The default implementation will throw SQLFeatureNotSupportedException
registerOutParameter
in interface java.sql.CallableStatement
parameterName
- the name of the parametersqlType
- the JDBC type code defined by SQLType
to use to
register the OUT Parameter.typeName
- the fully-qualified name of an SQL structured typejava.sql.SQLException
- if parameterName does not correspond to a named
parameter; if a database access error occurs or
this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException
- if
the JDBC driver does not support the specified sqlType
or if the JDBC driver does not support this methodJDBCType
,
SQLType
Copyright © 2002-2021 Windward Studios, LLC. - All Rights Reserved. We are Java document generation software