com.gargoylesoftware.base.resource.jdbc

Class CallableStatementWrapper

public final class CallableStatementWrapper extends PreparedStatementWrapper implements CallableStatement

The interface used to execute SQL stored procedures. JDBC provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.

   {?= call <procedure-name>[<arg1>,<arg2>, ...]}
   {call <procedure-name>[<arg1>,<arg2>, ...]}

IN parameter values are set using the set methods inherited from PreparedStatement. The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the get methods provided here.

A CallableStatement can return one ResultSet or multiple ResultSet objects. Multiple ResultSet objects are handled using operations inherited from Statement.

For maximum portability, a call's ResultSet objects and update counts should be processed prior to getting the values of output parameters.

Methods that are new in the JDBC 2.0 API are marked "Since 1.2."

Version: $Revision: 1.4 $

Author: Mike Bowler

Field Summary
CallableStatement	delegate_

Constructor Summary
	CallableStatementWrapper(CallableStatement statement) Create a wrapper

Method Summary
Array	getArray(int i) Gets the value of a JDBC `ARRAY` parameter as an Array object in the Java programming language.
Array	getArray(String parameterName) Retrieves the value of a JDBC `ARRAY` parameter as an Array object in the Java programming language.
BigDecimal	getBigDecimal(int parameterIndex, int scale) Gets the value of a JDBC `NUMERIC` parameter as a `java.math.BigDecimal` object with scale digits to the right of the decimal point.
BigDecimal	getBigDecimal(int parameterIndex) Gets the value of a JDBC `NUMERIC` parameter as a `java.math.BigDecimal` object with as many digits to the right of the decimal point as the value contains.
BigDecimal	getBigDecimal(String parameterName) Retrieves the value of a JDBC `NUMERIC` parameter as a `java.math.BigDecimal` object with as many digits to the right of the decimal point as the value contains.
Blob	getBlob(int i) Gets the value of a JDBC `BLOB` parameter as a Blob\ object in the Java programming language.
Blob	getBlob(String parameterName) Retrieves the value of a JDBC `BLOB` parameter as a Blob object in the Java programming language.
boolean	getBoolean(int parameterIndex) Gets the value of a JDBC `BIT` parameter as a `boolean` in the Java programming language.
boolean	getBoolean(String parameterName) Retrieves the value of a JDBC `BIT` parameter as a `boolean` in the Java programming language.
byte	getByte(int parameterIndex) Gets the value of a JDBC `TINYINT` parameter as a `byte` in the Java programming language.
byte	getByte(String parameterName) Retrieves the value of a JDBC `TINYINT` parameter as a `byte` in the Java programming language.
byte[]	getBytes(int parameterIndex) Gets the value of a JDBC `BINARY` or `VARBINARY` parameter as an array of `byte` values in the Java programming language.
byte[]	getBytes(String parameterName) Retrieves the value of a JDBC `BINARY` or `VARBINARY` parameter as an array of `byte` values in the Java programming language.
Clob	getClob(int i) Gets the value of a JDBC `CLOB` parameter as a `Clob` object in the Java programming language.
Clob	getClob(String parameterName) Retrieves the value of a JDBC `CLOB` parameter as a `Clob` object in the Java programming language.
Date	getDate(int parameterIndex) Gets the value of a JDBC `DATE` parameter as a `java.sql.Date` object.
Date	getDate(int parameterIndex, Calendar cal) Gets the value of a JDBC `DATE` parameter as a `java.sql.Date` object, using the given `Calendar` object to construct the date.
Date	getDate(String parameterName) Retrieves the value of a JDBC `DATE` parameter as a `java.sql.Date` object.
Date	getDate(String parameterName, Calendar cal) Retrieves the value of a JDBC `DATE` parameter as a `java.sql.Date` object, using the given `Calendar` object to construct the date.
double	getDouble(int parameterIndex) Gets the value of a JDBC `DOUBLE` parameter as a `double` in the Java programming language.
double	getDouble(String parameterName) Retrieves the value of a JDBC `DOUBLE` parameter as a `double` in the Java programming language.
float	getFloat(int parameterIndex) Gets the value of a JDBC `FLOAT` parameter as a `float` in the Java programming language.
float	getFloat(String parameterName) Retrieves the value of a JDBC `FLOAT` parameter as a `float` in the Java programming language.
int	getInt(int parameterIndex) Gets the value of a JDBC `INTEGER` parameter as an `int` in the Java programming language.
int	getInt(String parameterName) Retrieves the value of a JDBC `INTEGER` parameter as an `int` in the Java programming language.
long	getLong(int parameterIndex) Gets the value of a JDBC `BIGINT` parameter as a `long` in the Java programming language.
long	getLong(String parameterName) Retrieves the value of a JDBC `BIGINT` parameter as a `long` in the Java programming language.
Object	getObject(int parameterIndex) Gets the value of a parameter as an `Object` in the Java programming language.
Object	getObject(int i, Map map) Returns an object representing the value of OUT parameter `i` and uses `map` for the custom mapping of the parameter value.
Object	getObject(String parameterName) Retrieves the value of a parameter as an `Object` in the Java programming language.
Object	getObject(String parameterName, Map map) Returns an object representing the value of OUT parameter `i` and uses `map` for the custom mapping of the parameter value.
Ref	getRef(int i) Gets the value of a JDBC `REF(<structured-type>)` parameter as a Ref object in the Java programming language.
Ref	getRef(String parameterName) Retrieves the value of a JDBC `REF(<structured-type>)` parameter as a Ref object in the Java programming language.
short	getShort(int parameterIndex) Gets the value of a JDBC `SMALLINT` parameter as a `short` in the Java programming language.
short	getShort(String parameterName) Retrieves the value of a JDBC `SMALLINT` parameter as a `short` in the Java programming language.
String	getString(int parameterIndex) Retrieves the value of a JDBC `CHAR`, `VARCHAR`, or `LONGVARCHAR` parameter as a `String` in the Java programming language.
String	getString(String parameterName) Retrieves the value of a JDBC `CHAR`, `VARCHAR`, or `LONGVARCHAR` parameter as a `String` in the Java programming language.
Time	getTime(int parameterIndex) Get the value of a JDBC `TIME` parameter as a `java.sql.Time` object.
Time	getTime(int parameterIndex, Calendar cal) Gets the value of a JDBC `TIME` parameter as a `java.sql.Time` object, using the given `Calendar` object to construct the time.
Time	getTime(String parameterName) Retrieves the value of a JDBC `TIME` parameter as a `java.sql.Time` object.
Time	getTime(String parameterName, Calendar cal) Retrieves the value of a JDBC `TIME` parameter as a `java.sql.Time` object, using the given `Calendar` object to construct the time.
Timestamp	getTimestamp(int parameterIndex) Gets the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object.
Timestamp	getTimestamp(int parameterIndex, Calendar cal) Gets the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object, using the given `Calendar` object to construct the `Timestamp` object.
Timestamp	getTimestamp(String parameterName) Retrieves the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object.
Timestamp	getTimestamp(String parameterName, Calendar cal) Retrieves the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object, using the given `Calendar` object to construct the `Timestamp` object.
URL	getURL(int parameterIndex) Retrieves the value of the designated JDBC `DATALINK` parameter as a `java.net.URL` object.
URL	getURL(String parameterName) Retrieves the value of a JDBC `DATALINK` parameter as a `java.net.URL` object.
void	registerOutParameter(int parameterIndex, int sqlType) Registers the OUT parameter in ordinal position `parameterIndex` to the JDBC type `sqlType`.
void	registerOutParameter(int parameterIndex, int sqlType, int scale) Registers the parameter in ordinal position `parameterIndex` to be of JDBC type `sqlType`.
void	registerOutParameter(int paramIndex, int sqlType, String typeName) Registers the designated output parameter.
void	registerOutParameter(String parameterName, int sqlType) Registers the OUT parameter named `parameterName` to the JDBC type `sqlType`.
void	registerOutParameter(String parameterName, int sqlType, int scale) Registers the parameter named `parameterName` to be of JDBC type `sqlType`.
void	registerOutParameter(String parameterName, int sqlType, String typeName) Registers the designated output parameter.
void	setAsciiStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(String parameterName, BigDecimal x) Sets the designated parameter to the given `java.math.BigDecimal` value.
void	setBinaryStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBoolean(String parameterName, boolean x) Sets the designated parameter to the given Java `boolean` value.
void	setByte(String parameterName, byte x) Sets the designated parameter to the given Java `byte` value.
void	setBytes(String parameterName, byte[] x) Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(String parameterName, Reader reader, int length) Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
void	setDate(String parameterName, Date x) Sets the designated parameter to the given `java.sql.Date` value.
void	setDate(String parameterName, Date x, Calendar cal) Sets the designated parameter to the given `java.sql.Date` value, using the given `Calendar` object.
void	setDouble(String parameterName, double x) Sets the designated parameter to the given Java `double` value.
void	setFloat(String parameterName, float x) Sets the designated parameter to the given Java `float` value.
void	setInt(String parameterName, int x) Sets the designated parameter to the given Java `int` value.
void	setLong(String parameterName, long x) Sets the designated parameter to the given Java `long` value.
void	setNull(String parameterName, int sqlType) Sets the designated parameter to SQL `NULL`.
void	setNull(String parameterName, int sqlType, String typeName) Sets the designated parameter to SQL `NULL`.
void	setObject(String parameterName, Object x, int targetSqlType, int scale) 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) Sets the value of the designated parameter with the given object.
void	setShort(String parameterName, short x) Sets the designated parameter to the given Java `short` value.
void	setString(String parameterName, String x) Sets the designated parameter to the given Java `String` value.
void	setTime(String parameterName, Time x) Sets the designated parameter to the given `java.sql.Time` value.
void	setTime(String parameterName, Time x, Calendar cal) Sets the designated parameter to the given `java.sql.Time` value, using the given `Calendar` object.
void	setTimestamp(String parameterName, Timestamp x) Sets the designated parameter to the given `java.sql.Timestamp` value.
void	setTimestamp(String parameterName, Timestamp x, Calendar cal) Sets the designated parameter to the given `java.sql.Timestamp` value, using the given `Calendar` object.
void	setURL(String parameterName, URL val) Sets the designated parameter to the given `java.net.URL` object.
boolean	wasNull() Indicates whether or not the last OUT parameter read had the value of SQL `NULL`.

Field Detail

delegate_

private CallableStatement delegate_

Constructor Detail

CallableStatementWrapper

public CallableStatementWrapper(CallableStatement statement)

Create a wrapper

Parameters: statement The statement that is being wrapped

Method Detail

getArray

public final Array getArray(int i)

Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.

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 SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

getArray

public Array getArray(String parameterName)

Retrieves the value of a JDBC ARRAY parameter as an Array object in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value as an Array object in Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.4

getBigDecimal

public final BigDecimal getBigDecimal(int parameterIndex, int scale)

Deprecated:

Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on scale the number of digits to the right of the decimal point

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getBigDecimal

public final BigDecimal getBigDecimal(int parameterIndex)

Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

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 is null.

Throws: SQLException if a database access error occurs

Since: 1.2

getBigDecimal

public BigDecimal getBigDecimal(String parameterName)

Retrieves the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

Parameters: parameterName the name of the parameter

Returns: the parameter value in full precision. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getBlob

public final Blob getBlob(int i)

Gets the value of a JDBC BLOB parameter as a Blob\ object in the Java programming language.

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 SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

getBlob

public Blob getBlob(String parameterName)

Retrieves the value of a JDBC BLOB parameter as a Blob object in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.4

getBoolean

public final boolean getBoolean(int parameterIndex)

Gets the value of a JDBC BIT parameter as a boolean in the Java programming language.

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 is false.

Throws: SQLException if a database access error occurs

getBoolean

public boolean getBoolean(String parameterName)

Retrieves the value of a JDBC BIT parameter as a boolean in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is false.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getByte

public final byte getByte(int parameterIndex)

Gets the value of a JDBC TINYINT parameter as a byte in the Java programming language.

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 is 0.

Throws: SQLException if a database access error occurs

getByte

public byte getByte(String parameterName)

Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getBytes

public final byte[] getBytes(int parameterIndex)

Gets the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

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 is null.

Throws: SQLException if a database access error occurs

getBytes

public byte[] getBytes(String parameterName)

Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getClob

public final Clob getClob(int i)

Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.

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 SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

getClob

public Clob getClob(String parameterName)

Retrieves the value of a JDBC CLOB parameter as a Clob object in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.4

getDate

public final Date getDate(int parameterIndex)

Gets the value of a JDBC DATE parameter as a java.sql.Date object.

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 is null.

Throws: SQLException if a database access error occurs

getDate

public final Date getDate(int parameterIndex, Calendar cal)

Gets the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. 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.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on cal the Calendar object the driver will use to construct the date

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getDate

public Date getDate(String parameterName)

Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

getDate

public Date getDate(String parameterName, Calendar cal)

Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. 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.

Parameters: parameterName the name of the parameter cal the Calendar object the driver will use to construct the date

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

getDouble

public final double getDouble(int parameterIndex)

Gets the value of a JDBC DOUBLE parameter as a double in the Java programming language.

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 is 0.

Throws: SQLException if a database access error occurs

getDouble

public double getDouble(String parameterName)

Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getFloat

public final float getFloat(int parameterIndex)

Gets the value of a JDBC FLOAT parameter as a float in the Java programming language.

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 is 0.

Throws: SQLException if a database access error occurs

getFloat

public float getFloat(String parameterName)

Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getInt

public final int getInt(int parameterIndex)

Gets the value of a JDBC INTEGER parameter as an int in the Java programming language.

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 is 0.

Throws: SQLException if a database access error occurs

getInt

public int getInt(String parameterName)

Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getLong

public final long getLong(int parameterIndex)

Gets the value of a JDBC BIGINT parameter as a long in the Java programming language.

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 is 0.

Throws: SQLException if a database access error occurs

getLong

public long getLong(String parameterName)

Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getObject

public final Object getObject(int parameterIndex)

Gets the value of a parameter as an Object in the Java programming language.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter . By registering the target JDBC type as java.sql.Types.OTHER , this method can be used to read database-specific abstract data types.

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

getObject

public final Object getObject(int i, Map map)

Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

Parameters: i the first parameter is 1, the second is 2, and so on map 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

getObject

public Object getObject(String parameterName)

Retrieves the value of a parameter as an 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.

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: java.sql.Types

getObject

public Object getObject(String parameterName, Map map)

Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

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.

Parameters: parameterName the name of the parameter map 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

getRef

public final Ref getRef(int i)

Gets the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.

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 SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.2

getRef

public Ref getRef(String parameterName)

Retrieves the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs

Since: 1.4

getShort

public final short getShort(int parameterIndex)

Gets the value of a JDBC SMALLINT parameter as a short in the Java programming language.

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 is 0.

Throws: SQLException if a database access error occurs

getShort

public short getShort(String parameterName)

Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is 0.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getString

public final String getString(int parameterIndex)

Retrieves the value of a JDBC 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.

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 is null.

Throws: SQLException if a database access error occurs

getString

public String getString(String parameterName)

Retrieves the value of a JDBC 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.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: CallableStatementWrapper

getTime

public final Time getTime(int parameterIndex)

Get the value of a JDBC TIME parameter as a java.sql.Time object.

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 is null.

Throws: SQLException if a database access error occurs

getTime

public final Time getTime(int parameterIndex, Calendar cal)

Gets the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. 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.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on cal the Calendar object the driver will use to construct the time

Returns: the parameter value; if the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getTime

public Time getTime(String parameterName)

Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

getTime

public Time getTime(String parameterName, Calendar cal)

Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. 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.

Parameters: parameterName the name of the parameter cal the Calendar object the driver will use to construct the time

Returns: the parameter value; if the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

getTimestamp

public final Timestamp getTimestamp(int parameterIndex)

Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

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 is null.

Throws: SQLException if a database access error occurs

getTimestamp

public final Timestamp getTimestamp(int parameterIndex, Calendar cal)

Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object. 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.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on cal the Calendar object the driver will use to construct the timestamp

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

getTimestamp

public Timestamp getTimestamp(String parameterName)

Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters: parameterName the name of the parameter

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

getTimestamp

public Timestamp getTimestamp(String parameterName, Calendar cal)

Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object. 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.

Parameters: parameterName the name of the parameter cal the Calendar object the driver will use to construct the timestamp

Returns: the parameter value. If the value is SQL NULL, the result is null.

Throws: SQLException if a database access error occurs

Since: 1.4

getURL

public URL getURL(int parameterIndex)

Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.

Parameters: parameterIndex the first parameter is 1, the second is 2,...

Returns: a java.net.URL object that represents the JDBC DATALINK 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: CallableStatementWrapper

getURL

public URL getURL(String parameterName)

Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.

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 SQL NULL, the value null is returned.

Throws: SQLException if a database access error occurs, or if there is a problem with the URL

Since: 1.4

See Also: CallableStatementWrapper

registerOutParameter

public final void registerOutParameter(int parameterIndex, int sqlType)

Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method getObject retrieves the value.

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on sqlType 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.

Throws: SQLException if a database access error occurs

registerOutParameter

public final void registerOutParameter(int parameterIndex, int sqlType, int scale)

Registers the parameter in ordinal position 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 .

Parameters: parameterIndex the first parameter is 1, the second is 2, and so on sqlType 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.

Throws: SQLException if a database access error occurs

registerOutParameter

public final void registerOutParameter(int paramIndex, int sqlType, String typeName)

Registers the designated output parameter. This version of the method 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.

Parameters: paramIndex the first parameter is 1, the second is 2,... sqlType a value from java.sql.Types typeName the fully-qualified name of an SQL structured type

Throws: SQLException if a database access error occurs

Since: 1.2

registerOutParameter

public void registerOutParameter(String parameterName, int sqlType)

Registers the OUT parameter named parameterName to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method getObject retrieves the value.

Parameters: parameterName the name of the parameter sqlType 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.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: java.sql.Types

registerOutParameter

public void registerOutParameter(String parameterName, int sqlType, int scale)

Registers the parameter named 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.

Parameters: parameterName the name of the parameter sqlType 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.

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: java.sql.Types

registerOutParameter

public void registerOutParameter(String parameterName, int sqlType, String typeName)

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.

Parameters: parameterName the name of the parameter sqlType a value from java.sql.Types typeName the fully-qualified name of an SQL structured type

Throws: SQLException if a database access error occurs

Since: 1.4

See Also: java.sql.Types

setAsciiStream

public 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. When a very large ASCII value is input to a 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.

Parameters: parameterName the name of the parameter x the Java input stream that contains the ASCII parameter value length the number of bytes in the stream

Throws: SQLException if a database access error occurs

Since: 1.4

setBigDecimal

public void setBigDecimal(String parameterName, BigDecimal x)

Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setBinaryStream

public 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. When a very large binary value is input to a 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.

Parameters: parameterName the name of the parameter x the java input stream which contains the binary parameter value length the number of bytes in the stream

Throws: SQLException if a database access error occurs

Since: 1.4

setBoolean

public void setBoolean(String parameterName, boolean x)

Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setByte

public void setByte(String parameterName, byte x)

Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setBytes

public void setBytes(String parameterName, byte[] x)

Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL 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.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setCharacterStream

public void setCharacterStream(String parameterName, Reader reader, int length)

Sets the designated parameter to the given Reader object, which is the given number of characters long. 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.

Parameters: parameterName the name of the parameter reader the java.io.Reader object that contains the UNICODE data used as the designated parameter length 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)

Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setDate

public void setDate(String parameterName, Date x, Calendar cal)

Sets the designated parameter to the given 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.

Parameters: parameterName the name of the parameter x the parameter value cal the Calendar object the driver will use to construct the date

Throws: SQLException if a database access error occurs

Since: 1.4

setDouble

public void setDouble(String parameterName, double x)

Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setFloat

public void setFloat(String parameterName, float x)

Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setInt

public void setInt(String parameterName, int x)

Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setLong

public void setLong(String parameterName, long x)

Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setNull

public void setNull(String parameterName, int sqlType)

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters: parameterName the name of the parameter sqlType the SQL type code defined in java.sql.Types

Throws: SQLException if a database access error occurs

Since: 1.4

setNull

public void setNull(String parameterName, int sqlType, String typeName)

Sets the designated parameter to SQL 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.

Parameters: parameterName the name of the parameter sqlType 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

Throws: SQLException if a database access error occurs

Since: 1.4

setObject

public void setObject(String parameterName, Object x, int targetSqlType, int scale)

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the 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.

Parameters: parameterName the name of the parameter x the object containing the input parameter value targetSqlType 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: java.sql.Types

setObject

public void setObject(String parameterName, Object x, int targetSqlType)

Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.

Parameters: parameterName the name of the parameter x the object containing the input parameter value targetSqlType 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

setObject

public void setObject(String parameterName, Object x)

Sets the value of the designated parameter with the given object. The second parameter must be of type 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.

Parameters: parameterName the name of the parameter x the object containing the input parameter value

Throws: SQLException if a database access error occurs or if the given Object parameter is ambiguous

Since: 1.4

setShort

public void setShort(String parameterName, short x)

Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setString

public void setString(String parameterName, String x)

Sets the designated parameter to the given Java 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.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setTime

public void setTime(String parameterName, Time x)

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setTime

public void setTime(String parameterName, Time x, Calendar cal)

Sets the designated parameter to the given 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.

Parameters: parameterName the name of the parameter x the parameter value cal the Calendar object the driver will use to construct the time

Throws: SQLException if a database access error occurs

Since: 1.4

setTimestamp

public void setTimestamp(String parameterName, Timestamp x)

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Parameters: parameterName the name of the parameter x the parameter value

Throws: SQLException if a database access error occurs

Since: 1.4

setTimestamp

public void setTimestamp(String parameterName, Timestamp x, Calendar cal)

Sets the designated parameter to the given 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.

Parameters: parameterName the name of the parameter x the parameter value cal the Calendar object the driver will use to construct the timestamp

Throws: SQLException if a database access error occurs

Since: 1.4

setURL

public void setURL(String parameterName, URL val)

Sets the designated parameter to the given java.net.URL object. The driver converts this to an SQL DATALINK value when it sends it to the database.

Parameters: parameterName the name of the parameter val the parameter value

Throws: SQLException if a database access error occurs, or if a URL is malformed

Since: 1.4

wasNull

public final boolean wasNull()

Indicates whether or not the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getXXX method; otherwise, there is no value to use in determining whether it is null or not.

Returns: true if the last parameter read was SQL NULL ; false otherwise

Throws: SQLException if a database access error occurs