Class jdbcCallableStatement

java.lang.Object

org.hsqldb.jdbc.jdbcStatement

org.hsqldb.jdbc.jdbcPreparedStatement

org.hsqldb.jdbc.jdbcCallableStatement

All Implemented Interfaces:

AutoCloseable, CallableStatement, PreparedStatement, Statement, Wrapper

public class jdbcCallableStatement
extends jdbcPreparedStatement
implements CallableStatement

The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. 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

invalid reference

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

invalid reference

ResultSet

object or multiple ResultSet objects. Multiple ResultSet objects are handled using operations inherited from

invalid reference

Statement

.

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

HSQLDB-Specific Information:

Since 1.7.2, the JDBC CallableStatement interface implementation has been broken out of the jdbcPreparedStatement class into this one.

With 1.7.2, some of the previously unsupported features of this interface are now supported, such as the parameterName-based setter methods.

More importantly, jdbcCallableStatement objects are now backed by a true compiled parameteric representation. Hence, there are now significant performance gains to be had by using a CallableStatement object instead of a Statement object, if a short-running CALL statement is to be executed more than a small number of times. Moreover, the recent work lays the foundation for work in a subsequenct release to support CallableStatement OUT and IN OUT style parameters, as well as the generation and retrieval of multiple results in response to the execution of a CallableStatement object.

For a more in-depth discussion of performance issues regarding 1.7.2 prepared and callable statement objects, please see overview section of jdbcPreparedStatment.

As with many DBMS, HSQLDB support for stored procedures is not provided in a completely standard fashion.

Beyond the XOpen/ODBC extended scalar functions, stored procedures are typically supported in ways that vary greatly from one DBMS implementation to the next. So, it is almost guaranteed that the code for a stored procedure written under a specific DBMS product will not work without at least some modification in the context of another vendor's product or even across a single vendor's product lines. Moving stored procedures from one DBMS product line to another almost invariably involves complex porting issues and often may not be possible at all. Be warned.

At present, HSQLDB stored procedures map directly onto the methods of compiled Java classes found on the classpath of the engine at runtime. This is done in a non-standard but fairly efficient way by issuing a class grant (and possibly method aliases) of the form:

GRANT ALL ON CLASS "package.class" TO [<user-name> | PUBLIC]
CREATE ALIAS invalid input: '&ltcall'-alias> FOR "package.class.method" -- optional

This has the effect of allowing the specified user(s) to access the set of uniquely named public static methods of the specified class, in either the role of SQL functions or stored procedures. For example:

CONNECT <admin-user> PASSWORD <admin-user-password>;
GRANT ALL ON CLASS "org.myorg.MyClass" TO PUBLIC;
CREATE ALIAS sp_my_method FOR "org.myorg.MyClass.myMethod"
CONNECT <any-user> PASSWORD <any-user-password>;
SELECT "org.myorg.MyClass.myMethod"(column_1) FROM table_1;
SELECT sp_my_method(column_1) FROM table_1;
CALL 2 + "org.myorg.MyClass.myMethod"(-5);
CALL 2 + sp_my_method(-5);

Please note the use of the term "uniquely named" above. Including 1.7.2, no support is provided to deterministically resolve overloaded method names, and there can be issues with inherited methods as well; currently, it is strongly recommended that developers creating stored procedure library classes for HSQLDB simply avoid designs such that SQL stored procedure calls attempt to resolve to:

1. inherited public static methods
2. overloaded public static methods

Also, please note that OUT and IN OUT parameters are not yet supported due to some unresolved low level support issues.

Including 1.7.2, the HSQLDB stored procedure call mechanism is essentially a thin wrap of the HSQLDB SQL function call mechanism, extended to include the more general HSQLDB SQL expression evaluation mechanism. In addition to stored procedure calls that resolve directly to Java method invocations, the extention provides the ability to evaluate simple SQL expressions, possibly containing Java method invocations, outside any INSERT, UPDATE, DELETE or SELECT statement context.

With HSQLDB, executing a CALL statement that produces an opaque (OTHER) or known scalar object reference has virtually the same effect as:

CREATE TABLE DUAL (dummy VARCHAR);
INSERT INTO DUAL VALUES(NULL);
SELECT <simple-expression> FROM DUAL;

As a transitional measure, HSQLDB provides the ability to materialize a general result set in response to stored procedure execution. In this case, the stored procedure's Java method descriptor must specify a return type of java.lang.Object for external use (although at any point in the devlopment cycle, other, proprietary return types may accepted internally for engine development purposes). When HSQLDB detects that the runtime class of the resulting Object is elligible, an automatic internal unwrapping is performed to correctly expose the underlying result set to the client, whether local or remote.

Additionally, HSQLDB automatically detects if java.sql.Connection is the class of the first argument of any underlying Java method(s). If so, then the engine transparently supplies the internal Connection object corresponding to the Session executing the call, adjusting the positions of other arguments to suite the SQL context.

The features above are not intended to be permanent. Rather, the intention is to offer more general and powerful mechanisms in a future release; it is recommend to use them only as a temporary convenience.

For instance, one might be well advised to future-proof by writing HSQLDB-specific adapter methods that in turn call the real logic of an underlying generalized JDBC stored procedure library.

Here is a very simple example of an HSQLDB stored procedure generating a user-defined result set:

package mypackage;

class MyClass {

     public static Object mySp(Connection conn) throws SQLException {
         return conn.createStatement().executeQuery("select * from my_table");
     }
}

Here is a refinement demonstrating no more than the bare essence of the idea behind a more portable style:

package mypackage;

import java.sql.ResultSet;
import java.sql.SQLException;

class MyLibraryClass {

     public static ResultSet mySp() throws SQLException {
         return ctx.getConnection().createStatement().executeQuery("select * from my_table");
     }
}

//--

package myadaptorpackage;

import java.sql.Connection;
import java.sql.SQLException;

class MyAdaptorClass {

     public static Object mySp(Connection conn) throws SQLException {
         MyLibraryClass.getCtx().setConnection(conn);
         return MyLibraryClass.mySp();
     }
}

In a future release, it is intended to provided some new features that will support writing fairly portable JDBC-based stored procedure code:

• Support for the "jdbc:default:connection" standard database connection url.

• A well-defined specification of the behaviour of the HSQLDB execution stack under stored procedure calls.

• A well-defined, pure JDBC specification for generating multiple results from HSQLDB stored procedures for client retrieval.

(boucherb@users)

Since:

1.7.2

Author:

boucherb@users

See Also:

• jdbcConnection.prepareCall(String)
• jdbcResultSet

Field Summary

Fields inherited from interface 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
jdbcCallableStatement(jdbcConnection c, String sql, int type)	Constructs a new jdbcCallableStatement with the specified connection and result type.

Method Summary

Modifier and Type	Method	Description
void	close()	Does the specialized work required to free this object's resources and that of it's parent classes.
Array	getArray(int parameterIndex)	Retrieves the value of the designated 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)	Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.
BigDecimal	getBigDecimal(int parameterIndex, int scale)	Deprecated. use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)
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 parameterIndex)	Retrieves the value of the designated 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)	Retrieves the value of the designated JDBC BIT parameter as a boolean in the Java programming language.
boolean	getBoolean(String parameterName)	(JDBC4 modified:) Retrieves the value of a JDBC BIT or BOOLEAN parameter as a boolean in the Java programming language.
byte	getByte(int parameterIndex)	Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.
byte	getByte(String parameterName)	Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
byte[]	getBytes(int parameterIndex)	Retrieves the value of the designated JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
byte[]	getBytes(String parameterName)	Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
Reader	getCharacterStream(int parameterIndex)
Reader	getCharacterStream(String parameterName)
Clob	getClob(int parameterIndex)	Retrieves the value of the designated 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)	Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.
Date	getDate(int parameterIndex, Calendar cal)	Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
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)	Retrieves the value of the designated 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)	Retrieves the value of the designated 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)	Retrieves the value of the designated 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)	Retrieves the value of the designated 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.
Reader	getNCharacterStream(int parameterIndex)
Reader	getNCharacterStream(String parameterName)
NClob	getNClob(int parameterIndex)
NClob	getNClob(String parameterName)
String	getNString(int parameterIndex)
String	getNString(String parameterName)
Object	getObject(int parameterIndex)	Retrieves the value of the designated parameter as an Object in the Java programming language.
<T> T	getObject(int ColumnIndex, Class<T> type)
Object	getObject(int parameterIndex, Map map)	Returns an object representing the value of OUT parameter parameterIndex 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.
<T> T	getObject(String columnLabel, Class<T> type)
Object	getObject(String parameterName, Map map)	Returns an object representing the value of OUT parameter parameterName and uses map for the custom mapping of the parameter value.
Ref	getRef(int parameterIndex)	Retrieves the value of the designated 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.
RowId	getRowId(int parameterIndex)
RowId	getRowId(String parameterName)
short	getShort(int parameterIndex)	Retrieves the value of the designated 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.
SQLXML	getSQLXML(int parameterIndex)
SQLXML	getSQLXML(String parameterName)
String	getString(int parameterIndex)	Retrieves the value of the designated 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)	Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.
Time	getTime(int parameterIndex, Calendar cal)	Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
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)	Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
Timestamp	getTimestamp(int parameterIndex, Calendar cal)	Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
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.
boolean	isPoolable()
boolean	isWrapperFor(Class<?> iface)
void	registerOutParameter(int parameterIndex, int sqlType)	Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.
void	registerOutParameter(int parameterIndex, int sqlType, int scale)	Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType.
void	registerOutParameter(int parameterIndex, int sqlType, 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(int parameterIndex, InputStream x)
void	setAsciiStream(int parameterIndex, InputStream x, long length)
void	setAsciiStream(String parameterName, InputStream x)
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	setAsciiStream(String parameterName, InputStream x, long length)
void	setBigDecimal(String parameterName, BigDecimal x)	Sets the designated parameter to the given java.math.BigDecimal value.
void	setBinaryStream(int parameterIndex, InputStream x)
void	setBinaryStream(int parameterIndex, InputStream x, long length)
void	setBinaryStream(String parameterName, InputStream x)
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	setBinaryStream(String parameterName, InputStream x, long length)
void	setBlob(int parameterIndex, InputStream inputStream)
void	setBlob(int parameterIndex, InputStream inputStream, long length)
void	setBlob(String parameterName, InputStream inputStream)
void	setBlob(String parameterName, InputStream inputStream, long length)
void	setBlob(String parameterName, Blob x)
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(int parameterIndex, Reader reader)
void	setCharacterStream(int parameterIndex, Reader reader, long length)
void	setCharacterStream(String parameterName, Reader reader)
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	setCharacterStream(String parameterName, Reader reader, long length)
void	setClob(int parameterIndex, Reader reader)
void	setClob(int parameterIndex, Reader reader, long length)
void	setClob(String parameterName, Reader reader)
void	setClob(String parameterName, Reader reader, long length)
void	setClob(String parameterName, Clob x)
void	setDate(String parameterName, Date x)	(JDBC4 clarification:) Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application.
void	setDate(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	setNCharacterStream(int parameterIndex, Reader value)
void	setNCharacterStream(int parameterIndex, Reader value, long length)
void	setNCharacterStream(String parameterName, Reader value)
void	setNCharacterStream(String parameterName, Reader value, long length)
void	setNClob(int parameterIndex, Reader reader)
void	setNClob(int parameterIndex, Reader reader, long length)
void	setNClob(int parameterIndex, NClob value)
void	setNClob(String parameterName, Reader reader)
void	setNClob(String parameterName, Reader reader, long length)
void	setNClob(String parameterName, NClob value)
void	setNString(int parameterIndex, String value)
void	setNString(String parameterName, String 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)	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	setPoolable(boolean poolable)
void	setRowId(int parameterIndex, RowId x)
void	setRowId(String parameterName, RowId x)
void	setShort(String parameterName, short x)	Sets the designated parameter to the given Java short value.
void	setSQLXML(int parameterIndex, SQLXML xmlObject)
void	setSQLXML(String parameterName, SQLXML xmlObject)
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.
<T> T	unwrap(Class<T> iface)
boolean	wasNull()	Retrieves whether the last OUT parameter read had the value of SQL NULL.

Methods inherited from class jdbcPreparedStatement

addBatch, addBatch, clearParameters, execute, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setEscapeProcessing, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL, toString

Methods inherited from class jdbcStatement

cancel, clearBatch, clearWarnings, closeOnCompletion, execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface CallableStatement

registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setObject, setObject

Methods inherited from interface PreparedStatement

addBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface Statement

addBatch, cancel, clearBatch, clearWarnings, 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, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setQueryTimeout

Constructor Details

jdbcCallableStatement

public jdbcCallableStatement(jdbcConnection c,
 String sql,
 int type)
                      throws org.hsqldb.HsqlException,
SQLException

Constructs a new jdbcCallableStatement with the specified connection and result type.

Parameters:

c - the connection on which this statement will execute

sql - the SQL statement this object represents

type - the type of result this statement will produce

Throws:

org.hsqldb.HsqlException - if the statement is not accepted by the database

SQLException - if preprocessing by driver fails

Method Details

close

public void close()
           throws SQLException

Does the specialized work required to free this object's resources and that of it's parent classes.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Overrides:

close in class jdbcPreparedStatement

Throws:

SQLException - if a database access error occurs

registerOutParameter

public void registerOutParameter(int parameterIndex,
 int sqlType)
                          throws SQLException

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(int) retrieves the value.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

registerOutParameter in interface CallableStatement

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

See Also:

• Types

registerOutParameter

public void registerOutParameter(int parameterIndex,
 int sqlType,
 int scale)
                          throws SQLException

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.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

registerOutParameter in interface CallableStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

sqlType - the SQL type code defined by java.sql.Types.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

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 SQL NULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it is null or not.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

wasNull in interface CallableStatement

Returns:

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

Throws:

SQLException - if a database access error occurs

getString

public String getString(int parameterIndex)
                 throws SQLException

Retrieves the value of the designated 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 (JDBC4 clarification:) SQL CHAR value had in the database, including any padding added by the database.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getString in interface CallableStatement

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

See Also:

• setString(String, String)

getBoolean

public boolean getBoolean(int parameterIndex)
                   throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBoolean in interface CallableStatement

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

See Also:

• setBoolean(String, boolean)

getByte

public byte getByte(int parameterIndex)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getByte in interface CallableStatement

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

See Also:

• setByte(String, byte)

getShort

public short getShort(int parameterIndex)
               throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getShort in interface CallableStatement

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

See Also:

• setShort(String, short)

getInt

public int getInt(int parameterIndex)
           throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getInt in interface CallableStatement

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

See Also:

• setInt(String, int)

getLong

public long getLong(int parameterIndex)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getLong in interface CallableStatement

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

See Also:

• setLong(String, long)

getFloat

public float getFloat(int parameterIndex)
               throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getFloat in interface CallableStatement

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

See Also:

• setFloat(String, float)

getDouble

public double getDouble(int parameterIndex)
                 throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getDouble in interface CallableStatement

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

See Also:

• setDouble(String, double)

getBigDecimal

public BigDecimal getBigDecimal(int parameterIndex,
 int scale)
                         throws SQLException

Deprecated.

use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBigDecimal in interface CallableStatement

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

See Also:

• setBigDecimal(String, BigDecimal)

getBytes

public byte[] getBytes(int parameterIndex)
                throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBytes in interface CallableStatement

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

See Also:

• setBytes(String, byte[])

getDate

public Date getDate(int parameterIndex)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getDate in interface CallableStatement

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

See Also:

• setDate(String, Date)

getTime

public Time getTime(int parameterIndex)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTime in interface CallableStatement

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

See Also:

• setTime(String, Time)

getTimestamp

public Timestamp getTimestamp(int parameterIndex)
                       throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTimestamp in interface CallableStatement

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

See Also:

• setTimestamp(String, Timestamp)

getObject

public Object getObject(int parameterIndex)
                 throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getObject in interface CallableStatement

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(String, Object, int, int)

getBigDecimal

public BigDecimal getBigDecimal(int parameterIndex)
                         throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBigDecimal in interface CallableStatement

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:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

See Also:

• setBigDecimal(String, BigDecimal)

getObject

public Object getObject(int parameterIndex,
 Map map)
                 throws SQLException

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

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getObject in interface CallableStatement

Parameters:

parameterIndex - 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:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

See Also:

• setObject(String, Object, int, int)

getRef

public Ref getRef(int parameterIndex)
           throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getRef in interface CallableStatement

Parameters:

parameterIndex - 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:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getBlob

public Blob getBlob(int parameterIndex)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBlob in interface CallableStatement

Parameters:

parameterIndex - 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:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getClob

public Clob getClob(int parameterIndex)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getClob in interface CallableStatement

Parameters:

parameterIndex - 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:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getArray

public Array getArray(int parameterIndex)
               throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getArray in interface CallableStatement

Parameters:

parameterIndex - 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:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getDate

public Date getDate(int parameterIndex,
 Calendar cal)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getDate in interface CallableStatement

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

Since:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

See Also:

• setDate(String, Date)

getTime

public Time getTime(int parameterIndex,
 Calendar cal)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTime in interface CallableStatement

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

Since:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

See Also:

• setTime(String, Time)

getTimestamp

public Timestamp getTimestamp(int parameterIndex,
 Calendar cal)
                       throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTimestamp in interface CallableStatement

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

Since:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

See Also:

• setTimestamp(String, Timestamp)

registerOutParameter

public void registerOutParameter(int parameterIndex,
 int sqlType,
 String typeName)
                          throws SQLException

Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-defined or REF output parameter. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

(JDBC4 claraification:) All OUT parameters must be registered before a stored procedure is executed.

For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined and REF parameters. Although it is intended for user-defined and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

registerOutParameter in interface CallableStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2,...

sqlType - a value from Types

typeName - the fully-qualified name of an SQL structured type

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

See Also:

• Types

registerOutParameter

public void registerOutParameter(String parameterName,
 int sqlType)
                          throws SQLException

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(int) retrieves the value.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

registerOutParameter in interface CallableStatement

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:

JDK 1.4, HSQL 1.7.0

See Also:

• Types

registerOutParameter

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

Registers the parameter named parameterName to be of JDBC type sqlType. (JDBC4 clarification:) All OUT parameters must be registered before a stored procedure is executed.

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

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

registerOutParameter in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• Types

registerOutParameter

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

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.

(JDBC4 clarification:) All OUT parameters must be registered before a stored procedure is executed.

For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getXXX method whose Java type XXX corresponds to the parameter's registered SQL type.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

registerOutParameter in interface CallableStatement

Parameters:

parameterName - the name of the parameter

sqlType - a value from Types

typeName - the fully-qualified name of an SQL structured type

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQL 1.7.0

See Also:

• Types

getURL

public URL getURL(int parameterIndex)
           throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getURL in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setURL(String, URL)

setURL

public void setURL(String parameterName,
 URL val)
            throws SQLException

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.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

setURL in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getURL(int)

setNull

public void setNull(String parameterName,
 int sqlType)
             throws SQLException

Sets the designated parameter to SQL NULL.

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

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setNull in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

setBoolean

public void setBoolean(String parameterName,
 boolean x)
                throws SQLException

Sets the designated parameter to the given Java boolean value. (JDBC4 clarification:) The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setBoolean in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getBoolean(int)

setByte

public void setByte(String parameterName,
 byte x)
             throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setByte in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getByte(int)

setShort

public void setShort(String parameterName,
 short x)
              throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setShort in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getShort(int)

setInt

public void setInt(String parameterName,
 int x)
            throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setInt in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getInt(int)

setLong

public void setLong(String parameterName,
 long x)
             throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setLong in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getLong(int)

setFloat

public void setFloat(String parameterName,
 float x)
              throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setFloat in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getFloat(int)

setDouble

public void setDouble(String parameterName,
 double x)
               throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setDouble in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getDouble(int)

setBigDecimal

public void setBigDecimal(String parameterName,
 BigDecimal x)
                   throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setBigDecimal in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getBigDecimal(int, int)

setString

public void setString(String parameterName,
 String x)
               throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setString in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

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

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setBytes in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getBytes(int)

setDate

public void setDate(String parameterName,
 Date x)
             throws SQLException

(JDBC4 clarification:) Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQL DATE value when it sends it to the database.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setDate in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getDate(int)

setTime

public void setTime(String parameterName,
 Time x)
             throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setTime in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getTime(int)

setTimestamp

public void setTimestamp(String parameterName,
 Timestamp x)
                  throws SQLException

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setTimestamp in interface CallableStatement

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

JDK 1.4, HSQLDB 1.7.0

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

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setAsciiStream in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

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

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setBinaryStream in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

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, 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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setObject in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

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 method setObject above, except that it assumes a scale of zero.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setObject in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

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

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setObject in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getObject(int)

setCharacterStream

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

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setCharacterStream in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

setDate

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

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setDate in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getDate(int)

setTime

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

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setTime in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getTime(int)

setTimestamp

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

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

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setTimestamp in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• getTimestamp(int)

setNull

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

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.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:

setNull in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

getString

public String getString(String parameterName)
                 throws SQLException

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 (JDBC4 clarification:) SQL CHAR value had in the database, including any padding added by the database.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getString in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setString(String, String)

getBoolean

public boolean getBoolean(String parameterName)
                   throws SQLException

(JDBC4 modified:) Retrieves the value of a JDBC BIT or BOOLEAN parameter as a boolean in the Java programming language.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBoolean in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setBoolean(String, boolean)

getByte

public byte getByte(String parameterName)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getByte in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setByte(String, byte)

getShort

public short getShort(String parameterName)
               throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getShort in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setShort(String, short)

getInt

public int getInt(String parameterName)
           throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getInt in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setInt(String, int)

getLong

public long getLong(String parameterName)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getLong in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setLong(String, long)

getFloat

public float getFloat(String parameterName)
               throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getFloat in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setFloat(String, float)

getDouble

public double getDouble(String parameterName)
                 throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getDouble in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setDouble(String, double)

getBytes

public byte[] getBytes(String parameterName)
                throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBytes in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setBytes(String, byte[])

getDate

public Date getDate(String parameterName)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getDate in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setDate(String, Date)

getTime

public Time getTime(String parameterName)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTime in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setTime(String, Time)

getTimestamp

public Timestamp getTimestamp(String parameterName)
                       throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTimestamp in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setTimestamp(String, Timestamp)

getObject

public Object getObject(String parameterName)
                 throws SQLException

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.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getObject in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• Types
• setObject(String, Object, int, int)

getBigDecimal

public BigDecimal getBigDecimal(String parameterName)
                         throws SQLException

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.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBigDecimal in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setBigDecimal(String, BigDecimal)

getObject

public Object getObject(String parameterName,
 Map map)
                 throws SQLException

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

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getObject in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setObject(String, Object, int, int)

getRef

public Ref getRef(String parameterName)
           throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getRef in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

getBlob

public Blob getBlob(String parameterName)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getBlob in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

getClob

public Clob getClob(String parameterName)
             throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getClob in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

getArray

public Array getArray(String parameterName)
               throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getArray in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

getDate

public Date getDate(String parameterName,
 Calendar cal)
             throws SQLException

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 d river uses the default timezone and locale.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getDate in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setDate(String, Date)

getTime

public Time getTime(String parameterName,
 Calendar cal)
             throws SQLException

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.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTime in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setTime(String, Time)

getTimestamp

public Timestamp getTimestamp(String parameterName,
 Calendar cal)
                       throws SQLException

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.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getTimestamp in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setTimestamp(String, Timestamp)

getURL

public URL getURL(String parameterName)
           throws SQLException

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:

getURL in interface CallableStatement

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:

JDK 1.4, HSQLDB 1.7.0

See Also:

• setURL(String, URL)

setPoolable

public void setPoolable(boolean poolable)
                 throws SQLException

Specified by:

setPoolable in interface Statement

Overrides:

setPoolable in class jdbcPreparedStatement

Throws:

SQLException

isPoolable

public boolean isPoolable()
                   throws SQLException

Specified by:

isPoolable in interface Statement

Overrides:

isPoolable in class jdbcPreparedStatement

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Overrides:

unwrap in class jdbcPreparedStatement

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Overrides:

isWrapperFor in class jdbcPreparedStatement

Throws:

SQLException

setRowId

public void setRowId(int parameterIndex,
 RowId x)
              throws SQLException

Specified by:

setRowId in interface PreparedStatement

Overrides:

setRowId in class jdbcPreparedStatement

Throws:

SQLException

setNString

public void setNString(int parameterIndex,
 String value)
                throws SQLException

Specified by:

setNString in interface PreparedStatement

Overrides:

setNString in class jdbcPreparedStatement

Throws:

SQLException

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
 Reader value,
 long length)
                         throws SQLException

Specified by:

setNCharacterStream in interface PreparedStatement

Overrides:

setNCharacterStream in class jdbcPreparedStatement

Throws:

SQLException

setNClob

public void setNClob(int parameterIndex,
 NClob value)
              throws SQLException

Specified by:

setNClob in interface PreparedStatement

Overrides:

setNClob in class jdbcPreparedStatement

Throws:

SQLException

setClob

public void setClob(int parameterIndex,
 Reader reader,
 long length)
             throws SQLException

Specified by:

setClob in interface PreparedStatement

Overrides:

setClob in class jdbcPreparedStatement

Throws:

SQLException

setBlob

public void setBlob(int parameterIndex,
 InputStream inputStream,
 long length)
             throws SQLException

Specified by:

setBlob in interface PreparedStatement

Overrides:

setBlob in class jdbcPreparedStatement

Throws:

SQLException

setNClob

public void setNClob(int parameterIndex,
 Reader reader,
 long length)
              throws SQLException

Specified by:

setNClob in interface PreparedStatement

Overrides:

setNClob in class jdbcPreparedStatement

Throws:

SQLException

setSQLXML

public void setSQLXML(int parameterIndex,
 SQLXML xmlObject)
               throws SQLException

Specified by:

setSQLXML in interface PreparedStatement

Overrides:

setSQLXML in class jdbcPreparedStatement

Throws:

SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
 InputStream x,
 long length)
                    throws SQLException

Specified by:

setAsciiStream in interface PreparedStatement

Overrides:

setAsciiStream in class jdbcPreparedStatement

Throws:

SQLException

setBinaryStream

public void setBinaryStream(int parameterIndex,
 InputStream x,
 long length)
                     throws SQLException

Specified by:

setBinaryStream in interface PreparedStatement

Overrides:

setBinaryStream in class jdbcPreparedStatement

Throws:

SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
 Reader reader,
 long length)
                        throws SQLException

Specified by:

setCharacterStream in interface PreparedStatement

Overrides:

setCharacterStream in class jdbcPreparedStatement

Throws:

SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
 InputStream x)
                    throws SQLException

Specified by:

setAsciiStream in interface PreparedStatement

Overrides:

setAsciiStream in class jdbcPreparedStatement

Throws:

SQLException

setBinaryStream

public void setBinaryStream(int parameterIndex,
 InputStream x)
                     throws SQLException

Specified by:

setBinaryStream in interface PreparedStatement

Overrides:

setBinaryStream in class jdbcPreparedStatement

Throws:

SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
 Reader reader)
                        throws SQLException

Specified by:

setCharacterStream in interface PreparedStatement

Overrides:

setCharacterStream in class jdbcPreparedStatement

Throws:

SQLException

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
 Reader value)
                         throws SQLException

Specified by:

setNCharacterStream in interface PreparedStatement

Overrides:

setNCharacterStream in class jdbcPreparedStatement

Throws:

SQLException

setClob

public void setClob(int parameterIndex,
 Reader reader)
             throws SQLException

Specified by:

setClob in interface PreparedStatement

Overrides:

setClob in class jdbcPreparedStatement

Throws:

SQLException

setBlob

public void setBlob(int parameterIndex,
 InputStream inputStream)
             throws SQLException

Specified by:

setBlob in interface PreparedStatement

Overrides:

setBlob in class jdbcPreparedStatement

Throws:

SQLException

setNClob

public void setNClob(int parameterIndex,
 Reader reader)
              throws SQLException

Specified by:

setNClob in interface PreparedStatement

Overrides:

setNClob in class jdbcPreparedStatement

Throws:

SQLException

getRowId

public RowId getRowId(int parameterIndex)
               throws SQLException

Specified by:

getRowId in interface CallableStatement

Throws:

SQLException

getRowId

public RowId getRowId(String parameterName)
               throws SQLException

Specified by:

getRowId in interface CallableStatement

Throws:

SQLException

setRowId

public void setRowId(String parameterName,
 RowId x)
              throws SQLException

Specified by:

setRowId in interface CallableStatement

Throws:

SQLException

setNString

public void setNString(String parameterName,
 String value)
                throws SQLException

Specified by:

setNString in interface CallableStatement

Throws:

SQLException

setNCharacterStream

public void setNCharacterStream(String parameterName,
 Reader value,
 long length)
                         throws SQLException

Specified by:

setNCharacterStream in interface CallableStatement

Throws:

SQLException

setNClob

public void setNClob(String parameterName,
 NClob value)
              throws SQLException

Specified by:

setNClob in interface CallableStatement

Throws:

SQLException

setClob

public void setClob(String parameterName,
 Reader reader,
 long length)
             throws SQLException

Specified by:

setClob in interface CallableStatement

Throws:

SQLException

setBlob

public void setBlob(String parameterName,
 InputStream inputStream,
 long length)
             throws SQLException

Specified by:

setBlob in interface CallableStatement

Throws:

SQLException

setNClob

public void setNClob(String parameterName,
 Reader reader,
 long length)
              throws SQLException

Specified by:

setNClob in interface CallableStatement

Throws:

SQLException

getNClob

public NClob getNClob(int parameterIndex)
               throws SQLException

Specified by:

getNClob in interface CallableStatement

Throws:

SQLException

getNClob

public NClob getNClob(String parameterName)
               throws SQLException

Specified by:

getNClob in interface CallableStatement

Throws:

SQLException

setSQLXML

public void setSQLXML(String parameterName,
 SQLXML xmlObject)
               throws SQLException

Specified by:

setSQLXML in interface CallableStatement

Throws:

SQLException

getSQLXML

public SQLXML getSQLXML(int parameterIndex)
                 throws SQLException

Specified by:

getSQLXML in interface CallableStatement

Throws:

SQLException

getSQLXML

public SQLXML getSQLXML(String parameterName)
                 throws SQLException

Specified by:

getSQLXML in interface CallableStatement

Throws:

SQLException

getNString

public String getNString(int parameterIndex)
                  throws SQLException

Specified by:

getNString in interface CallableStatement

Throws:

SQLException

getNString

public String getNString(String parameterName)
                  throws SQLException

Specified by:

getNString in interface CallableStatement

Throws:

SQLException

getNCharacterStream

public Reader getNCharacterStream(int parameterIndex)
                           throws SQLException

Specified by:

getNCharacterStream in interface CallableStatement

Throws:

SQLException

getNCharacterStream

public Reader getNCharacterStream(String parameterName)
                           throws SQLException

Specified by:

getNCharacterStream in interface CallableStatement

Throws:

SQLException

getCharacterStream

public Reader getCharacterStream(int parameterIndex)
                          throws SQLException

Specified by:

getCharacterStream in interface CallableStatement

Throws:

SQLException

getCharacterStream

public Reader getCharacterStream(String parameterName)
                          throws SQLException

Specified by:

getCharacterStream in interface CallableStatement

Throws:

SQLException

setBlob

public void setBlob(String parameterName,
 Blob x)
             throws SQLException

Specified by:

setBlob in interface CallableStatement

Throws:

SQLException

setClob

public void setClob(String parameterName,
 Clob x)
             throws SQLException

Specified by:

setClob in interface CallableStatement

Throws:

SQLException

setAsciiStream

public void setAsciiStream(String parameterName,
 InputStream x,
 long length)
                    throws SQLException

Specified by:

setAsciiStream in interface CallableStatement

Throws:

SQLException

setBinaryStream

public void setBinaryStream(String parameterName,
 InputStream x,
 long length)
                     throws SQLException

Specified by:

setBinaryStream in interface CallableStatement

Throws:

SQLException

setCharacterStream

public void setCharacterStream(String parameterName,
 Reader reader,
 long length)
                        throws SQLException

Specified by:

setCharacterStream in interface CallableStatement

Throws:

SQLException

setAsciiStream

public void setAsciiStream(String parameterName,
 InputStream x)
                    throws SQLException

Specified by:

setAsciiStream in interface CallableStatement

Throws:

SQLException

setBinaryStream

public void setBinaryStream(String parameterName,
 InputStream x)
                     throws SQLException

Specified by:

setBinaryStream in interface CallableStatement

Throws:

SQLException

setCharacterStream

public void setCharacterStream(String parameterName,
 Reader reader)
                        throws SQLException

Specified by:

setCharacterStream in interface CallableStatement

Throws:

SQLException

setNCharacterStream

public void setNCharacterStream(String parameterName,
 Reader value)
                         throws SQLException

Specified by:

setNCharacterStream in interface CallableStatement

Throws:

SQLException

setClob

public void setClob(String parameterName,
 Reader reader)
             throws SQLException

Specified by:

setClob in interface CallableStatement

Throws:

SQLException

setBlob

public void setBlob(String parameterName,
 InputStream inputStream)
             throws SQLException

Specified by:

setBlob in interface CallableStatement

Throws:

SQLException

setNClob

public void setNClob(String parameterName,
 Reader reader)
              throws SQLException

Specified by:

setNClob in interface CallableStatement

Throws:

SQLException

getObject

public <T> T getObject(String columnLabel,
 Class<T> type)
                throws SQLException

Specified by:

getObject in interface CallableStatement

Throws:

SQLException

getObject

public <T> T getObject(int ColumnIndex,
 Class<T> type)
                throws SQLException

Specified by:

getObject in interface CallableStatement

Throws:

SQLException