org.hsqldb
Class jdbcPreparedStatement

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

public class jdbcPreparedStatement
extends jdbcStatement
implements java.sql.PreparedStatement, java.sql.CallableStatement

Implements both the java.sql.PreparedStatement and java.sql.CallableStatement interfaces.

In short:

The following is composed of three sections:

  1. The generic overview for PreparedStatement.
  2. The generic overview for CallableStatement.
  3. A discussion of some HSQLDB-specific concerns.

From PreparedStatement:

An object that represents a precompiled SQL statement.

A SQL statement is precompiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: The setter methods (setShort, setString, and so on) for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type INTEGER, then the method setInt should be used.

If arbitrary parameter type conversions are required, the method setObject should be used with a target SQL type.

In the following example of setting a parameter, con represents an active connection:

 PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
                               SET SALARY = ? WHERE ID = ?");
 pstmt.setBigDecimal(1, 153833.00)
 pstmt.setInt(2, 110592)
 

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

Up to and including HSQLDB 1.7.0, support for stored procedures is not provided in the conventional fashion, if there is such a thing.

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

HSQLDB stored procedures map directly onto the methods of compiled Java classes found on the classpath of the engine. 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_name FOR ""package.class.method" -- optional
 
This has the effect of allowing the specified user(s) to access all of the public static methods of the specified class in either the role of SQL functions or stored procedures. For example:
 GRANT ALL ON CLASS "java.lang.Math" TO PUBLIC;
 CONNECT anyuser PASSWORD *****;
 SELECT "java.lang.Math.abs"(column_1) FROM table_1;
 CREATE ALIAS abs FOR "java.lang.Math.abs"
 CALL abs(-5);
 
However, no support for more advanced features is provided at this time. That is, the CallableStatement methods for working with OUT parameters are not yet supported because--at a lower level--in all cases the HSQLDB database engine notes and returns only the result set or update count generated by executing a statement.

So, while some systems may require working with OUT parameters when calling stored procedures, this is currently never the case for HSQLDB; attempting to do so will always result in throwing a SQLException, stating that the function is not supported.

Please also note that the HSQLDB stored procedure mechanism is essentially a wrap of the HSQLDB SQL function mechanism, simply allowing Java methods to be called outside of an INSERT, UPDATE, DELETE or SELECT statement context. That is, issuing any CALL statement has virtually the the same effect as:

 CREATE TABLE DUAL (dummy VARCHAR);
 INSERT INTO DUAL VALUES NULL;
 SELECT "package.class.method"(paramter_list) FROM DUAL;
 
In other words, HSQLDB does not yet support stored procedures that return true result sets. Instead, Java methods invoked as HSQLDB stored procedures must return a single value that is compatible with a supported HSQLDB SQL type. Furthermore, the return value is always wrapped in a result object with one column and one row, before it is handed off to client code.

This behviour will definitely change in 1.7.1 and above, in that HSQLDB will also allow stored procedures to return a single, true result set. However, it is uncertain at this time when/if support for OUT parameters will be introduced.

JRE 1.1.x Notes:

In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires Java 1.4 and above. In HSQLDB, support for methods introduced in different versions of JDBC depends on the JDK version used for compiling and building HSQLDB.

Since 1.7.0, it is possible to build the product so that all JDBC 2 methods can be called while executing under the version 1.1.x Java Runtime EnvironmentTM. However, some of these method calls require int values that are defined only in the JDBC 2 or greater version of ResultSet interface. For this reason, when the product is compiled under JDK 1.1.x, these values are defined in jdbcResultSet.

In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the JDBC2-only ResultSet values can be achieved by referring to them in parameter specifications and return value comparisons, respectively, as follows:

jdbcResultSet.FETCH_FORWARD
jdbcResultSet.TYPE_FORWARD_ONLY
jdbcResultSet.TYPE_SCROLL_INSENSITIVE
jdbcResultSet.CONCUR_READ_ONLY

However, please note that code written in such a manner will not be compatible for use with other JDBC 2 drivers, since they expect and use ResultSet, rather than jdbcResultSet. Also note, this feature is offered solely as a convenience to developers who must work under JDK 1.1.x due to operating constraints, yet wish to use some of the more advanced features available under the JDBC 2 specification.

(fredt@users)
(boucherb@users)

See Also:
jdbcConnection.prepareStatement(java.lang.String), 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
 
Method Summary
 void addBatch()
           Adds a set of parameters to this PreparedStatement object's batch of commands.
 void clearParameters()
           Clears the current parameter values immediately.
 boolean execute()
           Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
 java.sql.ResultSet executeQuery()
           Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
 int executeUpdate()
           Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.
 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.sql.ResultSetMetaData getMetaData()
           Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.
 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.ParameterMetaData getParameterMetaData()
           Retrieves the number, types and properties of this PreparedStatement object's parameters.
 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 setArray(int i, java.sql.Array x)
           Sets the designated parameter to the given Array object.
 void setAsciiStream(int parameterIndex, java.io.InputStream x, int length)
           Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 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(int parameterIndex, java.math.BigDecimal x)
           Sets the designated parameter to the given java.math.BigDecimal value.
 void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)
           Sets the designated parameter to the given java.math.BigDecimal value.
 void setBinaryStream(int parameterIndex, java.io.InputStream x, int length)
           Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 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 setBlob(int i, java.sql.Blob x)
           Sets the designated parameter to the given Blob object.
 void setBoolean(int parameterIndex, boolean x)
           Sets the designated parameter to the given Java boolean value.
 void setBoolean(java.lang.String parameterName, boolean x)
           Sets the designated parameter to the given Java boolean value.
 void setByte(int parameterIndex, byte x)
           Sets the designated parameter to the given Java byte value.
 void setByte(java.lang.String parameterName, byte x)
           Sets the designated parameter to the given Java byte value.
 void setBytes(int parameterIndex, byte[] x)
           Sets the designated parameter to the given Java array of bytes.
 void setBytes(java.lang.String parameterName, byte[] x)
           Sets the designated parameter to the given Java array of bytes.
 void setCharacterStream(int parameterIndex, java.io.Reader reader, int length)
           Sets the designated parameter to the given Reader object, which is the given number of characters long.
 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 setClob(int i, java.sql.Clob x)
           Sets the designated parameter to the given Clob object.
 void setDate(int parameterIndex, java.sql.Date x)
           Sets the designated parameter to the given java.sql.Date value.
 void setDate(int parameterIndex, 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 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(int parameterIndex, double x)
           Sets the designated parameter to the given Java double value.
 void setDouble(java.lang.String parameterName, double x)
           Sets the designated parameter to the given Java double value.
 void setEscapeProcessing(boolean enable)
           Sets escape processing on or off.
 void setFloat(int parameterIndex, float x)
           Sets the designated parameter to the given Java float value.
 void setFloat(java.lang.String parameterName, float x)
           Sets the designated parameter to the given Java float value.
 void setInt(int parameterIndex, int x)
           Sets the designated parameter to the given Java int value.
 void setInt(java.lang.String parameterName, int x)
           Sets the designated parameter to the given Java int value.
 void setLong(int parameterIndex, long x)
           Sets the designated parameter to the given Java long value.
 void setLong(java.lang.String parameterName, long x)
           Sets the designated parameter to the given Java long value.
 void setNull(int parameterIndex, int sqlType)
           Sets the designated parameter to SQL NULL.
 void setNull(int paramIndex, int sqlType, java.lang.String typeName)
           Sets the designated parameter to SQL NULL.
 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(int parameterIndex, java.lang.Object x)
           Sets the value of the designated parameter using the given object.
 void setObject(int parameterIndex, java.lang.Object x, int targetSqlType)
           Sets the value of the designated parameter with the given object.
 void setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale)
           Sets the value of the designated parameter with the given object.
 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 setRef(int i, java.sql.Ref x)
           Sets the designated parameter to the given REF(<structured-type>) value.
 void setShort(int parameterIndex, short x)
           Sets the designated parameter to the given Java short value.
 void setShort(java.lang.String parameterName, short x)
           Sets the designated parameter to the given Java short value.
 void setString(int parameterIndex, java.lang.String x)
           Sets the designated parameter to the given Java String value.
 void setString(java.lang.String parameterName, java.lang.String x)
           Sets the designated parameter to the given Java String value.
 void setTime(int parameterIndex, java.sql.Time x)
           Sets the designated parameter to the given java.sql.Time value.
 void setTime(int parameterIndex, 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 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(int parameterIndex, java.sql.Timestamp x)
           Sets the designated parameter to the given java.sql.Timestamp value.
 void setTimestamp(int parameterIndex, 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 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 setUnicodeStream(int parameterIndex, java.io.InputStream x, int length)
          Deprecated. Sun does not include a reason, but presumably setCharacterStream is now prefered?
 void setURL(int parameterIndex, java.net.URL x)
           Sets the designated parameter to the given java.net.URL value.
 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.jdbcStatement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

Method Detail

setEscapeProcessing

public void setEscapeProcessing(boolean enable)
                         throws java.sql.SQLException
Sets escape processing on or off.

HSQLDB-Specific Information:

HSQLDB 1.7.0 follows the standard behaviour by overriding the same method in jdbcStatement class.

Calling this method will have no effect.

Specified by:
setEscapeProcessing in interface java.sql.Statement
Overrides:
setEscapeProcessing in class jdbcStatement
Parameters:
enable - true to enable escape processing; false to disable it
Throws:
java.sql.SQLException - if a database access error occurs

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException
Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.

Specified by:
executeQuery in interface java.sql.PreparedStatement
Returns:
a ResultSet object that contains the data produced by the query; never null
Throws:
java.sql.SQLException - if a database access error occurs or the SQL statement does not return a ResultSet object

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException
Executes the SQL statement in this PreparedStatement object, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.

Specified by:
executeUpdate in interface java.sql.PreparedStatement
Returns:
either (1) the row count for INSERT, UPDATE, or DELETE statements or (2) 0 for SQL statements that return nothing
Throws:
java.sql.SQLException - if a database access error occurs or the SQL statement returns a ResultSet object

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws java.sql.SQLException
Sets the designated parameter to SQL NULL.

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

Specified by:
setNull in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
sqlType - the SQL type code defined in java.sql.Types
Throws:
java.sql.SQLException - if a database access error occurs

setBoolean

public void setBoolean(int parameterIndex,
                       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.

Specified by:
setBoolean in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setByte

public void setByte(int parameterIndex,
                    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.

Specified by:
setByte in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setShort

public void setShort(int parameterIndex,
                     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.

Specified by:
setShort in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setInt

public void setInt(int parameterIndex,
                   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.

Specified by:
setInt in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setLong

public void setLong(int parameterIndex,
                    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.

Specified by:
setLong in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setFloat

public void setFloat(int parameterIndex,
                     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:

Up to 1.6.1, HSQLDB did not handle Java positive/negative Infinity or NaN float values properly. With 1.7.0, these values are converted to SQL NULL. With 1.7.1 these values are sent to the database.

Specified by:
setFloat in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setDouble

public void setDouble(int parameterIndex,
                      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:

Up to 1.6.1, HSQLDB did not handle Java positive/negative Infinity or NaN float values properly. With 1.7.0, these values are converted to SQL NULL. With 1.7.1 these values are sent to the database.

Specified by:
setDouble in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          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.

Specified by:
setBigDecimal in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setString

public void setString(int parameterIndex,
                      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.

Specified by:
setString in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setBytes

public void setBytes(int parameterIndex,
                     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.

Specified by:
setBytes in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setDate

public void setDate(int parameterIndex,
                    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.

Specified by:
setDate in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setTime

public void setTime(int parameterIndex,
                    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.

Specified by:
setTime in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setTimestamp

public void setTimestamp(int parameterIndex,
                         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.

Specified by:
setTimestamp in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - if a database access error occurs

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           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:

This uses the default platform character encoding to convert bytes into characters of the String. In future this is likely to change to always treat the stream as ASCII.

Before HSQLDB 1.7.0, setAsciiStream and setUnicodeStream were identical.

Specified by:
setAsciiStream in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             java.io.InputStream x,
                             int length)
                      throws java.sql.SQLException
Deprecated. Sun does not include a reason, but presumably setCharacterStream is now prefered?

Sets the designated parameter to the given input stream, which will have the specified number of bytes. A Unicode character has two bytes, with the first byte being the high byte, and the second being the low byte. When a very large Unicode value is input to a LONGVARCHAR 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. 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:

Beginning with HSQLDB 1.7.0, this complies with JDBC3 specification.

Specified by:
setUnicodeStream in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - a java.io.InputStream object that contains the Unicode parameter value as two-byte Unicode characters
length - the number of bytes in the stream
Throws:
java.sql.SQLException - if a database access error occurs

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            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:

Up to and including HSQLDB 1.7.0, a binary stream is converted to a SQL string consisting of hexidecimal digits that represent the stream.

Example:

    PreparedStatement ps =
    connection.prepareStatement("SELECT * FROM t WHERE col = ?");
    ps.setBinaryStream(1, myStream, 4);
    ps.execute();
 
Given that the first 4 bytes of the stream are 0xff, 0xff, 0xff, 0xff, the above code fragement would emit the following SQL:
    SELECT * FROM t WHERE col = 'ffffffff'
 
Zero-length specifications result in zero bytes being read from the stream. In such cases, the parameter is compiled to an empty SQL string. If the length specified in the above code fragment was zero, the the emitted SQL would be:
    SELECT * FROM t WHERE col = ''
 
This behaviour may change in a future release.

Specified by:
setBinaryStream in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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

clearParameters

public void clearParameters()
                     throws java.sql.SQLException
Clears the current parameter values immediately.

In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters.

Specified by:
clearParameters in interface java.sql.PreparedStatement
Throws:
java.sql.SQLException - if a database access error occurs

setObject

public void setObject(int parameterIndex,
                      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 database-specific abstract data types.

HSQLDB-Specific Information:

Up to and including HSQLDB 1.7.0, calling this method is identical to calling setObject(int, Object, int). That is, this method simply calls setObject(int, Object, int), ignoring the scale specification.

Specified by:
setObject in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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.

Up to and including HSQLDB 1.7.0, this parameter is ignored.

Throws:
java.sql.SQLException - if a database access error occurs
See Also:
Types

setObject

public void setObject(int parameterIndex,
                      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:

Up to HSQLDB 1.6.1, this method did not work properly with all combinations of object class and targetSqlType.

Starting with 1.7.0, this has been corrected.

Specified by:
setObject in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x)
               throws java.sql.SQLException
Sets the value of the designated parameter using 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:

This method will call the apropriate setXXX method when it detects that the specified Object is one that has a standard mapping to a java.sql.Types type. However, if it known that the parameter will correspond to a value for (or comparison against) a column of type OTHER, then the method setObject(i,x,Types.OTHER) should be used instead; in HSQLDB, columns of type OTHER are reserved strictly for storing serialized Java Objects. That is, when attempting to insert or update using values other than null for OTHER column values, an exception is thrown if the value is not a serializable Java Object.

Specified by:
setObject in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the object containing the input parameter value
Throws:
java.sql.SQLException - if a database access error occurs or the type of the given object is ambiguous

execute

public boolean execute()
                throws java.sql.SQLException
Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQueryand executeUpdate.

The execute method returns a boolean to indicate the form of the first result. You must call either the method getResultSet or getUpdateCount to retrieve the result; you must call getMoreResults to move to any subsequent result(s).

HSQLDB-Specific Information:

Up to and including HSQLDB 1.7.0, statements never return multiple result sets. However, be aware that this behaviour may change in a future release.

Specified by:
execute in interface java.sql.PreparedStatement
Returns:
true if the first result is a ResultSet object; false if the first result is an update count or there is no result
Throws:
java.sql.SQLException - if a database access error occurs or an argument is supplied to this method
See Also:
jdbcStatement.execute(java.lang.String), jdbcStatement.getResultSet(), jdbcStatement.getUpdateCount(), jdbcStatement.getMoreResults()

addBatch

public void addBatch()
              throws java.sql.SQLException
Adds a set of parameters to this PreparedStatement object's batch of commands.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
addBatch in interface java.sql.PreparedStatement
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:
jdbcStatement.addBatch(java.lang.String)

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               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:

HSQLDB 1.7.0 stores CHARACTER and related SQL types as Unicode so this method does not perform any conversion.

Specified by:
setCharacterStream in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
reader - the java.io.Reader object that contains the Unicode data
length - the number of characters in the stream
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)

setRef

public void setRef(int i,
                   java.sql.Ref x)
            throws java.sql.SQLException
Sets the designated parameter to the given REF(<structured-type>) value. The driver converts this to an SQL REF value when it sends it to the database.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
setRef in interface java.sql.PreparedStatement
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an SQL REF 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)

setBlob

public void setBlob(int i,
                    java.sql.Blob x)
             throws java.sql.SQLException
Sets the designated parameter to the given Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
setBlob in interface java.sql.PreparedStatement
Parameters:
i - the first parameter is 1, the second is 2, ...
x - a Blob object that maps an SQL BLOB 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)

setClob

public void setClob(int i,
                    java.sql.Clob x)
             throws java.sql.SQLException
Sets the designated parameter to the given Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
setClob in interface java.sql.PreparedStatement
Parameters:
i - the first parameter is 1, the second is 2, ...
x - a Clob object that maps an SQL CLOB 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)

setArray

public void setArray(int i,
                     java.sql.Array x)
              throws java.sql.SQLException
Sets the designated parameter to the given Array object. The driver converts this to an SQL ARRAY value when it sends it to the database.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
setArray in interface java.sql.PreparedStatement
Parameters:
i - the first parameter is 1, the second is 2, ...
x - an Array object that maps an SQL ARRAY 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)

getMetaData

public java.sql.ResultSetMetaData getMetaData()
                                       throws java.sql.SQLException
Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.

Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData on a PreparedStatement object rather than waiting to execute it and then invoking the ResultSet.getMetaData method on the ResultSet object that is returned.

NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
getMetaData in interface java.sql.PreparedStatement
Returns:
the description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object
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)

setDate

public void setDate(int parameterIndex,
                    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.

Specified by:
setDate in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

setTime

public void setTime(int parameterIndex,
                    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.

Specified by:
setTime in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

setTimestamp

public void setTimestamp(int parameterIndex,
                         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.

Specified by:
setTimestamp in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
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.2 (JDK 1.1.x developers: read the new overview for jdbcPreparedStatement)

setNull

public void setNull(int paramIndex,
                    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.

Specified by:
setNull in interface java.sql.PreparedStatement
Parameters:
paramIndex - the first parameter is 1, the second is 2, ...
sqlType - a value from java.sql.Types
typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF
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)

setURL

public void setURL(int parameterIndex,
                   java.net.URL x)
            throws java.sql.SQLException
Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
setURL in interface java.sql.PreparedStatement
Parameters:
parameterIndex - the first parameter is 1, the second is 2, ...
x - the java.net.URL object to be set
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQL 1.7.0

getParameterMetaData

public java.sql.ParameterMetaData getParameterMetaData()
                                                throws java.sql.SQLException
Retrieves the number, types and properties of this PreparedStatement object's parameters.

HSQLDB-Specific Information:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

Specified by:
getParameterMetaData in interface java.sql.PreparedStatement
Returns:
a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters
Throws:
java.sql.SQLException - if a database access error occurs
Since:
JDK 1.4, HSQL 1.7.0
See Also:
ParameterMetaData

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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

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

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(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setURL(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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:

HSQLDB 1.7.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setString(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setBoolean(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setByte(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setShort(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setInt(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setLong(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setFloat(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setDouble(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setBytes(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setDate(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setTime(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setTimestamp(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
Types, setObject(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setBigDecimal(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setObject(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setDate(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setTime(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setTimestamp(int, 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.1 does not support this feature.

Calling this method always throws a SQLException, stating that the function is not supported.

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, HSQL 1.7.0
See Also:
setURL(int, java.net.URL)


Copyright © 2001 - 2002 HSQL Development Group. All Rights Reserved.