org.hsqldb.jdbc
Class jdbcCallableStatement

java.lang.Object
  extended byorg.hsqldb.jdbc.jdbcStatement
      extended byorg.hsqldb.jdbc.jdbcPreparedStatement
          extended byorg.hsqldb.jdbc.jdbcCallableStatement
All Implemented Interfaces:
java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement

public class jdbcCallableStatement
extends jdbcPreparedStatement
implements java.sql.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 PreparedStatement. The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the get methods provided here.

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

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

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

(boucherb@users)

Since:
1.7.2
Author:
boucherb@users
See Also:
jdbcConnection.prepareCall(java.lang.String), jdbcResultSet

Field Summary
 
Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
 
Constructor Summary
jdbcCallableStatement(jdbcConnection c, java.lang.String sql, int type)
          Constructs a new jdbcCallableStatement with the specified connection and result type.
 
Method Summary
 void close()
          Does the specialized work required to free this object's resources and that of it's parent classes.
 java.sql.Array getArray(int i)
           Retrieves the value of the designated JDBC ARRAY parameter as an Array object in the Java programming language.
 java.sql.Array getArray(java.lang.String parameterName)
           Retrieves the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
 java.math.BigDecimal getBigDecimal(int parameterIndex)
           Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.
 java.math.BigDecimal getBigDecimal(int parameterIndex, int scale)
          Deprecated. use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)
 java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
           Retrieves the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.
 java.sql.Blob getBlob(int i)
           Retrieves the value of the designated JDBC BLOB parameter as a Blob object in the Java programming language.
 java.sql.Blob getBlob(java.lang.String parameterName)
           Retrieves the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
 boolean getBoolean(int parameterIndex)
           Retrieves the value of the designated JDBC BIT parameter as a boolean in the Java programming language.
 boolean getBoolean(java.lang.String parameterName)
           Retrieves the value of a JDBC BIT parameter as a boolean in the Java programming language.
 byte getByte(int parameterIndex)
           Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.
 byte getByte(java.lang.String parameterName)
           Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
 byte[] getBytes(int parameterIndex)
           Retrieves the value of the designated JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
 byte[] getBytes(java.lang.String parameterName)
           Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
 java.sql.Clob getClob(int i)
           Retrieves the value of the designated JDBC CLOB parameter as a Clob object in the Java programming l anguage.
 java.sql.Clob getClob(java.lang.String parameterName)
           Retrieves the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
 java.sql.Date getDate(int parameterIndex)
           Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.
 java.sql.Date getDate(int parameterIndex, java.util.Calendar cal)
           Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
 java.sql.Date getDate(java.lang.String parameterName)
           Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.
 java.sql.Date getDate(java.lang.String parameterName, java.util.Calendar cal)
           Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
 double getDouble(int parameterIndex)
           Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.
 double getDouble(java.lang.String parameterName)
           Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
 float getFloat(int parameterIndex)
           Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.
 float getFloat(java.lang.String parameterName)
           Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
 int getInt(int parameterIndex)
           Retrieves the value of the designated JDBC INTEGER parameter as an int in the Java programming language.
 int getInt(java.lang.String parameterName)
           Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
 long getLong(int parameterIndex)
           Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.
 long getLong(java.lang.String parameterName)
           Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
 java.lang.Object getObject(int parameterIndex)
           Retrieves the value of the designated parameter as an Object in the Java programming language.
 java.lang.Object getObject(int i, java.util.Map map)
           Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
 java.lang.Object getObject(java.lang.String parameterName)
           Retrieves the value of a parameter as an Object in the Java programming language.
 java.lang.Object getObject(java.lang.String parameterName, java.util.Map map)
           Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
 java.sql.Ref getRef(int i)
           Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
 java.sql.Ref getRef(java.lang.String parameterName)
           Retrieves the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
 short getShort(int parameterIndex)
           Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.
 short getShort(java.lang.String parameterName)
           Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.
 java.lang.String getString(int parameterIndex)
           Retrieves the value of the designated JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
 java.lang.String getString(java.lang.String parameterName)
           Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
 java.sql.Time getTime(int parameterIndex)
           Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.
 java.sql.Time getTime(int parameterIndex, java.util.Calendar cal)
           Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
 java.sql.Time getTime(java.lang.String parameterName)
           Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.
 java.sql.Time getTime(java.lang.String parameterName, java.util.Calendar cal)
           Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
 java.sql.Timestamp getTimestamp(int parameterIndex)
           Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
 java.sql.Timestamp getTimestamp(int parameterIndex, java.util.Calendar cal)
           Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
 java.sql.Timestamp getTimestamp(java.lang.String parameterName)
           Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
 java.sql.Timestamp getTimestamp(java.lang.String parameterName, java.util.Calendar cal)
           Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
 java.net.URL getURL(int parameterIndex)
           Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.
 java.net.URL getURL(java.lang.String parameterName)
           Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.
 void registerOutParameter(int parameterIndex, int sqlType)
           Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.
 void registerOutParameter(int parameterIndex, int sqlType, int scale)
           Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType.
 void registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName)
           Registers the designated output parameter.
 void registerOutParameter(java.lang.String parameterName, int sqlType)
           Registers the OUT parameter named parameterName to the JDBC type sqlType.
 void registerOutParameter(java.lang.String parameterName, int sqlType, int scale)
           Registers the parameter named parameterName to be of JDBC type sqlType.
 void registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName)
           Registers the designated output parameter.
 void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length)
           Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)
           Sets the designated parameter to the given java.math.BigDecimal value.
 void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length)
           Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 void setBoolean(java.lang.String parameterName, boolean x)
           Sets the designated parameter to the given Java boolean value.
 void setByte(java.lang.String parameterName, byte x)
           Sets the designated parameter to the given Java byte value.
 void setBytes(java.lang.String parameterName, byte[] x)
           Sets the designated parameter to the given Java array of bytes.
 void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length)
           Sets the designated parameter to the given Reader object, which is the given number of characters long.
 void setDate(java.lang.String parameterName, java.sql.Date x)
           Sets the designated parameter to the given java.sql.Date value.
 void setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)
           Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
 void setDouble(java.lang.String parameterName, double x)
           Sets the designated parameter to the given Java double value.
 void setFloat(java.lang.String parameterName, float x)
           Sets the designated parameter to the given Java float value.
 void setInt(java.lang.String parameterName, int x)
           Sets the designated parameter to the given Java int value.
 void setLong(java.lang.String parameterName, long x)
           Sets the designated parameter to the given Java long value.
 void setNull(java.lang.String parameterName, int sqlType)
           Sets the designated parameter to SQL NULL.
 void setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)
           Sets the designated parameter to SQL NULL.
 void setObject(java.lang.String parameterName, java.lang.Object x)
           Sets the value of the designated parameter with the given object.
 void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType)
           Sets the value of the designated parameter with the given object.
 void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)
           Sets the value of the designated parameter with the given object.
 void setShort(java.lang.String parameterName, short x)
           Sets the designated parameter to the given Java short value.
 void setString(java.lang.String parameterName, java.lang.String x)
           Sets the designated parameter to the given Java String value.
 void setTime(java.lang.String parameterName, java.sql.Time x)
           Sets the designated parameter to the given java.sql.Time value.
 void setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal)
           Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
 void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x)
           Sets the designated parameter to the given java.sql.Timestamp value.
 void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal)
           Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
 void setURL(java.lang.String parameterName, java.net.URL val)
           Sets the designated parameter to the given java.net.URL object.
 boolean wasNull()
           Retrieves whether the last OUT parameter read had the value of SQL NULL.
 
Methods inherited from class org.hsqldb.jdbc.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 org.hsqldb.jdbc.jdbcStatement
cancel, clearBatch, clearWarnings, execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
 
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

Constructor Detail

jdbcCallableStatement

public jdbcCallableStatement(jdbcConnection c,
                             java.lang.String sql,
                             int type)
                      throws HsqlException,
                             java.sql.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:
HsqlException - if the statement is not accepted by the database
java.sql.SQLException - if preprocessing by driver fails
Method Detail

close

public void close()
           throws java.sql.SQLException
Does the specialized work required to free this object's resources and that of it's parent classes.

Specified by:
close in interface java.sql.Statement
Overrides:
close in class jdbcPreparedStatement
Throws:
java.sql.SQLException - if a database access error occurs

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType)
                          throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
Types

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType,
                                 int scale)
                          throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
Types

wasNull

public boolean wasNull()
                throws java.sql.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 java.sql.CallableStatement
Returns:
true if the last parameter read was SQL NULL; false otherwise
Throws:
java.sql.SQLException - if a database access error occurs

getString

public java.lang.String getString(int parameterIndex)
                           throws java.sql.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 JDBC 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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setString(java.lang.String, java.lang.String)

getBoolean

public boolean getBoolean(int parameterIndex)
                   throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setBoolean(java.lang.String, boolean)

getByte

public byte getByte(int parameterIndex)
             throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setByte(java.lang.String, byte)

getShort

public short getShort(int parameterIndex)
               throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setShort(java.lang.String, short)

getInt

public int getInt(int parameterIndex)
           throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setInt(java.lang.String, int)

getLong

public long getLong(int parameterIndex)
             throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setLong(java.lang.String, long)

getFloat

public float getFloat(int parameterIndex)
               throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setFloat(java.lang.String, float)

getDouble

public double getDouble(int parameterIndex)
                 throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setDouble(java.lang.String, double)

getBigDecimal

public java.math.BigDecimal getBigDecimal(int parameterIndex,
                                          int scale)
                                   throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getBytes

public byte[] getBytes(int parameterIndex)
                throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setBytes(java.lang.String, byte[])

getDate

public java.sql.Date getDate(int parameterIndex)
                      throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setDate(java.lang.String, java.sql.Date)

getTime

public java.sql.Time getTime(int parameterIndex)
                      throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public java.sql.Timestamp getTimestamp(int parameterIndex)
                                throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

public java.lang.Object getObject(int parameterIndex)
                           throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
See Also:
Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

public java.math.BigDecimal getBigDecimal(int parameterIndex)
                                   throws java.sql.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 java.sql.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:
java.sql.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(java.lang.String, java.math.BigDecimal)

getObject

public java.lang.Object getObject(int i,
                                  java.util.Map map)
                           throws java.sql.SQLException
Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:
getObject in interface java.sql.CallableStatement
Parameters:
i - the first parameter is 1, the second is 2, and so on
map - the mapping from SQL type names to Java classes
Returns:
a java.lang.Object holding the OUT parameter value
Throws:
java.sql.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(java.lang.String, java.lang.Object, int, int)

getRef

public java.sql.Ref getRef(int i)
                    throws java.sql.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 java.sql.CallableStatement
Parameters:
i - the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getBlob

public java.sql.Blob getBlob(int i)
                      throws java.sql.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 java.sql.CallableStatement
Parameters:
i - the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getClob

public java.sql.Clob getClob(int i)
                      throws java.sql.SQLException
Retrieves the value of the designated JDBC CLOB parameter as a Clob object in the Java programming l anguage.

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:
getClob in interface java.sql.CallableStatement
Parameters:
i - the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getArray

public java.sql.Array getArray(int i)
                        throws java.sql.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 java.sql.CallableStatement
Parameters:
i - the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

getDate

public java.sql.Date getDate(int parameterIndex,
                             java.util.Calendar cal)
                      throws java.sql.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 java.sql.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:
java.sql.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(java.lang.String, java.sql.Date)

getTime

public java.sql.Time getTime(int parameterIndex,
                             java.util.Calendar cal)
                      throws java.sql.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 java.sql.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:
java.sql.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(java.lang.String, java.sql.Time)

getTimestamp

public java.sql.Timestamp getTimestamp(int parameterIndex,
                                       java.util.Calendar cal)
                                throws java.sql.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 java.sql.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:
java.sql.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(java.lang.String, java.sql.Timestamp)

registerOutParameter

public void registerOutParameter(int paramIndex,
                                 int sqlType,
                                 java.lang.String typeName)
                          throws java.sql.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. Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined and REF parameters. Although it is intended for user-defined and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
Parameters:
paramIndex - the first parameter is 1, the second is 2,...
sqlType - a value from Types
typeName - the fully-qualified name of an SQL structured type
Throws:
java.sql.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(java.lang.String parameterName,
                                 int sqlType)
                          throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQL 1.7.0
See Also:
Types

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 int scale)
                          throws java.sql.SQLException
Registers the parameter named parameterName to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

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

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:
registerOutParameter in interface java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
Types

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 java.lang.String typeName)
                          throws java.sql.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. Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
sqlType - a value from Types
typeName - the fully-qualified name of an SQL structured type
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQL 1.7.0
See Also:
Types

getURL

public java.net.URL getURL(int parameterIndex)
                    throws java.sql.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 java.sql.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:
java.sql.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(java.lang.String, java.net.URL)

setURL

public void setURL(java.lang.String parameterName,
                   java.net.URL val)
            throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
val - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs, or if a URL is malformed
Since:
JDK 1.4, HSQL 1.7.0
See Also:
getURL(int)

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType)
             throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
sqlType - the SQL type code defined in java.sql.Types
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

setBoolean

public void setBoolean(java.lang.String parameterName,
                       boolean x)
                throws java.sql.SQLException
Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:
setBoolean in interface java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getBoolean(int)

setByte

public void setByte(java.lang.String parameterName,
                    byte x)
             throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getByte(int)

setShort

public void setShort(java.lang.String parameterName,
                     short x)
              throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getShort(int)

setInt

public void setInt(java.lang.String parameterName,
                   int x)
            throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getInt(int)

setLong

public void setLong(java.lang.String parameterName,
                    long x)
             throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getLong(int)

setFloat

public void setFloat(java.lang.String parameterName,
                     float x)
              throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getFloat(int)

setDouble

public void setDouble(java.lang.String parameterName,
                      double x)
               throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getDouble(int)

setBigDecimal

public void setBigDecimal(java.lang.String parameterName,
                          java.math.BigDecimal x)
                   throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getBigDecimal(int, int)

setString

public void setString(java.lang.String parameterName,
                      java.lang.String x)
               throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getString(int)

setBytes

public void setBytes(java.lang.String parameterName,
                     byte[] x)
              throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getBytes(int)

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x)
             throws java.sql.SQLException
Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

HSQLDB-Specific Information:

Starting with 1.7.2, HSLQDB supports this.

Specified by:
setDate in interface java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getDate(int)

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x)
             throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getTime(int)

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x)
                  throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getTimestamp(int)

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
Types, getObject(int)

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getObject(int)

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x)
               throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
x - the object containing the input parameter value
Throws:
java.sql.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(java.lang.String parameterName,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getDate(int)

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getTime(int)

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
getTimestamp(int)

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

getString

public java.lang.String getString(java.lang.String parameterName)
                           throws java.sql.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 JDBC 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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setString(java.lang.String, java.lang.String)

getBoolean

public boolean getBoolean(java.lang.String parameterName)
                   throws java.sql.SQLException
Retrieves the value of a 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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is false.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setBoolean(java.lang.String, boolean)

getByte

public byte getByte(java.lang.String parameterName)
             throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setByte(java.lang.String, byte)

getShort

public short getShort(java.lang.String parameterName)
               throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setShort(java.lang.String, short)

getInt

public int getInt(java.lang.String parameterName)
           throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setInt(java.lang.String, int)

getLong

public long getLong(java.lang.String parameterName)
             throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setLong(java.lang.String, long)

getFloat

public float getFloat(java.lang.String parameterName)
               throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setFloat(java.lang.String, float)

getDouble

public double getDouble(java.lang.String parameterName)
                 throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setDouble(java.lang.String, double)

getBytes

public byte[] getBytes(java.lang.String parameterName)
                throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setBytes(java.lang.String, byte[])

getDate

public java.sql.Date getDate(java.lang.String parameterName)
                      throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setDate(java.lang.String, java.sql.Date)

getTime

public java.sql.Time getTime(java.lang.String parameterName)
                      throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName)
                                throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

public java.lang.Object getObject(java.lang.String parameterName)
                           throws java.sql.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 java.sql.CallableStatement
Parameters:
parameterName - the name of the parameter
Returns:
A java.lang.Object holding the OUT parameter value.
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
                                   throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getObject

public java.lang.Object getObject(java.lang.String parameterName,
                                  java.util.Map map)
                           throws java.sql.SQLException
Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

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

HSQLDB-Specific Information:

HSQLDB 1.7.2 does not support this feature.

Calling this method always throws an SQLException.

Specified by:
getObject in interface java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setObject(java.lang.String, java.lang.Object, int, int)

getRef

public java.sql.Ref getRef(java.lang.String parameterName)
                    throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

getBlob

public java.sql.Blob getBlob(java.lang.String parameterName)
                      throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

getClob

public java.sql.Clob getClob(java.lang.String parameterName)
                      throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

getArray

public java.sql.Array getArray(java.lang.String parameterName)
                        throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0

getDate

public java.sql.Date getDate(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setDate(java.lang.String, java.sql.Date)

getTime

public java.sql.Time getTime(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName,
                                       java.util.Calendar cal)
                                throws java.sql.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 java.sql.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:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQLDB 1.7.0
See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)

getURL

public java.net.URL getURL(java.lang.String parameterName)
                    throws java.sql.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 java.sql.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:
java.sql.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(java.lang.String, java.net.URL)


Copyright 2001 - 2004 HSQL Development Group. All Rights Reserved.