devdaily home | apple | java | perl | unix | directory | blog

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/* Copyright (c) 2001-2004, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG, 
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


package org.hsqldb.jdbc;

import java.math.BigDecimal;
import java.sql.*;     // for Array, Blob etc.
import java.util.Calendar;
import java.util.*;    // for Map

import org.hsqldb.HsqlException;
import org.hsqldb.Trace;
import org.hsqldb.lib.IntValueHashMap;

// boucherb@users patch 1.7.2 - CallableStatement impl removed
// from jdbcPreparedStatement and moved here; sundry changes elsewhere to
// comply
// TODO: 1.7.2 Alpha N :: DONE
//       maybe implement set-by-parameter-name.  We have an informal spec,
//       being "@p1" => 1, "@p2" => 2, etc.  Problems: return value is "@p0"
//       and there is no support for registering the return value as an out
//       parameter.
// TODO: 1.7.3
//       engine and client-side mechanisms for adding, retrieving,
//       navigating (and perhaps controlling holdability of) multiple
//       results generated from a single execution.
// boucherb@users 2004-03/04-xx - patch 1.7.2 - some minor code cleanup
//                                            - parameter map NPE correction
//                                            - embedded SQL/SQLCLI client usability
//                                              (parameter naming changed from @n to @pn)
// boucherb@users 2004-04-xx - doc 1.7.2 - javadocs added/updated

/**
 * 
 *
 * 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 * {@link 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 {@link ResultSet} object or * multiple ResultSet objects. Multiple * ResultSet objects are handled using operations * inherited from {@link Statement}. *

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

* * *

*

HSQLDB-Specific Information:

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

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

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

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


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

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

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

* *

 * GRANT ALL ON CLASS "package.class" TO [<user-name> | PUBLIC]
 * CREATE ALIAS <call-alias> FOR "package.class.method" -- optional
 * 
* * This has the effect of allowing the specified user(s) to access the * set of uniquely named public static methods of the specified class, * in either the role of SQL functions or stored procedures. * For example:

* *

 * CONNECT <admin-user> PASSWORD <admin-user-password>;
 * GRANT ALL ON CLASS "org.myorg.MyClass" TO PUBLIC;
 * CREATE ALIAS sp_my_method FOR "org.myorg.MyClass.myMethod"
 * CONNECT <any-user> PASSWORD <any-user-password>;
 * SELECT "org.myorg.MyClass.myMethod"(column_1) FROM table_1;
 * SELECT sp_my_method(column_1) FROM table_1;
 * CALL 2 + "org.myorg.MyClass.myMethod"(-5);
 * CALL 2 + sp_my_method(-5);
 * 
* * Please note the use of the term "uniquely named" above. Including * 1.7.2, no support is provided to deterministically resolve overloaded * method names, and there can be issues with inherited methods as well; * currently, it is strongly recommended that developers creating stored * procedure library classes for HSQLDB simply avoid designs such that SQL * stored procedure calls attempt to resolve to:

* *

    *
  1. inherited public static methods *
  2. overloaded public static methods *
* * Also, please note that OUT and IN OUT parameters * are not yet supported due to some unresolved low level support issues.

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

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

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

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

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

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

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

 * package mypackage;
 *
 * class MyClass {
 *
 *      public static Object mySp(Connection conn) throws SQLException {
 *          return conn.createStatement().executeQuery("select * from my_table");
 *      }
 * }
 * 
* * Here is a refinement demonstrating no more than the bare essence of the idea * behind a more portable style: * *
 * package mypackage;
 *
 * import java.sql.ResultSet;
 * import java.sql.SQLException;
 *
 * class MyLibraryClass {
 *
 *      public static ResultSet mySp() throws SQLException {
 *          return ctx.getConnection().createStatement().executeQuery("select * from my_table");
 *      }
 * }
 *
 * //--
 *
 * package myadaptorpackage;
 *
 * import java.sql.Connection;
 * import java.sql.SQLException;
 *
 * class MyAdaptorClass {
 *
 *      public static Object mySp(Connection conn) throws SQLException {
 *          MyLibraryClass.getCtx().setConnection(conn);
 *          return MyLibraryClass.mySp();
 *      }
 * }
 * 
* * In a future release, it is intended to provided some new features * that will support writing fairly portable JDBC-based stored procedure * code:

* *

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

    * *

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

    * *

  • A well-defined, pure JDBC specification for generating multiple * results from HSQLDB stored procedures for client retrieval. *
* * (boucherb@users) *
* * * @author boucherb@users * @version 1.7.2 * @since 1.7.2 * @see jdbcConnection#prepareCall * @see jdbcResultSet */ public class jdbcCallableStatement extends jdbcPreparedStatement implements CallableStatement { /** parameter name => parameter index */ private IntValueHashMap parameterNameMap; /** parameter index => registered OUT type */ // private IntKeyIntValueHashMap outRegistrationMap; /** * Constructs a new jdbcCallableStatement with the specified connection and * result type. * * @param c the connection on which this statement will execute * @param sql the SQL statement this object represents * @param type the type of result this statement will produce * @throws HsqlException if the statement is not accepted by the database * @throws SQLException if preprocessing by driver fails */ public jdbcCallableStatement(jdbcConnection c, String sql, int type) throws HsqlException, SQLException { super(c, sql, type); String[] names; String name; // outRegistrationMap = new IntKeyIntValueHashMap(); parameterNameMap = new IntValueHashMap(); if (pmdDescriptor != null && pmdDescriptor.metaData != null) { names = pmdDescriptor.metaData.sName; for (int i = 0; i < names.length; i++) { name = names[i]; // PRE: should never happen in practice if (name == null || name.length() == 0) { continue; // throw? } parameterNameMap.put(name, i); } } } /** * Retrieves the parameter index corresponding to the given * parameter name.

* * @param parameterName to look up * @throws SQLException if not found * @return index for name */ int findParameterIndex(String parameterName) throws SQLException { checkClosed(); int index = parameterNameMap.get(parameterName, -1); if (index >= 0) { return index; } throw jdbcUtil.sqlException(Trace.COLUMN_NOT_FOUND, parameterName); } /** * Does the specialized work required to free this object's resources and * that of it's parent classes.

* * @throws SQLException if a database access error occurs */ public void close() throws SQLException { if (isClosed()) { return; } // outRegistrationMap = null; parameterNameMap = null; super.close(); } /** * Performs an internal check for OUT or IN OUT column index validity.

* * @param i the one-based column index to check * @throws SQLException if there is no such OUT or IN OUT column */ private void checkGetParameterIndex(int i) throws SQLException { checkClosed(); if (i < 1 || i > parameterModes.length) { String msg = "Parameter index out of bounds: " + i; throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg); } /* int mode = parameterModes[i - 1]; switch (mode) { default : String msg = "Not OUT or IN OUT mode: " + mode + " for parameter: " + i; throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg); case Expression.PARAM_IN_OUT : case Expression.PARAM_OUT : break; // this is OK } */ } /** * Checks if the parameter of the given index has been successfully * registered as an OUT parameter.

* * @param parameterIndex to check * @throws SQLException if not registered */ /* private void checkIsRegisteredParameterIndex(int parameterIndex) throws SQLException { int type; String msg; checkClosed(); type = outRegistrationMap.get(parameterIndex, Integer.MIN_VALUE); if (type == Integer.MIN_VALUE) { msg = "Parameter not registered: " + parameterIndex; throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT, msg); } } */ // ----------------------------------- JDBC 1 ---------------------------------- /** * * 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 * {@link #getObject} retrieves the value.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param 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. * @exception SQLException if a database access error occurs * @see java.sql.Types */ public void registerOutParameter(int parameterIndex, int sqlType) throws SQLException { throw jdbcUtil.notSupported; } /** * * Registers the parameter in ordinal position * parameterIndex to be of JDBC type * sqlType. This method must be called * before a stored procedure is executed. *

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

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param sqlType the SQL type code defined by java.sql.Types. * @param scale the desired number of digits to the right of the * decimal point. It must be greater than or equal to zero. * @exception SQLException if a database access error occurs * @see java.sql.Types */ public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException { registerOutParameter(parameterIndex, sqlType); } /** * * Retrieves whether the last OUT parameter read had the value of * SQL NULL. Note that this method should be called only * after calling a getter method; otherwise, there is no value to use in * determining whether it is null or not.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @return true if the last parameter read was SQL * NULL; false otherwise * @exception SQLException if a database access error occurs */ public boolean wasNull() throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC CHAR, * VARCHAR, or LONGVARCHAR parameter as a * String in the Java programming language. *

* For the fixed-length type JDBC CHAR, * the String object * returned has exactly the same value the JDBC * CHAR value had in the * database, including any padding added by the database.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result * is null. * @exception SQLException if a database access error occurs * @see #setString */ public String getString(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC BIT parameter * as a boolean in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is false. * @exception SQLException if a database access error occurs * @see #setBoolean */ public boolean getBoolean(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC TINYINT * parameter as a byte in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setByte */ public byte getByte(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC SMALLINT * parameter as a short in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setShort */ public short getShort(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC INTEGER * parameter as an int in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setInt */ public int getInt(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC BIGINT * parameter as a long in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setLong */ public long getLong(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC FLOAT * parameter as a float in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the * result is 0. * @exception SQLException if a database access error occurs * @see #setFloat */ public float getFloat(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC DOUBLE * parameter as a double in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setDouble */ public double getDouble(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC NUMERIC * parameter as a java.math.BigDecimal object with * scale digits to the right of the decimal point.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param scale the number of digits to the right of the decimal point * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @deprecated use getBigDecimal(int parameterIndex) * or getBigDecimal(String parameterName) * @see #setBigDecimal */ public BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC BINARY or * VARBINARY parameter as an array of byte * values in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setBytes */ public byte[] getBytes(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC DATE parameter * as a java.sql.Date object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the * result is null. * @exception SQLException if a database access error occurs * @see #setDate */ public java.sql.Date getDate(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC TIME parameter * as a java.sql.Time object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTime */ public java.sql.Time getTime(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC TIMESTAMP * parameter as a java.sql.Timestamp object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTimestamp */ public java.sql.Timestamp getTimestamp(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated parameter as an Object * in the Java programming language. If the value is an SQL NULL, * the driver returns a Java null. *

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return A java.lang.Object holding the OUT parameter value * @exception SQLException if a database access error occurs * @see java.sql.Types * @see #setObject */ public Object getObject(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } // ----------------------------------- JDBC 2 ---------------------------------- /** * * Retrieves the value of the designated JDBC NUMERIC * parameter as a java.math.BigDecimal object with as many * digits to the right of the decimal point as the value contains.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value in full precision. If the value is * SQL NULL, the result is null. * @exception SQLException if a database access error occurs * @see #setBigDecimal * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public BigDecimal getBigDecimal(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } /** * * Returns an object representing the value of OUT parameter * i and uses map for the custom * mapping of the parameter value. *

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param i the first parameter is 1, the second is 2, and so on * @param map the mapping from SQL type names to Java classes * @return a java.lang.Object holding the OUT parameter value * @exception SQLException if a database access error occurs * @see #setObject * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public Object getObject(int i, Map map) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC * REF(<structured-type>) parameter as a * {@link java.sql.Ref} object in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param i the first parameter is 1, the second is 2, * and so on * @return the parameter value as a Ref object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public Ref getRef(int i) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC BLOB * parameter as a {@link java.sql.Blob} object in the Java * programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param i the first parameter is 1, the second is 2, * and so on * @return the parameter value as a Blob object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public Blob getBlob(int i) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC CLOB * parameter as a Clob object in the Java programming l * anguage.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param i the first parameter is 1, the second is 2, and * so on * @return the parameter value as a Clob object in the * Java programming language. If the value was SQL NULL, the * value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public Clob getClob(int i) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC ARRAY * parameter as an {@link Array} object in the Java programming * language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param i the first parameter is 1, the second is 2, and * so on * @return the parameter value as an Array object in * the Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public Array getArray(int i) throws SQLException { throw jdbcUtil.notSupported; } /** * * Retrieves the value of the designated JDBC DATE * parameter as a java.sql.Date object, using * the given Calendar object * to construct the date. * With a Calendar object, the driver * can calculate the date taking into account a custom timezone and * locale. If no Calendar object is specified, the driver * uses the default timezone and locale.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param cal the Calendar object the driver will use * to construct the date * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setDate * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public java.sql.Date getDate(int parameterIndex, Calendar cal) throws SQLException { throw jdbcUtil.notSupported; // try { // return HsqlDateTime.getDate(getString(parameterIndex), cal); // } catch (Exception e) { // throw jdbcUtil.sqlException(Trace.INVALID_ESCAPE, // e.getMessage()); // } } /** * * Retrieves the value of the designated JDBC TIME * parameter as a java.sql.Time object, using * the given Calendar object * to construct the time. * With a Calendar object, the driver * can calculate the time taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param cal the Calendar object the driver will use * to construct the time * @return the parameter value; if the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTime * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public java.sql.Time getTime(int parameterIndex, Calendar cal) throws SQLException { throw jdbcUtil.notSupported; // try { // return HsqlDateTime.getTime(getString(parameterIndex), cal); // } catch (Exception e) { // throw jdbcUtil.sqlException(Trace.INVALID_ESCAPE, // e.getMessage()); // } } /** * * Retrieves the value of the designated JDBC TIMESTAMP * parameter as a java.sql.Timestamp object, using * the given Calendar object to construct * the Timestamp object. * With a Calendar object, the driver * can calculate the timestamp taking into account a custom timezone and * locale. If no Calendar object is specified, the driver * uses the default timezone and locale.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param cal the Calendar object the driver will use * to construct the timestamp * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) */ public java.sql.Timestamp getTimestamp(int parameterIndex, Calendar cal) throws SQLException { throw jdbcUtil.notSupported; // try { // return HsqlDateTime.getTimestamp(getString(parameterIndex), cal); // } catch (Exception e) { // throw jdbcUtil.sqlException(Trace.INVALID_ESCAPE, // e.getMessage()); // } } /** * * Registers the designated output parameter. This version of * the method registerOutParameter * should be used for a user-defined or REF output parameter. * Examples of user-defined types include: STRUCT, * DISTINCT, JAVA_OBJECT, and named array types. * * Before executing a stored procedure call, you must explicitly * call registerOutParameter to register the type from * java.sql.Types for each * OUT parameter. For a user-defined parameter, the fully-qualified SQL * type name of the parameter should also be given, while a * REF parameter requires that the fully-qualified type name * of the referenced type be given. A JDBC driver that does not need the * type code and type name information may ignore it. To be portable, * however, applications should always provide these values for * user-defined and REF parameters. * * Although it is intended for user-defined and REF parameters, * this method may be used to register a parameter of any JDBC type. * If the parameter does not have a user-defined or REF type, * the typeName parameter is ignored. * *

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param paramIndex the first parameter is 1, the second is 2,... * @param sqlType a value from {@link java.sql.Types} * @param typeName the fully-qualified name of an SQL structured type * @exception SQLException if a database access error occurs * @see java.sql.Types * @since JDK 1.2 (JDK 1.1.x developers: read the new overview for * jdbcPreparedStatement) * */ public void registerOutParameter(int paramIndex, int sqlType, String typeName) throws SQLException { registerOutParameter(paramIndex, sqlType); } // ----------------------------------- JDBC 3 ---------------------------------- /** * * 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 * {@link #getObject} retrieves the value.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param 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. * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQL 1.7.0 * @see java.sql.Types */ //#ifdef JDBC3 public void registerOutParameter(String parameterName, int sqlType) throws SQLException { registerOutParameter(findParameterIndex(parameterName), sqlType); } //#endif JDBC3 /** * * Registers the parameter named * parameterName to be of JDBC type * sqlType. This method must be called * before a stored procedure is executed. *

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

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param sqlType SQL type code defined by java.sql.Types. * @param scale the desired number of digits to the right of the * decimal point. It must be greater than or equal to zero. * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 * @see java.sql.Types */ //#ifdef JDBC3 public void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException { registerOutParameter(findParameterIndex(parameterName), sqlType); } //#endif JDBC3 /** * * Registers the designated output parameter. This version of * the method registerOutParameter * should be used for a user-named or REF output parameter. Examples * of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and * named array types. * * Before executing a stored procedure call, you must explicitly * call registerOutParameter to register the type from * java.sql.Types for each * OUT parameter. For a user-named parameter the fully-qualified SQL * type name of the parameter should also be given, while a REF * parameter requires that the fully-qualified type name of the * referenced type be given. A JDBC driver that does not need the * type code and type name information may ignore it. To be portable, * however, applications should always provide these values for * user-named and REF parameters. * * Although it is intended for user-named and REF parameters, * this method may be used to register a parameter of any JDBC type. * If the parameter does not have a user-named or REF type, the * typeName parameter is ignored. * *

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param sqlType a value from {@link java.sql.Types} * @param typeName the fully-qualified name of an SQL structured type * @exception SQLException if a database access error occurs * @see java.sql.Types * @since JDK 1.4, HSQL 1.7.0 */ //#ifdef JDBC3 public void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException { registerOutParameter(findParameterIndex(parameterName), sqlType); } //#endif JDBC3 /** * * Retrieves the value of the designated JDBC DATALINK * parameter as a java.net.URL object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterIndex the first parameter is 1, the second is 2,... * @return a java.net.URL object that represents the * JDBC DATALINK value used as the designated * parameter * @exception SQLException if a database access error occurs, * or if the URL being returned is * not a valid URL on the Java platform * @see #setURL * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.net.URL getURL(int parameterIndex) throws SQLException { throw jdbcUtil.notSupported; } //#endif JDBC3 /** * * Sets the designated parameter to the given java.net.URL * object. The driver converts this to an SQL DATALINK * value when it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param val the parameter value * @exception SQLException if a database access error occurs, * or if a URL is malformed * @see #getURL * @since JDK 1.4, HSQL 1.7.0 */ //#ifdef JDBC3 public void setURL(String parameterName, java.net.URL val) throws SQLException { setURL(findParameterIndex(parameterName), val); } //#endif JDBC3 /** * * Sets the designated parameter to SQL NULL. * *

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

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param sqlType the SQL type code defined in java.sql.Types * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setNull(String parameterName, int sqlType) throws SQLException { setNull(findParameterIndex(parameterName), sqlType); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java boolean * value. The driver converts this to an SQL BIT value when * it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBoolean * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setBoolean(String parameterName, boolean x) throws SQLException { setBoolean(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java byte value. * The driver converts this to an SQL TINYINT value when it * sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getByte * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setByte(String parameterName, byte x) throws SQLException { setByte(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java short value. * The driver converts this to an SQL SMALLINT value when * it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getShort * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setShort(String parameterName, short x) throws SQLException { setShort(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java int value. * The driver converts this to an SQL INTEGER value when it * sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getInt * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setInt(String parameterName, int x) throws SQLException { setInt(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java long value. * The driver converts this to an SQL BIGINT value when it * sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getLong * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setLong(String parameterName, long x) throws SQLException { setLong(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java float value. * The driver converts this to an SQL FLOAT value when it * sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getFloat * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setFloat(String parameterName, float x) throws SQLException { setFloat(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java double value. * The driver converts this to an SQL DOUBLE value when it * sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getDouble * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setDouble(String parameterName, double x) throws SQLException { setDouble(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given * java.math.BigDecimal value. * The driver converts this to an SQL NUMERIC value when * it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBigDecimal * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setBigDecimal(String parameterName, BigDecimal x) throws SQLException { setBigDecimal(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java String * value. The driver converts this to an SQL VARCHAR * or LONGVARCHAR value (depending on the argument's * size relative to the driver's limits on VARCHAR values) * when it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getString * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setString(String parameterName, String x) throws SQLException { setString(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Java array of bytes. * The driver converts this to an SQL VARBINARY or * LONGVARBINARY (depending on the argument's size relative * to the driver's limits on VARBINARY values) when it sends * it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBytes * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setBytes(String parameterName, byte[] x) throws SQLException { setBytes(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given java.sql.Date * value. The driver converts this to an SQL DATE value * when it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getDate * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setDate(String parameterName, java.sql.Date x) throws SQLException { setDate(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given java.sql.Time * value. The driver converts this to an SQL TIME value * when it sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getTime * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setTime(String parameterName, java.sql.Time x) throws SQLException { setTime(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given * java.sql.Timestamp value. The driver * converts this to an SQL TIMESTAMP value when it * sends it to the database.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getTimestamp * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setTimestamp(String parameterName, java.sql.Timestamp x) throws SQLException { setTimestamp(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given input stream, which will * have the specified number of bytes. * When a very large ASCII value is input to a LONGVARCHAR * parameter, it may be more practical to send it via a * java.io.InputStream. Data will be read from the stream * as needed until end-of-file is reached. The JDBC driver will * do any necessary conversion from ASCII to the database char format. * *

Note: This stream object can either be a standard * Java stream object or your own subclass that implements the * standard interface.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the Java input stream that contains the ASCII parameter value * @param length the number of bytes in the stream * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setAsciiStream(String parameterName, java.io.InputStream x, int length) throws SQLException { setAsciiStream(findParameterIndex(parameterName), x, length); } //#endif JDBC3 /** * * Sets the designated parameter to the given input stream, which will * have the specified number of bytes. * When a very large binary value is input to a LONGVARBINARY * parameter, it may be more practical to send it via a * java.io.InputStream object. The data will be read from * the stream as needed until end-of-file is reached. * *

Note: This stream object can either be a standard * Java stream object or your own subclass that implements the * standard interface.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the java input stream which contains the binary parameter value * @param length the number of bytes in the stream * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setBinaryStream(String parameterName, java.io.InputStream x, int length) throws SQLException { setBinaryStream(findParameterIndex(parameterName), x, length); } //#endif JDBC3 /** * * Sets the value of the designated parameter with the given object. * The second argument must be an object type; for integral values, the * java.lang equivalent objects should be used. * *

The given Java object will be converted to the given targetSqlType * before being sent to the database. * * If the object has a custom mapping (is of a class implementing the * interface SQLData), * the JDBC driver should call the method SQLData.writeSQL * to write it to the SQL data stream. * If, on the other hand, the object is of a class implementing * Ref, Blob, Clob, * Struct, or Array, the driver should pass it * to the database as a value of the corresponding SQL type. *

* Note that this method may be used to pass datatabase- * specific abstract data types.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @param targetSqlType the SQL type (as defined in java.sql.Types) to be * sent to the database. The scale argument may further qualify this type. * @param 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. * @exception SQLException if a database access error occurs * @see java.sql.Types * @see #getObject * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException { setObject(findParameterIndex(parameterName), x, targetSqlType, scale); } //#endif JDBC3 /** * * Sets the value of the designated parameter with the given object. * This method is like the method setObject * above, except that it assumes a scale of zero.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @param targetSqlType the SQL type (as defined in java.sql.Types) to be * sent to the database * @exception SQLException if a database access error occurs * @see #getObject * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setObject(String parameterName, Object x, int targetSqlType) throws SQLException { setObject(findParameterIndex(parameterName), x, targetSqlType); } //#endif JDBC3 /** * * Sets the value of the designated parameter with the given object. * The second parameter must be of type Object; therefore, * the java.lang equivalent objects should be used for * built-in types. * *

The JDBC specification specifies a standard mapping from * Java Object types to SQL types. The given argument * will be converted to the corresponding SQL type before being * sent to the database. * *

Note that this method may be used to pass datatabase- * specific abstract data types, by using a driver-specific Java * type. * * If the object is of a class implementing the interface * SQLData, the JDBC driver should call the method * SQLData.writeSQL to write it to the SQL data stream. * If, on the other hand, the object is of a class implementing * Ref, Blob, Clob, * Struct, or Array, the driver should pass it * to the database as a value of the corresponding SQL type. *

* This method throws an exception if there is an ambiguity, for example, * if the object is of a class implementing more than one of the * interfaces named above.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @exception SQLException if a database access error occurs or if the given * Object parameter is ambiguous * @see #getObject * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setObject(String parameterName, Object x) throws SQLException { setObject(findParameterIndex(parameterName), x); } //#endif JDBC3 /** * * Sets the designated parameter to the given Reader * object, which is the given number of characters long. * When a very large UNICODE value is input to a LONGVARCHAR * parameter, it may be more practical to send it via a * java.io.Reader object. The data will be read from the * stream as needed until end-of-file is reached. The JDBC driver will * do any necessary conversion from UNICODE to the database char format. * *

Note: This stream object can either be a standard * Java stream object or your own subclass that implements the * standard interface.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param reader the java.io.Reader object that * contains the UNICODE data used as the designated parameter * @param length the number of characters in the stream * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setCharacterStream(String parameterName, java.io.Reader reader, int length) throws SQLException { setCharacterStream(findParameterIndex(parameterName), reader, length); } //#endif JDBC3 /** * * Sets the designated parameter to the given java.sql.Date * value, using the given Calendar object. The driver uses * the Calendar object to construct an SQL DATE * value, which the driver then sends to the database. With a * a Calendar object, the driver can calculate the date * taking into account a custom timezone. If no * Calendar object is specified, the driver uses the default * timezone, which is that of the virtual machine running the * application.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @param cal the Calendar object the driver will use * to construct the date * @exception SQLException if a database access error occurs * @see #getDate * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setDate(String parameterName, java.sql.Date x, Calendar cal) throws SQLException { setDate(findParameterIndex(parameterName), x, cal); } //#endif JDBC3 /** * * Sets the designated parameter to the given java.sql.Time * value, using the given Calendar object. The driver uses * the Calendar object to construct an SQL TIME * value, which the driver then sends to the database. With a * a Calendar object, the driver can calculate the time * taking into account a custom timezone. If no * Calendar object is specified, the driver uses the default * timezone, which is that of the virtual machine running the * application.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @param cal the Calendar object the driver will use * to construct the time * @exception SQLException if a database access error occurs * @see #getTime * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setTime(String parameterName, java.sql.Time x, Calendar cal) throws SQLException { setTime(findParameterIndex(parameterName), x, cal); } //#endif JDBC3 /** * * Sets the designated parameter to the given * java.sql.Timestamp value, using the given * Calendar object. The driver uses the * Calendar object to construct an SQL * TIMESTAMP value, which the driver then sends to the * database. With a Calendar object, the driver can * calculate the timestamp taking into account a custom timezone. If no * Calendar object is specified, the driver uses the default * timezone, which is that of the virtual machine running the * application.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param x the parameter value * @param cal the Calendar object the driver will use * to construct the timestamp * @exception SQLException if a database access error occurs * @see #getTimestamp * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setTimestamp(String parameterName, java.sql.Timestamp x, Calendar cal) throws SQLException { setTimestamp(findParameterIndex(parameterName), x, cal); } //#endif JDBC3 /** * * Sets the designated parameter to SQL NULL. * This version of the method setNull should * be used for user-defined types and REF type parameters. * Examples of user-defined types include: STRUCT, * DISTINCT, JAVA_OBJECT, and * named array types. * *

Note: To be portable, applications must give the * SQL type code and the fully-qualified SQL type name when specifying * a NULL user-defined or REF parameter. * In the case of a user-defined type the name is the type name of the * parameter itself. For a REF parameter, the name is the * type name of the referenced type. If a JDBC driver does not need * the type code or type name information, it may ignore it. * * Although it is intended for user-defined and Ref * parameters, this method may be used to set a null parameter of * any JDBC type. If the parameter does not have a user-defined or * REF type, the given typeName is ignored.

* * * *

*

HSQLDB-Specific Information:

* * Starting with 1.7.2, HSLQDB supports this. *

* * * @param parameterName the name of the parameter * @param sqlType a value from java.sql.Types * @param 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 * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public void setNull(String parameterName, int sqlType, String typeName) throws SQLException { setNull(findParameterIndex(parameterName), sqlType, typeName); } //#endif JDBC3 /** * * Retrieves the value of a JDBC CHAR, VARCHAR, * or LONGVARCHAR parameter as a String in * the Java programming language. *

* For the fixed-length type JDBC CHAR, * the String object * returned has exactly the same value the JDBC * CHAR value had in the * database, including any padding added by the database.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setString * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public String getString(String parameterName) throws SQLException { return getString(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC BIT parameter as a * boolean in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is false. * @exception SQLException if a database access error occurs * @see #setBoolean * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public boolean getBoolean(String parameterName) throws SQLException { return getBoolean(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC TINYINT parameter as a * byte in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setByte * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public byte getByte(String parameterName) throws SQLException { return getByte(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC SMALLINT parameter as * a short in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setShort * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public short getShort(String parameterName) throws SQLException { return getShort(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC INTEGER parameter as * an int in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setInt * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public int getInt(String parameterName) throws SQLException { return getInt(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC BIGINT parameter as * a long in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setLong * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public long getLong(String parameterName) throws SQLException { return getLong(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC FLOAT parameter as * a float in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setFloat * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public float getFloat(String parameterName) throws SQLException { return getFloat(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC DOUBLE parameter as * a double in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setDouble * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public double getDouble(String parameterName) throws SQLException { return getDouble(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC BINARY or * VARBINARY parameter as an array of byte * values in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setBytes * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public byte[] getBytes(String parameterName) throws SQLException { return getBytes(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC DATE parameter as a * java.sql.Date object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setDate * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.sql.Date getDate(String parameterName) throws SQLException { return getDate(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC TIME parameter as a * java.sql.Time object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTime * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.sql.Time getTime(String parameterName) throws SQLException { return getTime(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC TIMESTAMP parameter as a * java.sql.Timestamp object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.sql.Timestamp getTimestamp(String parameterName) throws SQLException { return getTimestamp(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a parameter as an Object in the Java * programming language. If the value is an SQL NULL, the * driver returns a Java null. *

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return A java.lang.Object holding the OUT parameter value. * @exception SQLException if a database access error occurs * @see java.sql.Types * @see #setObject * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public Object getObject(String parameterName) throws SQLException { return getObject(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC NUMERIC parameter as a * java.math.BigDecimal object with as many digits to the * right of the decimal point as the value contains.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value in full precision. If the value is * SQL NULL, the result is null. * @exception SQLException if a database access error occurs * @see #setBigDecimal * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public BigDecimal getBigDecimal(String parameterName) throws SQLException { return getBigDecimal(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Returns an object representing the value of OUT parameter * i and uses map for the custom * mapping of the parameter value. *

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

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param map the mapping from SQL type names to Java classes * @return a java.lang.Object holding the OUT parameter value * @exception SQLException if a database access error occurs * @see #setObject * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public Object getObject(String parameterName, Map map) throws SQLException { return getObject(findParameterIndex(parameterName), map); } //#endif JDBC3 /** * * Retrieves the value of a JDBC REF(<structured-type>) * parameter as a {@link Ref} object in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value as a Ref object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public Ref getRef(String parameterName) throws SQLException { return getRef(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC BLOB parameter as a * {@link Blob} object in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value as a Blob object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public Blob getBlob(String parameterName) throws SQLException { return getBlob(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC CLOB parameter as a * Clob object in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value as a Clob object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public Clob getClob(String parameterName) throws SQLException { return getClob(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC ARRAY parameter as an * {@link Array} object in the Java programming language.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return the parameter value as an Array object in * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public Array getArray(String parameterName) throws SQLException { return getArray(findParameterIndex(parameterName)); } //#endif JDBC3 /** * * Retrieves the value of a JDBC DATE parameter as a * java.sql.Date object, using * the given Calendar object * to construct the date. * With a Calendar object, the driver * can calculate the date taking into account a custom timezone and * locale. If no Calendar object is specified, the d * river uses the default timezone and locale.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param cal the Calendar object the driver will use * to construct the date * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setDate * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.sql.Date getDate(String parameterName, Calendar cal) throws SQLException { return getDate(findParameterIndex(parameterName), cal); } //#endif JDBC3 /** * * Retrieves the value of a JDBC TIME parameter as a * java.sql.Time object, using * the given Calendar object * to construct the time. * With a Calendar object, the driver * can calculate the time taking into account a custom timezone and * locale. If no Calendar object is specified, the driver * uses the default timezone and locale.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @param cal the Calendar object the driver will use * to construct the time * @return the parameter value; if the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTime * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.sql.Time getTime(String parameterName, Calendar cal) throws SQLException { return getTime(findParameterIndex(parameterName), cal); } //#endif JDBC3 /** * * Retrieves the value of a JDBC TIMESTAMP parameter as a * java.sql.Timestamp object, using * the given Calendar object to construct * the Timestamp object. * With a Calendar object, the driver * can calculate the timestamp taking into account a custom timezone * and locale. If no Calendar object is specified, the * driver uses the default timezone and locale.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * * @param parameterName the name of the parameter * @param cal the Calendar object the driver will use * to construct the timestamp * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.sql.Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException { return getTimestamp(findParameterIndex(parameterName), cal); } //#endif JDBC3 /** * * Retrieves the value of a JDBC DATALINK parameter as a * java.net.URL object.

* * * *

*

HSQLDB-Specific Information:

* * HSQLDB 1.7.2 does not support this feature.

* * Calling this method always throws an SQLException. *

* * * @param parameterName the name of the parameter * @return 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. * @exception SQLException if a database access error occurs, * or if there is a problem with the URL * @see #setURL * @since JDK 1.4, HSQLDB 1.7.0 */ //#ifdef JDBC3 public java.net.URL getURL(String parameterName) throws SQLException { return getURL(findParameterIndex(parameterName)); } //#endif JDBC3 }




Copyright 1998-2008 Alvin Alexander
All Rights Reserved.
 
devdaily.com is based in louisville, kentucky, and this web site is hosted by godaddy.com