Class CallableStatementWrapper
- java.lang.Object
-
- com.sun.gjc.spi.base.StatementWrapper
-
- com.sun.gjc.spi.base.PreparedStatementWrapper
-
- com.sun.gjc.spi.base.CallableStatementWrapper
-
- All Implemented Interfaces:
ResultSetClosedEventListener
,StatementLeakListener
,AutoCloseable
,CallableStatement
,PreparedStatement
,Statement
,Wrapper
- Direct Known Subclasses:
CallableStatementWrapper40
public abstract class CallableStatementWrapper extends PreparedStatementWrapper implements CallableStatement
Abstract class for wrapping PreparedStatement
-
-
Field Summary
Fields Modifier and Type Field Description protected CallableStatement
callableStatement
-
Fields inherited from class com.sun.gjc.spi.base.PreparedStatementWrapper
preparedStatement
-
Fields inherited from class com.sun.gjc.spi.base.StatementWrapper
_logger, connection, executor, jdbcStatement, leakDetector, resultSetCount
-
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
Constructors Constructor Description CallableStatementWrapper(Connection con, CallableStatement statement, boolean cachingEnabled)
Creates a new instance of CallableStatementWrapper
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Array
getArray(int i)
Retrieves the value of the designated JDBCARRAY
parameter as anArray
object in the Java programming language.Array
getArray(String parameterName)
Retrieves the value of a JDBCARRAY
parameter as anArray
object in the Java programming language.BigDecimal
getBigDecimal(int parameterIndex)
Retrieves the value of the designated JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.BigDecimal
getBigDecimal(int parameterIndex, int scale)
Deprecated.usegetBigDecimal(int parameterIndex)
orgetBigDecimal(String parameterName)
BigDecimal
getBigDecimal(String parameterName)
Retrieves the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.Blob
getBlob(int i)
Retrieves the value of the designated JDBCBLOB
parameter as aBlob
object in the Java programming language.Blob
getBlob(String parameterName)
Retrieves the value of a JDBCBLOB
parameter as aBlob
object in the Java programming language.boolean
getBoolean(int parameterIndex)
Retrieves the value of the designated JDBCBIT
parameter as aboolean
in the Java programming language.boolean
getBoolean(String parameterName)
Retrieves the value of a JDBCBIT
parameter as aboolean
in the Java programming language.byte
getByte(int parameterIndex)
Retrieves the value of the designated JDBCTINYINT
parameter as abyte
in the Java programming language.byte
getByte(String parameterName)
Retrieves the value of a JDBCTINYINT
parameter as abyte
in the Java programming language.byte[]
getBytes(int parameterIndex)
Retrieves the value of the designated JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.byte[]
getBytes(String parameterName)
Retrieves the value of a JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.Clob
getClob(int i)
Retrieves the value of the designated JDBCCLOB
parameter as aClob
object in the Java programming language.Clob
getClob(String parameterName)
Retrieves the value of a JDBCCLOB
parameter as aClob
object in the Java programming language.Date
getDate(int parameterIndex)
Retrieves the value of the designated JDBCDATE
parameter as ajava.sql.Date
object.Date
getDate(int parameterIndex, Calendar cal)
Retrieves the value of the designated JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date.Date
getDate(String parameterName)
Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object.Date
getDate(String parameterName, Calendar cal)
Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date.double
getDouble(int parameterIndex)
Retrieves the value of the designated JDBCDOUBLE
parameter as adouble
in the Java programming language.double
getDouble(String parameterName)
Retrieves the value of a JDBCDOUBLE
parameter as adouble
in the Java programming language.float
getFloat(int parameterIndex)
Retrieves the value of the designated JDBCFLOAT
parameter as afloat
in the Java programming language.float
getFloat(String parameterName)
Retrieves the value of a JDBCFLOAT
parameter as afloat
in the Java programming language.int
getInt(int parameterIndex)
Retrieves the value of the designated JDBCINTEGER
parameter as anint
in the Java programming language.int
getInt(String parameterName)
Retrieves the value of a JDBCINTEGER
parameter as anint
in the Java programming language.long
getLong(int parameterIndex)
Retrieves the value of the designated JDBCBIGINT
parameter as along
in the Java programming language.long
getLong(String parameterName)
Retrieves the value of a JDBCBIGINT
parameter as along
in the Java programming language.Object
getObject(int parameterIndex)
Retrieves the value of the designated parameter as anObject
in the Java programming language.Object
getObject(int i, Map<String,Class<?>> map)
Returns an object representing the value of OUT parameteri
and usesmap
for the custom mapping of the parameter value.Object
getObject(String parameterName)
Retrieves the value of a parameter as anObject
in the Java programming language.Object
getObject(String parameterName, Map<String,Class<?>> map)
Returns an object representing the value of OUT parameteri
and usesmap
for the custom mapping of the parameter value.Ref
getRef(int i)
Retrieves the value of the designated JDBCREF(<structured-type>)
parameter as aRef
object in the Java programming language.Ref
getRef(String parameterName)
Retrieves the value of a JDBCREF(<structured-type>)
parameter as aRef
object in the Java programming language.short
getShort(int parameterIndex)
Retrieves the value of the designated JDBCSMALLINT
parameter as ashort
in the Java programming language.short
getShort(String parameterName)
Retrieves the value of a JDBCSMALLINT
parameter as ashort
in the Java programming language.String
getString(int parameterIndex)
Retrieves the value of the designated JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.String
getString(String parameterName)
Retrieves the value of a JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.Time
getTime(int parameterIndex)
Retrieves the value of the designated JDBCTIME
parameter as ajava.sql.Time
object.Time
getTime(int parameterIndex, Calendar cal)
Retrieves the value of the designated JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time.Time
getTime(String parameterName)
Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object.Time
getTime(String parameterName, Calendar cal)
Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time.Timestamp
getTimestamp(int parameterIndex)
Retrieves the value of the designated JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.Timestamp
getTimestamp(int parameterIndex, Calendar cal)
Retrieves the value of the designated JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object.Timestamp
getTimestamp(String parameterName)
Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.Timestamp
getTimestamp(String parameterName, Calendar cal)
Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object.URL
getURL(int parameterIndex)
Retrieves the value of the designated JDBCDATALINK
parameter as ajava.net.URL
object.URL
getURL(String parameterName)
Retrieves the value of a JDBCDATALINK
parameter as ajava.net.URL
object.void
registerOutParameter(int parameterIndex, int sqlType)
Registers the OUT parameter in ordinal positionparameterIndex
to the JDBC typesqlType
.void
registerOutParameter(int parameterIndex, int sqlType, int scale)
Registers the parameter in ordinal positionparameterIndex
to be of JDBC typesqlType
.void
registerOutParameter(int paramIndex, int sqlType, String typeName)
Registers the designated output parameter.void
registerOutParameter(String parameterName, int sqlType)
Registers the OUT parameter namedparameterName
to the JDBC typesqlType
.void
registerOutParameter(String parameterName, int sqlType, int scale)
Registers the parameter namedparameterName
to be of JDBC typesqlType
.void
registerOutParameter(String parameterName, int sqlType, String typeName)
Registers the designated output parameter.void
setAsciiStream(String parameterName, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBigDecimal(String parameterName, BigDecimal x)
Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBinaryStream(String parameterName, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBoolean(String parameterName, boolean x)
Sets the designated parameter to the given Javaboolean
value.void
setByte(String parameterName, byte x)
Sets the designated parameter to the given Javabyte
value.void
setBytes(String parameterName, byte[] x)
Sets the designated parameter to the given Java array of bytes.void
setCharacterStream(String parameterName, Reader reader, int length)
Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
setDate(String parameterName, Date x)
Sets the designated parameter to the givenjava.sql.Date
value.void
setDate(String parameterName, Date x, Calendar cal)
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object.void
setDouble(String parameterName, double x)
Sets the designated parameter to the given Javadouble
value.void
setFloat(String parameterName, float x)
Sets the designated parameter to the given Javafloat
value.void
setInt(String parameterName, int x)
Sets the designated parameter to the given Javaint
value.void
setLong(String parameterName, long x)
Sets the designated parameter to the given Javalong
value.void
setNull(String parameterName, int sqlType)
Sets the designated parameter to SQLNULL
.void
setNull(String parameterName, int sqlType, String typeName)
Sets the designated parameter to SQLNULL
.void
setObject(String parameterName, Object x)
Sets the value of the designated parameter with the given object.void
setObject(String parameterName, Object x, int targetSqlType)
Sets the value of the designated parameter with the given object.void
setObject(String parameterName, Object x, int targetSqlType, int scale)
Sets the value of the designated parameter with the given object.void
setShort(String parameterName, short x)
Sets the designated parameter to the given Javashort
value.void
setString(String parameterName, String x)
Sets the designated parameter to the given JavaString
value.void
setTime(String parameterName, Time x)
Sets the designated parameter to the givenjava.sql.Time
value.void
setTime(String parameterName, Time x, Calendar cal)
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object.void
setTimestamp(String parameterName, Timestamp x)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp(String parameterName, Timestamp x, Calendar cal)
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object.void
setURL(String parameterName, URL val)
Sets the designated parameter to the givenjava.net.URL
object.boolean
wasNull()
Retrieves whether the last OUT parameter read had the value of SQLNULL
.-
Methods inherited from class com.sun.gjc.spi.base.PreparedStatementWrapper
addBatch, clearParameters, close, closeOnCompletion, execute, executeUpdate, getCached, getMetaData, getParameterMetaData, incrementResultSetReferenceCount, isBusy, isCloseOnCompletion, isValid, resultSetClosed, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setBusy, setByte, setBytes, setCached, setCharacterStream, setClob, setDate, setDate, setDouble, setFetchDirection, setFetchSize, setFloat, setInt, setLong, setMaxFieldSize, setMaxRows, setNull, setNull, setObject, setObject, setObject, setQueryTimeout, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL, setValid
-
Methods inherited from class com.sun.gjc.spi.base.StatementWrapper
actualCloseOnCompletion, addBatch, cancel, clearBatch, clearWarnings, decrementResultSetCount, execute, execute, execute, execute, executeBatch, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getActualConnection, getCloseOnCompletion, getConnection, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSetConcurrency, getResultSetCount, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, incrementResultSetCount, isMarkedForReclaim, markForReclaim, reclaimStatement, setCursorName, setEscapeProcessing
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.sql.CallableStatement
getCharacterStream, getCharacterStream, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getRowId, getRowId, getSQLXML, getSQLXML, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setAsciiStream, setAsciiStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setObject, setObject, setRowId, setSQLXML
-
Methods inherited from interface java.sql.PreparedStatement
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
-
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, 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, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
-
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
-
-
-
Field Detail
-
callableStatement
protected CallableStatement callableStatement
-
-
Constructor Detail
-
CallableStatementWrapper
public CallableStatementWrapper(Connection con, CallableStatement statement, boolean cachingEnabled) throws SQLException
Creates a new instance of CallableStatementWrapper- Parameters:
con
- ConnectionWrapperstatement
- Statement that is to be wrapped- Throws:
SQLException
-
-
Method Detail
-
registerOutParameter
public void registerOutParameter(int parameterIndex, int sqlType) throws SQLException
Registers the OUT parameter in ordinal positionparameterIndex
to the JDBC typesqlType
. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
If the JDBC type expected to be returned to this output parameter is specific to this particular database,sqlType
for an OUT parameter determines the Java type that must be used in theget
method to read the value of that parameter.sqlType
should bejava.sql.Types.OTHER
. The methodgetObject(int)
retrieves the value.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so onsqlType
- the JDBC type code defined byjava.sql.Types
. If the parameter is of JDBC typeNUMERIC
orDECIMAL
, the version ofregisterOutParameter
that accepts a scale value should be used.- Throws:
SQLException
- if a database access error occurs- See Also:
Types
-
registerOutParameter
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException
Registers the parameter in ordinal positionparameterIndex
to be of JDBC typesqlType
. This method must be called before a stored procedure is executed.The JDBC type specified by
This version ofsqlType
for an OUT parameter determines the Java type that must be used in theget
method to read the value of that parameter.registerOutParameter
should be used when the parameter is of JDBC typeNUMERIC
orDECIMAL
.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so onsqlType
- the SQL type code defined byjava.sql.Types
.scale
- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLException
- if a database access error occurs- See Also:
Types
-
wasNull
public boolean wasNull() throws SQLException
Retrieves whether the last OUT parameter read had the value of SQLNULL
. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it isnull
or not.- Specified by:
wasNull
in interfaceCallableStatement
- Returns:
true
if the last parameter read was SQLNULL
;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getString
public String getString(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.For the fixed-length type JDBC
CHAR
, theString
object returned has exactly the same value the JDBCCHAR
value had in the database, including any padding added by the database.- Specified by:
getString
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- See Also:
setString(java.lang.String, java.lang.String)
-
getBoolean
public boolean getBoolean(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCBIT
parameter as aboolean
in the Java programming language.- Specified by:
getBoolean
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result isfalse
. - Throws:
SQLException
- if a database access error occurs- See Also:
setBoolean(java.lang.String, boolean)
-
getByte
public byte getByte(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCTINYINT
parameter as abyte
in the Java programming language.- Specified by:
getByte
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- See Also:
setByte(java.lang.String, byte)
-
getShort
public short getShort(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCSMALLINT
parameter as ashort
in the Java programming language.- Specified by:
getShort
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- See Also:
setShort(java.lang.String, short)
-
getInt
public int getInt(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCINTEGER
parameter as anint
in the Java programming language.- Specified by:
getInt
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- See Also:
setInt(java.lang.String, int)
-
getLong
public long getLong(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCBIGINT
parameter as along
in the Java programming language.- Specified by:
getLong
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- See Also:
setLong(java.lang.String, long)
-
getFloat
public float getFloat(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCFLOAT
parameter as afloat
in the Java programming language.- Specified by:
getFloat
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- See Also:
setFloat(java.lang.String, float)
-
getDouble
public double getDouble(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCDOUBLE
parameter as adouble
in the Java programming language.- Specified by:
getDouble
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- See Also:
setDouble(java.lang.String, double)
-
getBigDecimal
@Deprecated public BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException
Deprecated.usegetBigDecimal(int parameterIndex)
orgetBigDecimal(String parameterName)
Retrieves the value of the designated JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with scale digits to the right of the decimal point.- Specified by:
getBigDecimal
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so onscale
- the number of digits to the right of the decimal point- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)
-
getBytes
public byte[] getBytes(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.- Specified by:
getBytes
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- See Also:
setBytes(java.lang.String, byte[])
-
getDate
public Date getDate(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCDATE
parameter as ajava.sql.Date
object.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public Time getTime(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCTIME
parameter as ajava.sql.Time
object.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public Timestamp getTimestamp(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
getObject
public Object getObject(int parameterIndex) throws SQLException
Retrieves the value of the designated parameter as anObject
in the Java programming language. If the value is an SQLNULL
, the driver returns a Javanull
.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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- A
java.lang.Object
holding the OUT parameter value - Throws:
SQLException
- if a database access error occurs- See Also:
Types
,setObject(java.lang.String, java.lang.Object, int, int)
-
getBigDecimal
public BigDecimal getBigDecimal(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.- Specified by:
getBigDecimal
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value in full precision. If the value is
SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)
-
getRef
public Ref getRef(int i) throws SQLException
Retrieves the value of the designated JDBCREF(<structured-type>)
parameter as aRef
object in the Java programming language.- Specified by:
getRef
in interfaceCallableStatement
- Parameters:
i
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Ref
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getBlob
public Blob getBlob(int i) throws SQLException
Retrieves the value of the designated JDBCBLOB
parameter as aBlob
object in the Java programming language.- Specified by:
getBlob
in interfaceCallableStatement
- Parameters:
i
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Blob
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getClob
public Clob getClob(int i) throws SQLException
Retrieves the value of the designated JDBCCLOB
parameter as aClob
object in the Java programming language.- Specified by:
getClob
in interfaceCallableStatement
- Parameters:
i
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Clob
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getArray
public Array getArray(int i) throws SQLException
Retrieves the value of the designated JDBCARRAY
parameter as anArray
object in the Java programming language.- Specified by:
getArray
in interfaceCallableStatement
- Parameters:
i
- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as an
Array
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getDate
public Date getDate(int parameterIndex, Calendar cal) throws SQLException
Retrieves the value of the designated JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date. With aCalendar
object, the driver can calculate the date taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so oncal
- theCalendar
object the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public Time getTime(int parameterIndex, Calendar cal) throws SQLException
Retrieves the value of the designated JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time. With aCalendar
object, the driver can calculate the time taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so oncal
- theCalendar
object the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public Timestamp getTimestamp(int parameterIndex, Calendar cal) throws SQLException
Retrieves the value of the designated JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so oncal
- theCalendar
object the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
registerOutParameter
public void registerOutParameter(int paramIndex, int sqlType, String typeName) throws SQLException
Registers the designated output parameter. This version of the methodregisterOutParameter
should be used for a user-defined orREF
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
Although it is intended for user-defined andregisterOutParameter
to register the type fromjava.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 aREF
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 andREF
parameters.REF
parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined orREF
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.
- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
paramIndex
- the first parameter is 1, the second is 2,...sqlType
- a value fromTypes
typeName
- the fully-qualified name of an SQL structured type- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
Types
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType) throws SQLException
Registers the OUT parameter namedparameterName
to the JDBC typesqlType
. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
If the JDBC type expected to be returned to this output parameter is specific to this particular database,sqlType
for an OUT parameter determines the Java type that must be used in theget
method to read the value of that parameter.sqlType
should bejava.sql.Types.OTHER
. The methodgetObject(int)
retrieves the value.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- the JDBC type code defined byjava.sql.Types
. If the parameter is of JDBC typeNUMERIC
orDECIMAL
, the version ofregisterOutParameter
that accepts a scale value should be used.- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
Types
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException
Registers the parameter namedparameterName
to be of JDBC typesqlType
. This method must be called before a stored procedure is executed.The JDBC type specified by
This version ofsqlType
for an OUT parameter determines the Java type that must be used in theget
method to read the value of that parameter.registerOutParameter
should be used when the parameter is of JDBC typeNUMERIC
orDECIMAL
.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- SQL type code defined byjava.sql.Types
.scale
- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
Types
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException
Registers the designated output parameter. This version of the methodregisterOutParameter
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
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.registerOutParameter
to register the type fromjava.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.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.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- a value fromTypes
typeName
- the fully-qualified name of an SQL structured type- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
Types
-
getURL
public URL getURL(int parameterIndex) throws SQLException
Retrieves the value of the designated JDBCDATALINK
parameter as ajava.net.URL
object.- Specified by:
getURL
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2,...- Returns:
- a
java.net.URL
object that represents the JDBCDATALINK
value used as the designated parameter - Throws:
SQLException
- if a database access error occurs, or if the URL being returned is not a valid URL on the Java platform- Since:
- 1.4
- See Also:
setURL(java.lang.String, java.net.URL)
-
setURL
public void setURL(String parameterName, URL val) throws SQLException
Sets the designated parameter to the givenjava.net.URL
object. The driver converts this to an SQLDATALINK
value when it sends it to the database.- Specified by:
setURL
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterval
- the parameter value- Throws:
SQLException
- if a database access error occurs, or if a URL is malformed- Since:
- 1.4
- See Also:
getURL(int)
-
setNull
public void setNull(String parameterName, int sqlType) throws SQLException
Sets the designated parameter to SQLNULL
.Note: You must specify the parameter's SQL type.
- Specified by:
setNull
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- the SQL type code defined injava.sql.Types
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setBoolean
public void setBoolean(String parameterName, boolean x) throws SQLException
Sets the designated parameter to the given Javaboolean
value. The driver converts this to an SQLBIT
value when it sends it to the database.- Specified by:
setBoolean
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getBoolean(int)
-
setByte
public void setByte(String parameterName, byte x) throws SQLException
Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database.- Specified by:
setByte
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getByte(int)
-
setShort
public void setShort(String parameterName, short x) throws SQLException
Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database.- Specified by:
setShort
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getShort(int)
-
setInt
public void setInt(String parameterName, int x) throws SQLException
Sets the designated parameter to the given Javaint
value. The driver converts this to an SQLINTEGER
value when it sends it to the database.- Specified by:
setInt
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getInt(int)
-
setLong
public void setLong(String parameterName, long x) throws SQLException
Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database.- Specified by:
setLong
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getLong(int)
-
setFloat
public void setFloat(String parameterName, float x) throws SQLException
Sets the designated parameter to the given Javafloat
value. The driver converts this to an SQLFLOAT
value when it sends it to the database.- Specified by:
setFloat
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getFloat(int)
-
setDouble
public void setDouble(String parameterName, double x) throws SQLException
Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database.- Specified by:
setDouble
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getDouble(int)
-
setBigDecimal
public void setBigDecimal(String parameterName, BigDecimal x) throws SQLException
Sets the designated parameter to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value when it sends it to the database.- Specified by:
setBigDecimal
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getBigDecimal(int, int)
-
setString
public void setString(String parameterName, String x) throws SQLException
Sets the designated parameter to the given JavaString
value. The driver converts this to an SQLVARCHAR
orLONGVARCHAR
value (depending on the argument's size relative to the driver's limits onVARCHAR
values) when it sends it to the database.- Specified by:
setString
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getString(int)
-
setBytes
public void setBytes(String parameterName, byte[] x) throws SQLException
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY
orLONGVARBINARY
(depending on the argument's size relative to the driver's limits onVARBINARY
values) when it sends it to the database.- Specified by:
setBytes
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getBytes(int)
-
setDate
public void setDate(String parameterName, Date x) throws SQLException
Sets the designated parameter to the givenjava.sql.Date
value. The driver converts this to an SQLDATE
value when it sends it to the database.- Specified by:
setDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getDate(int)
-
setTime
public void setTime(String parameterName, Time x) throws SQLException
Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database.- Specified by:
setTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getTime(int)
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp x) throws SQLException
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value when it sends it to the database.- Specified by:
setTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getTimestamp(int)
-
setAsciiStream
public void setAsciiStream(String parameterName, InputStream x, int length) throws SQLException
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.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.
- Specified by:
setAsciiStream
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setBinaryStream
public void setBinaryStream(String parameterName, InputStream x, int length) throws SQLException
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.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.
- Specified by:
setBinaryStream
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setObject
public void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException
Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.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 interfaceSQLData
), the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,Struct
, orArray
, 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.
- Specified by:
setObject
in interfaceCallableStatement
- Parameters:
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.- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
Types
,getObject(int)
-
setObject
public void setObject(String parameterName, Object x, int targetSqlType) throws SQLException
Sets the value of the designated parameter with the given object. This method is like the methodsetObject
above, except that it assumes a scale of zero.- Specified by:
setObject
in interfaceCallableStatement
- Parameters:
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- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getObject(int)
-
setObject
public void setObject(String parameterName, Object x) throws SQLException
Sets the value of the designated parameter with the given object. The second parameter must be of typeObject
; therefore, thejava.lang
equivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type.Object
types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.If the object is of a class implementing the interface
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.SQLData
, the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,Struct
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.- Specified by:
setObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter value- Throws:
SQLException
- if a database access error occurs or if the givenObject
parameter is ambiguous- Since:
- 1.4
- See Also:
getObject(int)
-
setCharacterStream
public void setCharacterStream(String parameterName, Reader reader, int length) throws SQLException
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.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.
- Specified by:
setCharacterStream
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterreader
- thejava.io.Reader
object that contains the UNICODE data used as the designated parameterlength
- the number of characters in the stream- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setDate
public void setDate(String parameterName, Date x, Calendar cal) throws SQLException
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLDATE
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the date taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the date- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getDate(int)
-
setTime
public void setTime(String parameterName, Time x, Calendar cal) throws SQLException
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIME
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the time taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the time- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getTime(int)
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp x, Calendar cal) throws SQLException
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIMESTAMP
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the timestamp- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getTimestamp(int)
-
setNull
public void setNull(String parameterName, int sqlType, String typeName) throws SQLException
Sets the designated parameter to SQLNULL
. This version of the methodsetNull
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.- Specified by:
setNull
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- a value fromjava.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREF
value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getString
public String getString(String parameterName) throws SQLException
Retrieves the value of a JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.For the fixed-length type JDBC
CHAR
, theString
object returned has exactly the same value the JDBCCHAR
value had in the database, including any padding added by the database.- Specified by:
getString
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setString(java.lang.String, java.lang.String)
-
getBoolean
public boolean getBoolean(String parameterName) throws SQLException
Retrieves the value of a JDBCBIT
parameter as aboolean
in the Java programming language.- Specified by:
getBoolean
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isfalse
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setBoolean(java.lang.String, boolean)
-
getByte
public byte getByte(String parameterName) throws SQLException
Retrieves the value of a JDBCTINYINT
parameter as abyte
in the Java programming language.- Specified by:
getByte
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setByte(java.lang.String, byte)
-
getShort
public short getShort(String parameterName) throws SQLException
Retrieves the value of a JDBCSMALLINT
parameter as ashort
in the Java programming language.- Specified by:
getShort
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setShort(java.lang.String, short)
-
getInt
public int getInt(String parameterName) throws SQLException
Retrieves the value of a JDBCINTEGER
parameter as anint
in the Java programming language.- Specified by:
getInt
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setInt(java.lang.String, int)
-
getLong
public long getLong(String parameterName) throws SQLException
Retrieves the value of a JDBCBIGINT
parameter as along
in the Java programming language.- Specified by:
getLong
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setLong(java.lang.String, long)
-
getFloat
public float getFloat(String parameterName) throws SQLException
Retrieves the value of a JDBCFLOAT
parameter as afloat
in the Java programming language.- Specified by:
getFloat
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setFloat(java.lang.String, float)
-
getDouble
public double getDouble(String parameterName) throws SQLException
Retrieves the value of a JDBCDOUBLE
parameter as adouble
in the Java programming language.- Specified by:
getDouble
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setDouble(java.lang.String, double)
-
getBytes
public byte[] getBytes(String parameterName) throws SQLException
Retrieves the value of a JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.- Specified by:
getBytes
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setBytes(java.lang.String, byte[])
-
getDate
public Date getDate(String parameterName) throws SQLException
Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public Time getTime(String parameterName) throws SQLException
Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public Timestamp getTimestamp(String parameterName) throws SQLException
Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
getObject
public Object getObject(String parameterName) throws SQLException
Retrieves the value of a parameter as anObject
in the Java programming language. If the value is an SQLNULL
, the driver returns a Javanull
.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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- A
java.lang.Object
holding the OUT parameter value. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
Types
,setObject(java.lang.String, java.lang.Object, int, int)
-
getBigDecimal
public BigDecimal getBigDecimal(String parameterName) throws SQLException
Retrieves the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.- Specified by:
getBigDecimal
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value in full precision. If the value is
SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)
-
getRef
public Ref getRef(String parameterName) throws SQLException
Retrieves the value of a JDBCREF(<structured-type>)
parameter as aRef
object in the Java programming language.- Specified by:
getRef
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
Ref
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getBlob
public Blob getBlob(String parameterName) throws SQLException
Retrieves the value of a JDBCBLOB
parameter as aBlob
object in the Java programming language.- Specified by:
getBlob
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
Blob
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getClob
public Clob getClob(String parameterName) throws SQLException
Retrieves the value of a JDBCCLOB
parameter as aClob
object in the Java programming language.- Specified by:
getClob
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
Clob
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getArray
public Array getArray(String parameterName) throws SQLException
Retrieves the value of a JDBCARRAY
parameter as anArray
object in the Java programming language.- Specified by:
getArray
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as an
Array
object in Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getDate
public Date getDate(String parameterName, Calendar cal) throws SQLException
Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date. With aCalendar
object, the driver can calculate the date taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametercal
- theCalendar
object the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public Time getTime(String parameterName, Calendar cal) throws SQLException
Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time. With aCalendar
object, the driver can calculate the time taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametercal
- theCalendar
object the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException
Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametercal
- theCalendar
object the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
getURL
public URL getURL(String parameterName) throws SQLException
Retrieves the value of a JDBCDATALINK
parameter as ajava.net.URL
object.- Specified by:
getURL
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
java.net.URL
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs, or if there is a problem with the URL- Since:
- 1.4
- See Also:
setURL(java.lang.String, java.net.URL)
-
getObject
public Object getObject(int i, Map<String,Class<?>> map) throws SQLException
Returns an object representing the value of OUT parameteri
and usesmap
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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
i
- the first parameter is 1, the second is 2, and so onmap
- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Object
holding the OUT parameter value - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
setObject(java.lang.String, java.lang.Object, int, int)
-
getObject
public Object getObject(String parameterName, Map<String,Class<?>> map) throws SQLException
Returns an object representing the value of OUT parameteri
and usesmap
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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametermap
- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Object
holding the OUT parameter value - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
setObject(java.lang.String, java.lang.Object, int, int)
-
-