|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.objectweb.cjdbc.driver.Statement org.objectweb.cjdbc.driver.PreparedStatement org.objectweb.cjdbc.driver.CallableStatement
This class is used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. The only syntax accepted by this implementation is as follows:
{call <procedure-name>[<arg1>,<arg2>, ...]}The other standard form
{?= call <procedure-name>[<arg1>,<arg2>, ...]}is *NOT* supported. Parameters are referred to sequentially, by number, with the first parameter being 1. IN parameter values are set using the
set
methods inherited from PreparedStatement
.
OUT parameters are *NOT* supported.
A CallableStatement
can return one DriverResultSet
object or multiple ResultSet
objects. Multiple
ResultSet
objects are handled using operations inherited from
Statement
.
Connection.prepareCall(String)
,
DriverResultSet
Nested Class Summary |
Nested classes inherited from class org.objectweb.cjdbc.driver.PreparedStatement |
|
Field Summary |
Fields inherited from class org.objectweb.cjdbc.driver.PreparedStatement |
BIG_DECIMAL_TAG, BLOB_TAG, BOOLEAN_TAG, BYTE_TAG, BYTES_TAG, CLOB_TAG, DATE_TAG, DOUBLE_TAG, END_PARAM_TAG, FLOAT_TAG, INTEGER_TAG, LONG_TAG, NULL_STRING_TAG, NULL_TAG, OBJECT_TAG, REF_TAG, SHORT_TAG, sql, START_PARAM_TAG, STRING_TAG, TAG_MARKER, TAG_MARKER_ESCAPE, TIME_TAG, TIMESTAMP_TAG, URL_TAG |
Fields inherited from class org.objectweb.cjdbc.driver.Statement |
batch, connection, escapeProcessing, generatedKeys, generatedKeysFlag, result, updateCount |
Fields inherited from interface java.sql.Statement |
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
Constructor Summary | |
CallableStatement(Connection connection,
java.lang.String sql)
CallableStatements syntax is {call procedure_name[(? |
Method Summary | |
java.sql.Array |
getArray(int i)
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 i)
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 parameter as
a boolean in the Java programming language. |
boolean |
getBoolean(java.lang.String parameterName)
Retrieves the value of a JDBC BIT parameter as a
boolean in the Java programming language. |
byte |
getByte(int parameterIndex)
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.sql.Clob |
getClob(int i)
Retrieves the value of the designated JDBC CLOB parameter as
a Clob object in the Java programming language. |
java.sql.Clob |
getClob(java.lang.String parameterName)
Retrieves the value of a JDBC CLOB parameter as a
Clob object in the Java programming language. |
java.sql.Date |
getDate(int parameterIndex)
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.lang.Object |
getObject(int parameterIndex)
Retrieves the value of the designated parameter as an Object
in the Java programming language. |
java.lang.Object |
getObject(int i,
java.util.Map map)
Returns an object representing the value of OUT parameter i
and uses map for the custom mapping of the parameter value.
|
java.lang.Object |
getObject(java.lang.String parameterName)
Retrieves the value of a parameter as an Object in the Java
programming language. |
java.lang.Object |
getObject(java.lang.String parameterName,
java.util.Map map)
Returns an object representing the value of OUT parameter i
and uses map for the custom mapping of the parameter value.
|
java.sql.Ref |
getRef(int i)
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. |
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.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 paramIndex,
int sqlType,
java.lang.String typeName)
Registers the designated output parameter. |
void |
registerOutParameter(java.lang.String parameterName,
int sqlType)
Registers the OUT parameter named parameterName to the JDBC
type sqlType . |
void |
registerOutParameter(java.lang.String parameterName,
int sqlType,
int scale)
Registers the parameter named parameterName to be of JDBC
type sqlType . |
void |
registerOutParameter(java.lang.String parameterName,
int sqlType,
java.lang.String typeName)
Registers the designated output parameter. |
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x,
int 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,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
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,
int length)
Sets the designated parameter to the given Reader object,
which is the given number of characters long. |
void |
setDate(java.lang.String parameterName,
java.sql.Date x)
Sets the designated parameter to the given java.sql.Date
value. |
void |
setDate(java.lang.String parameterName,
java.sql.Date x,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Date
value, using the given Calendar object. |
void |
setDouble(java.lang.String parameterName,
double x)
Sets the designated parameter to the given Java double
value. |
void |
setFloat(java.lang.String parameterName,
float x)
Sets the designated parameter to the given Java float value.
|
void |
setInt(java.lang.String parameterName,
int x)
Sets the designated parameter to the given Java int value.
|
void |
setLong(java.lang.String parameterName,
long x)
Sets the designated parameter to the given Java long value.
|
void |
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 |
setShort(java.lang.String parameterName,
short x)
Sets the designated parameter to the given Java short value.
|
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 . |
Methods inherited from class org.objectweb.cjdbc.driver.PreparedStatement |
addBatch, clearParameters, close, compileQuery, doEscapeProcessing, execute, executeBatch, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setGeneratedKeysFlag, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setPreparedStatement, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.sql.PreparedStatement |
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL |
Methods inherited from interface java.sql.Statement |
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout |
Constructor Detail |
public CallableStatement(Connection connection, java.lang.String sql) throws java.sql.SQLException
CallableStatements
syntax is {call procedure_name[(?, ?,
...)]}. Note that {? = call ...} is not supported by this implementation.
connection
- the instanatiating connectionsql
- the SQL statement with ? for IN markers
java.sql.SQLException
- if something bad occursMethod Detail |
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 a database access error occursTypes
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws java.sql.SQLException
parameterIndex
to be of JDBC type sqlType
. This method must be called
before a stored procedure is executed.
The JDBC type specified by sqlType
for an OUT parameter
determines the Java type that must be used in the get
method
to read the value of that parameter.
This version of registerOutParameter
should be used when the
parameter is of JDBC type NUMERIC
or DECIMAL
.
registerOutParameter
in interface java.sql.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 a database access error occursTypes
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
otherwise
java.sql.SQLException
- if a database access error occurspublic java.lang.String getString(int parameterIndex) throws java.sql.SQLException
CHAR
,
VARCHAR
, or LONGVARCHAR
parameter as a
String
in the Java programming language.
For the fixed-length type JDBC CHAR
, the
String
object returned has exactly the same value the JDBC
CHAR
value had in the database, including any padding added
by the database.
getString
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so on
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetString(java.lang.String, java.lang.String)
public boolean getBoolean(int parameterIndex) throws java.sql.SQLException
BIT
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 on
NULL
, the
result is false
.
java.sql.SQLException
- if a database access error occurssetBoolean(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 on
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetByte(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 on
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetShort(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 on
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetInt(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 on
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetLong(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 on
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetFloat(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 on
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetDouble(java.lang.String, double)
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 point
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetBigDecimal(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 on
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetBytes(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 on
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetDate(String, 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 on
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTime(String, 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 on
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTimestamp(String, 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 on
java.lang.Object
holding the OUT parameter value
java.sql.SQLException
- if a database access error occursTypes
,
setObject(String, Object)
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 on
NULL
, the result is null
.
java.sql.SQLException
- if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)
public java.lang.Object getObject(int i, java.util.Map map) throws java.sql.SQLException
i
and uses map
for the custom mapping of the parameter value.
This method returns a Java object whose type corresponds to the JDBC type
that was registered for this parameter using the method
registerOutParameter
. By registering the target JDBC type
as java.sql.Types.OTHER
, this method can be used to read
database-specific abstract data types.
getObject
in interface java.sql.CallableStatement
i
- the first parameter is 1, the second is 2, and so onmap
- the mapping from SQL type names to Java classes
java.lang.Object
holding the OUT parameter value
java.sql.SQLException
- if a database access error occurssetObject(String, Object)
public java.sql.Ref getRef(int i) throws java.sql.SQLException
REF(<structured-type>)
parameter as a Ref
object in the Java programming language.
getRef
in interface java.sql.CallableStatement
i
- the first parameter is 1, the second is 2, and so on
Ref
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Blob getBlob(int i) throws java.sql.SQLException
BLOB
parameter as
a Blob
object in the Java programming language.
getBlob
in interface java.sql.CallableStatement
i
- the first parameter is 1, the second is 2, and so on
Blob
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Clob getClob(int i) throws java.sql.SQLException
CLOB
parameter as
a Clob
object in the Java programming language.
getClob
in interface java.sql.CallableStatement
i
- the first parameter is 1, the second is 2, and so on
Clob
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Array getArray(int i) throws java.sql.SQLException
ARRAY
parameter
as an Array
object in the Java programming language.
getArray
in interface java.sql.CallableStatement
i
- the first parameter is 1, the second is 2, and so on
Array
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic 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 date
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetDate(String, 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 time
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTime(String, 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 timestamp
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTimestamp(String, Timestamp)
public void registerOutParameter(int paramIndex, 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.
Before executing a stored procedure call, you must explicitly call
registerOutParameter
to register the type from
java.sql.Types
for each OUT parameter. For a user-defined
parameter, the fully-qualified SQL type name of the parameter should also
be given, while a REF
parameter requires that the
fully-qualified type name of the referenced type be given. A JDBC driver
that does not need the type code and type name information may ignore it.
To be portable, however, applications should always provide these values
for user-defined and REF
parameters.
Although it is intended for user-defined and REF
parameters,
this method may be used to register a parameter of any JDBC type. If the
parameter does not have a user-defined or REF
type, the
typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
registerOutParameter
in interface java.sql.CallableStatement
paramIndex
- the first parameter is 1, the second is 2,...sqlType
- a value from Types
typeName
- the fully-qualified name of an SQL structured type
java.sql.SQLException
- if a database access error occursTypes
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(String)
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 a database access error occursTypes
public void registerOutParameter(java.lang.String parameterName, int sqlType, int scale) throws java.sql.SQLException
parameterName
to be of JDBC
type sqlType
. This method must be called before a stored
procedure is executed.
The JDBC type specified by sqlType
for an OUT parameter
determines the Java type that must be used in the get
method
to read the value of that parameter.
This version of registerOutParameter
should be used when the
parameter is of JDBC type NUMERIC
or DECIMAL
.
registerOutParameter
in interface java.sql.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 a database access error occursTypes
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.
Before executing a stored procedure call, you must explicitly call
registerOutParameter
to register the type from
java.sql.Types
for each OUT parameter. For a user-named
parameter the fully-qualified SQL type name of the parameter should also be
given, while a REF parameter requires that the fully-qualified type name of
the referenced type be given. A JDBC driver that does not need the type
code and type name information may ignore it. To be portable, however,
applications should always provide these values for user-named and REF
parameters.
Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the
getXXX
method whose Java type XXX corresponds to the
parameter's registered SQL type.
registerOutParameter
in interface java.sql.CallableStatement
parameterName
- the name of the parametersqlType
- a value from Types
typeName
- the fully-qualified name of an SQL structured type
java.sql.SQLException
- if a database access error occursTypes
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 parameter
java.sql.SQLException
- if a database access error occurs, or if the URL
being returned is not a valid URL on the Java platformsetURL(java.lang.String, java.net.URL)
public void setURL(java.lang.String parameterName, java.net.URL val) throws java.sql.SQLException
java.net.URL
object. The driver converts this to an SQL DATALINK
value
when it sends it to the database.
setURL
in interface java.sql.CallableStatement
parameterName
- the name of the parameterval
- the parameter value
java.sql.SQLException
- if a database access error occurs, or if a URL is
malformedgetURL(String)
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 a database access error occurspublic void setBoolean(java.lang.String parameterName, boolean x) throws java.sql.SQLException
boolean
value. The driver converts this to an SQL BIT
value when it
sends it to the database.
setBoolean
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the parameter value
java.sql.SQLException
- if a database access error occursgetBoolean(String)
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 value
java.sql.SQLException
- if a database access error occursgetByte(String)
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 value
java.sql.SQLException
- if a database access error occursgetShort(String)
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 value
java.sql.SQLException
- if a database access error occursgetInt(String)
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 value
java.sql.SQLException
- if a database access error occursgetLong(String)
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 value
java.sql.SQLException
- if a database access error occursgetFloat(String)
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 value
java.sql.SQLException
- if a database access error occursgetDouble(String)
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 value
java.sql.SQLException
- if a database access error occursgetBigDecimal(String)
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 value
java.sql.SQLException
- if a database access error occursgetString(String)
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 value
java.sql.SQLException
- if a database access error occursgetBytes(String)
public void setDate(java.lang.String parameterName, java.sql.Date x) throws java.sql.SQLException
java.sql.Date
value. The driver converts this to an SQL DATE
value when it
sends it to the database.
setDate
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the parameter value
java.sql.SQLException
- if a database access error occursgetDate(String)
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 value
java.sql.SQLException
- if a database access error occursgetTime(String)
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 value
java.sql.SQLException
- if a database access error occursgetTimestamp(String)
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 stream
java.sql.SQLException
- if a database access error occurspublic void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length) throws java.sql.SQLException
LONGVARBINARY
parameter, it may be more practical to send it
via a java.io.InputStream
object. The data will be read from
the stream as needed until end-of-file is reached.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
setBinaryStream
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream
java.sql.SQLException
- if a database access error occurspublic void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale) throws java.sql.SQLException
java.lang
equivalent objects should be used.
The given Java object will be converted to the given
targetSqlType
before being sent to the database.
If the object has a custom mapping (is of a class implementing the
interface SQLData
), the JDBC driver should call the method
SQLData.writeSQL
to write it to the SQL data stream. If, on
the other hand, the object is of a class implementing Ref
,
Blob
,Clob
,Struct
, or
Array
, the driver should pass it to the database as a value
of the corresponding SQL type.
Note that this method may be used to pass datatabase-specific abstract data types.
setObject
in interface java.sql.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 a database access error occursTypes
,
getObject(String, Map)
public void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType) throws java.sql.SQLException
setObject
above, except that it
assumes a scale of zero.
setObject
in interface java.sql.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
java.sql.SQLException
- if a database access error occursgetObject(String, Map)
public void setObject(java.lang.String parameterName, java.lang.Object x) throws java.sql.SQLException
Object
; therefore, the
java.lang
equivalent objects should be used for built-in
types.
The JDBC specification specifies a standard mapping from Java
Object
types to SQL types. The given argument will be
converted to the corresponding SQL type before being sent to the database.
Note that this method may be used to pass datatabase-specific abstract data types, by using a driver-specific Java type.
If the object is of a class implementing the interface SQLData
,
the JDBC driver should call the method SQLData.writeSQL
to
write it to the SQL data stream. If, on the other hand, the object is of a
class implementing Ref
,Blob
,
Clob
,Struct
, or Array
, the
driver should pass it to the database as a value of the corresponding SQL
type.
This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
setObject
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the object containing the input parameter value
java.sql.SQLException
- if a database access error occurs or if the given
Object
parameter is ambiguousgetObject(String, Map)
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 stream
java.sql.SQLException
- if a database access error occurspublic void setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal) throws java.sql.SQLException
java.sql.Date
value, using the given Calendar
object. The driver uses the
Calendar
object to construct an SQL DATE
value, which the driver then sends to the database. With a a
Calendar
object, the driver can calculate the date taking
into account a custom timezone. If no Calendar
object is
specified, the driver uses the default timezone, which is that of the
virtual machine running the application.
setDate
in interface java.sql.CallableStatement
parameterName
- the name of the parameterx
- the parameter valuecal
- the Calendar
object the driver will use to
construct the date
java.sql.SQLException
- if a database access error occursgetDate(String, Calendar)
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 time
java.sql.SQLException
- if a database access error occursgetTime(String, Calendar)
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 timestamp
java.sql.SQLException
- if a database access error occursgetTimestamp(String, Calendar)
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. If a JDBC driver does not need the type code or type name information, it may ignore it.
Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
setNull
in interface java.sql.CallableStatement
parameterName
- the name of the parametersqlType
- a value from java.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type;
ignored if the parameter is not a user-defined type or SQL
REF
value
java.sql.SQLException
- if a database access error occurspublic java.lang.String getString(java.lang.String parameterName) throws java.sql.SQLException
CHAR
,VARCHAR
,
or LONGVARCHAR
parameter as a String
in the
Java programming language.
For the fixed-length type JDBC CHAR
, the
String
object returned has exactly the same value the JDBC
CHAR
value had in the database, including any padding added
by the database.
getString
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetString(java.lang.String, java.lang.String)
public boolean getBoolean(java.lang.String parameterName) throws java.sql.SQLException
BIT
parameter as a
boolean
in the Java programming language.
getBoolean
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is false
.
java.sql.SQLException
- if a database access error occurssetBoolean(java.lang.String, boolean)
public byte getByte(java.lang.String parameterName) throws java.sql.SQLException
TINYINT
parameter as a
byte
in the Java programming language.
getByte
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetByte(java.lang.String, byte)
public short getShort(java.lang.String parameterName) throws java.sql.SQLException
SMALLINT
parameter as a
short
in the Java programming language.
getShort
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetShort(java.lang.String, short)
public int getInt(java.lang.String parameterName) throws java.sql.SQLException
INTEGER
parameter as an
int
in the Java programming language.
getInt
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetInt(java.lang.String, int)
public long getLong(java.lang.String parameterName) throws java.sql.SQLException
BIGINT
parameter as a
long
in the Java programming language.
getLong
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetLong(java.lang.String, long)
public float getFloat(java.lang.String parameterName) throws java.sql.SQLException
FLOAT
parameter as a
float
in the Java programming language.
getFloat
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetFloat(java.lang.String, float)
public double getDouble(java.lang.String parameterName) throws java.sql.SQLException
DOUBLE
parameter as a
double
in the Java programming language.
getDouble
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is 0
.
java.sql.SQLException
- if a database access error occurssetDouble(java.lang.String, double)
public byte[] getBytes(java.lang.String parameterName) throws java.sql.SQLException
BINARY
or
VARBINARY
parameter as an array of byte
values in the Java programming language.
getBytes
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetBytes(java.lang.String, byte[])
public java.sql.Date getDate(java.lang.String parameterName) throws java.sql.SQLException
DATE
parameter as a
java.sql.Date
object.
getDate
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetDate(String, 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 parameter
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTime(String, 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 parameter
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTimestamp(String, 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 parameter
java.lang.Object
holding the OUT parameter value.
java.sql.SQLException
- if a database access error occursTypes
,
setObject(String, Object)
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 parameter
NULL
, the result is null
.
java.sql.SQLException
- if a database access error occurssetBigDecimal(java.lang.String, java.math.BigDecimal)
public java.lang.Object getObject(java.lang.String parameterName, java.util.Map map) throws java.sql.SQLException
i
and uses map
for the custom mapping of the parameter value.
This method returns a Java object whose type corresponds to the JDBC type
that was registered for this parameter using the method
registerOutParameter
. By registering the target JDBC type
as java.sql.Types.OTHER
, this method can be used to read
database-specific abstract data types.
getObject
in interface java.sql.CallableStatement
parameterName
- the name of the parametermap
- the mapping from SQL type names to Java classes
java.lang.Object
holding the OUT parameter value
java.sql.SQLException
- if a database access error occurssetObject(String, Object)
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 parameter
Ref
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Blob getBlob(java.lang.String parameterName) throws java.sql.SQLException
BLOB
parameter as a
Blob
object in the Java programming language.
getBlob
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
Blob
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Clob getClob(java.lang.String parameterName) throws java.sql.SQLException
CLOB
parameter as a
Clob
object in the Java programming language.
getClob
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
Clob
object in the Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Array getArray(java.lang.String parameterName) throws java.sql.SQLException
ARRAY
parameter as an
Array
object in the Java programming language.
getArray
in interface java.sql.CallableStatement
parameterName
- the name of the parameter
Array
object in Java
programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurspublic java.sql.Date getDate(java.lang.String parameterName, java.util.Calendar cal) throws java.sql.SQLException
DATE
parameter as a
java.sql.Date
object, using the given Calendar
object to construct the date. With a Calendar
object, the
driver can calculate the date taking into account a custom timezone and
locale. If no Calendar
object is specified, the driver uses
the default timezone and locale.
getDate
in interface java.sql.CallableStatement
parameterName
- the name of the parametercal
- the Calendar
object the driver will use to
construct the date
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetDate(String, Date, Calendar)
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 time
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTime(String, Time, Calendar)
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 timestamp
NULL
, the
result is null
.
java.sql.SQLException
- if a database access error occurssetTimestamp(String, Timestamp, Calendar)
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 parameter
java.net.URL
object in the
Java programming language. If the value was SQL NULL
,
the value null
is returned.
java.sql.SQLException
- if a database access error occurs, or if there is a
problem with the URLsetURL(java.lang.String, java.net.URL)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |