org.hsqldb.jdbc.JDBCPreparedStatement Maven / Gradle / Ivy
Show all versions of hsqldb Show documentation
/* Copyright (c) 2001-2019, 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.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.Serializable;
import java.io.StringWriter;
import java.math.BigDecimal;
import java.sql.Array;
import java.sql.BatchUpdateException;
import java.sql.Blob;
import java.sql.Clob;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.Date;
import java.sql.NClob;
import java.sql.ParameterMetaData;
import java.sql.PreparedStatement;
import java.sql.Ref;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.RowId;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.sql.SQLTimeoutException;
import java.sql.SQLWarning;
import java.sql.SQLXML;
import java.sql.Time;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.BitSet;
import java.util.Calendar;
import java.util.UUID;
import org.hsqldb.HsqlDateTime;
import org.hsqldb.HsqlException;
import org.hsqldb.SchemaObject;
import org.hsqldb.SessionInterface;
import org.hsqldb.StatementTypes;
import org.hsqldb.error.Error;
import org.hsqldb.error.ErrorCode;
import org.hsqldb.lib.ArrayUtil;
import org.hsqldb.lib.CharArrayWriter;
import org.hsqldb.lib.CountdownInputStream;
import org.hsqldb.lib.HsqlByteArrayOutputStream;
import org.hsqldb.lib.StringConverter;
import org.hsqldb.navigator.RowSetNavigator;
import org.hsqldb.result.Result;
import org.hsqldb.result.ResultConstants;
import org.hsqldb.result.ResultLob;
import org.hsqldb.result.ResultMetaData;
import org.hsqldb.result.ResultProperties;
import org.hsqldb.types.BinaryData;
import org.hsqldb.types.BinaryUUIDType;
import org.hsqldb.types.BlobDataID;
import org.hsqldb.types.BlobInputStream;
import org.hsqldb.types.ClobDataID;
import org.hsqldb.types.ClobInputStream;
import org.hsqldb.types.DateTimeType;
import org.hsqldb.types.JavaObjectData;
import org.hsqldb.types.JavaObjectDataInternal;
import org.hsqldb.types.TimeData;
import org.hsqldb.types.TimestampData;
import org.hsqldb.types.Type;
import org.hsqldb.types.Types;
//#ifdef JAVA8
import java.sql.JDBCType;
import java.sql.SQLType;
//#endif JAVA8
/* $Id: JDBCPreparedStatement.java 5989 2019-05-19 10:49:39Z fredt $ */
// changes by fredt
// SimpleDateFormat objects moved out of methods to improve performance
// this is safe because only one thread at a time should access a
// PreparedStatement object until it has finished executing the statement
//
// fredt@users 20020215 - patch 517028 by peterhudson@users - method defined
// minor changes by fredt
// fredt@users 20020320 - patch 1.7.0 - JDBC 2 support and error trapping;
// JDBC 2 methods can now be called from jdk 1.1.x
// - see javadoc comments
// fredt@users 20020414 - patch 517028 by peterhudson@users - setDate method defined
// - setTime method defined
// - setTimestamp method defined
// changes by fredt - moved conversion to HsqlDateTime
// fredt@users 20020429 - patch 1.7.0 - setCharacterStream method defined
//
// boucherb & 20020409 - extensive review and update of docs and behaviour
// fredt@users - 20020505 to comply with previous and latest java.sql specification
//
// campbell-burnet@users 20020509 - added "throws SQLException" to all methods where it
// was missing here but specified in the java.sql.PreparedStatement and
// java.sqlCallableStatement interfaces, updated generic documentation to
// JDK 1.4, and added JDBC3 methods and docs
// fredt@users 20020627 - patch 574234 for setCharacterStream by ohioedge@users
// fredt@users 20030620 - patch 1.7.2 - rewritten to support real prepared statements
// campbell-burnet@users 20030801 - patch 1.7.2 - support for batch execution
// campbell-burnet@users 20030801 - patch 1.7.2 - support for getMetaData and getParameterMetadata
// campbell-burnet@users 20030801 - patch 1.7.2 - updated some setXXX methods, incl. setCharacterStream
// campbell-burnet@users 20030801 - patch 1.7.2 - setBlob method implemented
// campbell-burnet@users 200403/4 - doc 1.7.2 - javadoc updates toward 1.7.2 final
// campbell-burnet@users 200403/4 - patch 1.7.2 - eliminate eager buffer allocation from setXXXStream/Blob/Clob
// campbell-burnet@users 20051207 - patch 1.8.0.x initial JDBC 4.0 support work
// fredt@users 20060215 - patch 1.8.0 - check for unset parameters
// fredt@users 20061008 - patch 1.9.0 - partial rewrite with enhancements - separated from jdbcStatement
// campbell-burnet@users 20060424 - patch 1.8.x - Mustang Build 81 JDBC 4.0 support
// campbell-burnet@users 20060424 - doc 1.9.0 - Full synch up to Mustang Build 84
// Revision 1.19 2006/07/12 12:24:17 boucherb
// patch 1.9.0
// - full synch up to Mustang b90
/**
*
*
* 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)
*
*
*
*
*
*
* HSQLDB-Specific Information:
*
* From version 2.0, the implementation meets the JDBC specification
* requirement that any existing ResultSet is closed when execute() or
* executeQuery() methods are called. The connection property close_result=true
* is required for this behaviour.
*
* JDBCPreparedStatement objects are backed by
* a true compiled parametric representation. Hence, there are now significant
* performance gains to be had by using a JDBCPreparedStatement object in
* preference to a JDBCStatement object when a short-running SQL statement is
* to be executed more than once.
*
* When it can be otherwise avoided, it should be considered poor practice to
* fully prepare (construct), parameterize, execute, fetch and close a
* JDBCParameterMetaData object for each execution cycle. Indeed,
* because the prepare and execute phases
* both represent a round-trip to the engine, this practice is likely to be
* noticeably less performant for short-running statements (and
* possibly even orders of magnitude less performant over network connections
* for short-running statements) than the equivalent process using JDBCStatement
* objects, albeit far more convenient, less error prone and certainly much
* less resource-intensive, especially when large binary and character values
* are involved, due to the optimized parameterization facility.
*
* Instead, when developing an application that is not totally oriented toward
* the execution of ad hoc SQL, it is recommended to expend some effort toward
* identifying the SQL statements that are good candidates for regular reuse and
* adapting the structure of the application accordingly. Often, this is done
* by recording the text of candidate SQL statements in an application resource
* object (which has the nice side-benefit of isolating and hiding differences
* in SQL dialects across different drivers) and caching for possible reuse the
* PreparedStatement objects derived from the recorded text.
*
* Starting with 2.0, when built under a JDBC 4 environment, statement caching
* can be transparently enabled or disabled on a statement-by-statement basis by
* invoking setPoolable(true | false), respectively, upon Statement objects of
* interest.
*
* Multi thread use:
*
* A PreparedStatement object is stateful and should not normally be shared
* by multiple threads. If it has to be shared, the calls to set the
* parameters, calls to add batch statements, the execute call and any
* post-execute calls should be made within a block synchronized on the
* PreparedStatement Object.
*
* (fredt@users)
* (campbell-burnet@users)
*
*
*
*
* @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
* @author Fred Toussi (fredt@users dot sourceforge.net)
* @version 2.5.0
* @since 1.9.0
* @see JDBCConnection#prepareStatement
* @see JDBCResultSet
*/
public class JDBCPreparedStatement extends JDBCStatementBase implements PreparedStatement {
/**
*
* Executes the SQL query in this PreparedStatement object
* and returns the ResultSet object generated by the query.
*
*
* @return a ResultSet object that contains the data produced by the
* query; never null
* @exception SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement or the SQL
* statement does not return a ResultSet object
*/
public synchronized ResultSet executeQuery() throws SQLException {
if (statementRetType != StatementTypes.RETURN_RESULT) {
checkStatementType(StatementTypes.RETURN_RESULT);
}
fetchResult();
return getResultSet();
}
/**
*
* Executes the SQL statement in this PreparedStatement object,
* (JDBC4 clarification:)
* which must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or
* DELETE; or an SQL statement that returns nothing,
* such as a DDL statement.
*
*
* @return (JDBC4 clarification:) either (1) the row count for SQL Data Manipulation Language (DML) statements
* or (2) 0 for SQL statements that return nothing
* @exception SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement
* or the SQL
* statement returns a ResultSet object
*/
public synchronized int executeUpdate() throws SQLException {
if (statementRetType != StatementTypes.RETURN_COUNT) {
checkStatementType(StatementTypes.RETURN_COUNT);
}
fetchResult();
return resultIn.getUpdateCount();
}
/**
*
* Sets the designated parameter to SQL NULL.
*
* Note: You must specify the parameter's SQL type.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB currently ignores the sqlType argument.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param sqlType the SQL type code defined in java.sql.Types
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @exception SQLFeatureNotSupportedException if sqlType is
* a ARRAY, BLOB, CLOB,
* DATALINK, JAVA_OBJECT, NCHAR,
* NCLOB, NVARCHAR, LONGNVARCHAR,
* REF, ROWID, SQLXML
* or STRUCT data type and the JDBC driver does not support
* this data type
*/
public synchronized void setNull(int parameterIndex,
int sqlType) throws SQLException {
setParameter(parameterIndex, null);
}
/**
*
* Sets the designated parameter to the given Java boolean value.
* The driver converts this
* (JDBC4 Modified:)
* to an SQL BIT or BOOLEAN value when it sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB supports BOOLEAN type for boolean values. This method can also
* be used to set the value of a parameter of the SQL type BIT(1), which is
* a bit string consisting of a 0 or 1.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setBoolean(int parameterIndex,
boolean x) throws SQLException {
Boolean b = x ? Boolean.TRUE
: Boolean.FALSE;
setParameter(parameterIndex, b);
}
/**
*
* 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.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setByte(int parameterIndex,
byte x) throws SQLException {
setIntParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given Java short value.
* The driver converts this
* to an SQL SMALLINT value when it sends it to the database.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setShort(int parameterIndex,
short x) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
checkSetParameterIndex(parameterIndex);
if (parameterTypes[parameterIndex - 1].typeCode
== Types.SQL_SMALLINT) {
parameterValues[--parameterIndex] = Integer.valueOf(x);
parameterSet[parameterIndex] = Boolean.TRUE;
return;
}
setIntParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given Java int value.
* The driver converts this
* to an SQL INTEGER value when it sends it to the database.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setInt(int parameterIndex,
int x) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
checkSetParameterIndex(parameterIndex);
if (parameterTypes[parameterIndex - 1].typeCode == Types.SQL_INTEGER) {
parameterValues[--parameterIndex] = Integer.valueOf(x);
parameterSet[parameterIndex] = Boolean.TRUE;
return;
}
setIntParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given Java long value.
* The driver converts this
* to an SQL BIGINT value when it sends it to the database.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setLong(int parameterIndex,
long x) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
checkSetParameterIndex(parameterIndex);
if (parameterTypes[parameterIndex - 1].typeCode == Types.SQL_BIGINT) {
parameterValues[--parameterIndex] = Long.valueOf(x);
parameterSet[parameterIndex] = Boolean.TRUE;
return;
}
setLongParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given Java float value.
* The driver converts this
* (JDBC4 correction:)
* to an SQL REAL value when it sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* Since 1.7.1, HSQLDB handles Java positive/negative Infinity
* and NaN float values consistent with the Java Language
* Specification; these special values are now correctly stored
* to and retrieved from the database.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setFloat(int parameterIndex,
float x) throws SQLException {
setDouble(parameterIndex, (double) x);
}
/**
*
* Sets the designated parameter to the given Java double value.
* The driver converts this
* to an SQL DOUBLE value when it sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* Since 1.7.1, HSQLDB handles Java positive/negative Infinity
* and NaN double values consistent with the Java Language
* Specification; these special values are now correctly stored
* to and retrieved from the database.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setDouble(int parameterIndex,
double x) throws SQLException {
Double d = Double.valueOf(x);
setParameter(parameterIndex, d);
}
/**
*
* 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.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setBigDecimal(int parameterIndex,
BigDecimal x) throws SQLException {
setParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given Java String value.
* The driver converts this
* to an SQL VARCHAR or LONGVARCHAR value
* (depending on the argument's
* size relative to the driver's limits on VARCHAR values)
* when it sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* Including 2.0, HSQLDB represents all XXXCHAR values internally as
* java.lang.String objects; there is no appreciable difference between
* CHAR, VARCHAR and LONGVARCHAR.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setString(int parameterIndex,
String x) throws SQLException {
setParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given Java array of bytes. The driver converts
* this to an SQL VARBINARY or LONGVARBINARY
* (depending on the argument's size relative to the driver's limits on
* VARBINARY values) when it sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* Including 2.0, HSQLDB represents all XXXBINARY values the same way
* internally; there is no appreciable difference between BINARY,
* VARBINARY and LONGVARBINARY as far as JDBC is concerned.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setBytes(int parameterIndex,
byte[] x) throws SQLException {
setParameter(parameterIndex, x);
}
/**
*
* (JDBC4 clarification:)
* Sets the designated parameter to the given java.sql.Date value
* using the default time zone of the virtual machine that is running
* the application.
* The driver converts this
* to an SQL DATE value when it sends it to the database.
*
*
* HSQLDB-Specific Information:
*
* When a setXXX method is used to set a parameter of type
* TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the
* client application is used as time zone
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setDate(int parameterIndex,
Date x) throws SQLException {
setParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given java.sql.Time value.
* The driver converts this
* to an SQL TIME value when it sends it to the database.
*
*
* HSQLDB-Specific Information:
*
* When a setXXX method is used to set a parameter of type
* TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the
* client application is used as time zone
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setTime(int parameterIndex,
Time x) throws SQLException {
setParameter(parameterIndex, x);
}
/**
*
* Sets the designated parameter to the given java.sql.Timestamp value.
* The driver
* converts this to an SQL TIMESTAMP value when it sends it to the
* database.
*
*
* HSQLDB-Specific Information:
*
* When a setXXX method is used to set a parameter of type
* TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the
* client application is used as time zone.
*
* When this method is used to set a parameter of type TIME or
* TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object
* will be used if the TIME parameter accepts fractional seconds.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void setTimestamp(int parameterIndex,
Timestamp x) throws SQLException {
setParameter(parameterIndex, x);
}
/* @todo 1.9.0 - implement streaming */
/**
*
* 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:
*
* From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes
* from the stream into the characters of a String.
* This method does not use streaming to send the data,
* whether the target is a CLOB or other binary object.
*
* For long streams (larger than a few megabytes) with CLOB targets,
* it is more efficient to use a version of setCharacterStream which takes
* the a length parameter.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
*/
public synchronized void setAsciiStream(int parameterIndex,
java.io.InputStream x, int length) throws SQLException {
setAsciiStream(parameterIndex, x, (long) length);
}
/**
*
* Sets the designated parameter to the given input stream, which
* will have the specified number of bytes.
* (JDBC4 deleted:)
* [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.
*
* (JDBC4 added:)
* The byte format of the Unicode stream must be a Java UTF-8, as defined in the
* Java Virtual Machine Specification.
*
*
Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
*
*
*
* HSQLDB-Specific Information:
*
* From 1.7.0 to 1.8.0.x, this method complies with behavior as defined by
* the JDBC3 specification (the stream is treated as though it has UTF16
* encoding).
*
* Starting with 2.0, this method behaves according to the JDBC4
* specification (the stream is treated as though it has UTF-8
* encoding, as defined in the Java Virtual Machine Specification) when
* built under JDK 1.6+; otherwise, it behaves as defined by the JDBC3
* specification. Regardless, this method is deprecated: please use
* setCharacterStream(...) instead.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x a java.io.InputStream object that contains the
* Unicode parameter value
* (JDBC4 deleted:)
* [as two-byte Unicode characters]
* @param length the number of bytes in the stream
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @deprecated
* Sun does not include a reason, but presumably
* this is because setCharacterStream is now preferred
*/
//#ifdef DEPRECATEDJDBC
@Deprecated
public synchronized void setUnicodeStream(int parameterIndex,
java.io.InputStream x, int length) throws SQLException {
checkSetParameterIndex(parameterIndex);
String msg = null;
final int ver = JDBCDatabaseMetaData.JDBC_MAJOR;
if (x == null) {
throw JDBCUtil.nullArgument("x");
}
// CHECKME: Is JDBC4 clarification of UNICODE stream format retroactive?
if ((ver < 4) && (length % 2 != 0)) {
msg = "Odd length argument for UTF16 encoded stream: " + length;
throw JDBCUtil.invalidArgument(msg);
}
String encoding = (ver < 4) ? "UTF16"
: "UTF8";
StringWriter writer = new StringWriter();
try {
CountdownInputStream cis = new CountdownInputStream(x);
InputStreamReader reader = new InputStreamReader(cis, encoding);
char[] buff = new char[1024];
int charsRead;
cis.setCount(length);
while (-1 != (charsRead = reader.read(buff))) {
writer.write(buff, 0, charsRead);
}
} catch (IOException ex) {
throw JDBCUtil.sqlException(ErrorCode.SERVER_TRANSFER_CORRUPTED,
ex.toString(), ex);
}
setParameter(parameterIndex, writer.toString());
}
//#endif DEPRECATEDJDBC
/** @todo 1.9.0 - implement streaming */
/**
*
* 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:
*
* Since 1.7.2, this method works according to the standard.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
*/
public synchronized void setBinaryStream(int parameterIndex,
java.io.InputStream x, int length) throws SQLException {
setBinaryStream(parameterIndex, x, (long) length);
}
/**
*
* 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.
*
*
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
*/
public synchronized void clearParameters() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
ArrayUtil.fillArray(parameterValues, null);
ArrayUtil.fillArray(parameterSet, null);
ArrayUtil.clearArray(ArrayUtil.CLASS_CODE_LONG, streamLengths, 0,
streamLengths.length);
}
//----------------------------------------------------------------------
// Advanced features:
/**
*
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.
*
* If the second argument is an InputStream then the stream must contain
* the number of bytes specified by scaleOrLength. If the second argument is a
* Reader then the reader must contain the number of characters specified
* by scaleOrLength. If these conditions are not true the driver will generate a
* SQLException when the prepared statement is executed.
*
*
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, NClob,
* Struct, java.net.URL,
* 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.
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 scaleOrLength for java.sql.Types.DECIMAL
* or java.sql.Types.NUMERIC types,
* this is the number of digits after the decimal point. For
* Java Object types InputStream and Reader,
* this is the length
* of the data in the stream or reader. For all other types,
* this value will be ignored.
* @exception SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement or
* if the Java Object specified by x is an InputStream
* or Reader object and the value of the scale parameter is less
* than zero
* @exception SQLFeatureNotSupportedException if targetSqlType is
* a ARRAY, BLOB, CLOB,
* DATALINK, JAVA_OBJECT, NCHAR,
* NCLOB, NVARCHAR, LONGNVARCHAR,
* REF, ROWID, SQLXML
* or STRUCT data type and the JDBC driver does not support
* this data type
* @see java.sql.Types
*/
public synchronized void setObject(int parameterIndex, Object x,
int targetSqlType,
int scaleOrLength) throws SQLException {
if (x instanceof InputStream) {
setBinaryStream(parameterIndex, (InputStream) x, scaleOrLength);
} else if (x instanceof Reader) {
setCharacterStream(parameterIndex, (Reader) x, scaleOrLength);
} else {
setObject(parameterIndex, x);
}
}
/**
*
* 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:
*
* Since 1.7.2, this method supports conversions listed in the
* conversion table B-5 of the JDBC 3 specification.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
* @exception SQLFeatureNotSupportedException if targetSqlType is
* a ARRAY, BLOB, CLOB,
* DATALINK, JAVA_OBJECT, NCHAR,
* NCLOB, NVARCHAR, LONGNVARCHAR,
* REF, ROWID, SQLXML
* or STRUCT data type and the JDBC driver does not support
* this data type
* @see #setObject(int,Object)
*/
public synchronized void setObject(int parameterIndex, Object x,
int targetSqlType) throws SQLException {
setObject(parameterIndex, x);
}
/**
*
* 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 database-
* 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, (JDBC4 new:) [ NClob ],
* Struct, java.net.URL, (JDBC4 new:) [ RowId, SQLXML ]
* or Array, the driver should pass it to the database as a
* value of the corresponding SQL type.
*
* Note: Not all databases allow for a non-typed Null to be sent to
* the backend. For maximum portability, the setNull or the
* setObject(int parameterIndex, Object x, int sqlType)
* method should be used
* instead of setObject(int parameterIndex, Object x).
*
* Note: 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:
*
* Since 1.7.2, this method supports conversions listed in the conversion
* table B-5 of the JDBC 3 specification.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the object containing the input parameter value
* @exception SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement
* or the type of the given object is ambiguous
*/
public synchronized void setObject(int parameterIndex,
Object x) throws SQLException {
setParameter(parameterIndex, x);
}
/**
*
* 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 executeQuery
* and 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:
*
* If the statement is a call to a PROCEDURE, it may return multiple
* multiple fetchable results.
*
*
*
* @return true if the first result is a ResultSet
* object; false if the first result is an update
* count or there is no result
* @exception SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement
* or an argument is supplied to this method
* @see JDBCStatement#execute
* @see JDBCStatement#getResultSet
* @see JDBCStatement#getUpdateCount
* @see JDBCStatement#getMoreResults
*
*/
public synchronized boolean execute() throws SQLException {
fetchResult();
return statementRetType == StatementTypes.RETURN_RESULT;
}
//--------------------------JDBC 2.0-----------------------------
/**
*
* Adds a set of parameters to this PreparedStatement
* object's batch of commands.
*
*
*
*
* HSQLDB-Specific Information:
*
* Since 1.7.2, this feature is supported.
*
*
*
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @see JDBCStatement#addBatch
* @since JDK 1.2
*/
public synchronized void addBatch() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
checkParametersSet();
if (!isBatch) {
resultOut.setBatchedPreparedExecuteRequest();
isBatch = true;
}
try {
performPreExecute();
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
int len = parameterValues.length;
Object[] batchParamValues = new Object[len];
System.arraycopy(parameterValues, 0, batchParamValues, 0, len);
resultOut.addBatchedPreparedExecuteRequest(batchParamValues);
}
/* @todo 1.9.0 - implement streaming */
/**
*
* 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:
*
* From HSQLDB 2.0 this method uses streaming to send data
* when the target is a CLOB.
* HSQLDB represents CHARACTER and related SQL types as UTF16 Unicode
* internally, so this method does not perform any conversion.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param reader the java.io.Reader object that contains the
* Unicode data
* @param length the number of characters in the stream
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @since JDK 1.2
*/
public synchronized void setCharacterStream(int parameterIndex,
java.io.Reader reader, int length) throws SQLException {
setCharacterStream(parameterIndex, reader, (long) length);
}
/**
*
* 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:
*
* Including 2.0 HSQLDB does not support the SQL REF type. Calling this method
* throws an exception.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x an SQL REF value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.2
*/
public void setRef(int parameterIndex, Ref x) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
*
* Sets the designated parameter to the given java.sql.Blob object.
* The driver converts this to an SQL BLOB value when it
* sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* For parameters of type Blob, setBlob works normally.
*
* In addition since 1.7.2, setBlob is supported for BINARY and VARBINARY
* parameters. In this context, the Blob object is
* hard-limited to those of length less than or equal to Integer.MAX_VALUE.
* In practice, soft limits such as available heap and maximum disk usage
* per file (such as the transaction log) dictate a much smaller maximum
* length.
*
* For BINARY and VARBINARY parameter types setBlob(i,x) is roughly
* equivalent (null and length handling not shown) to:
*
*
* setBinaryStream(i, x.getBinaryStream(), (int) x.length());
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x a Blob object that maps an SQL BLOB value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.2
*/
public synchronized void setBlob(int parameterIndex,
Blob x) throws SQLException {
checkSetParameterIndex(parameterIndex);
Type outType = parameterTypes[parameterIndex - 1];
switch (outType.typeCode) {
case Types.SQL_BINARY :
case Types.SQL_VARBINARY :
setBlobForBinaryParameter(parameterIndex, x);
return;
case Types.SQL_BLOB :
setBlobParameter(parameterIndex, x);
break;
default :
throw JDBCUtil.invalidArgument();
}
}
/**
* Converts a blob to binary data for non-blob binary parameters.
*/
private void setBlobForBinaryParameter(int parameterIndex,
Blob x) throws SQLException {
if (x instanceof JDBCBlob) {
setParameter(parameterIndex, ((JDBCBlob) x).data());
return;
} else if (x == null) {
setParameter(parameterIndex, null);
return;
}
final long length = x.length();
if (length > Integer.MAX_VALUE) {
String msg = "Maximum Blob input octet length exceeded: " + length; // NOI18N
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR, msg);
}
try {
java.io.InputStream in = x.getBinaryStream();
HsqlByteArrayOutputStream out = new HsqlByteArrayOutputStream(in,
(int) length);
setParameter(parameterIndex, out.toByteArray());
out.close();
} catch (Throwable e) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR,
e.toString(), e);
}
}
/**
*
* Sets the designated parameter to the given java.sql.Clob object.
* The driver converts this to an SQL CLOB value when it
* sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* For parameters of type Clob, setClob works normally.
*
* In addition since 1.7.2, setClob is supported for CHARACTER and VARCHAR
* parameters. In this context, the Clob object is
* hard-limited to those of length less than or equal to Integer.MAX_VALUE.
* In practice, soft limits such as available heap and maximum disk usage
* per file (such as the transaction log) dictate a much smaller maximum
* length.
*
* For CHARACTER and VARCHAR parameter types setClob(i,x) is roughly
* equivalent (null and length handling not shown) to:
*
*
* setCharacterStream(i, x.getCharacterStream(), (int) x.length());
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x a Clob object that maps an SQL CLOB value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.2
*/
public synchronized void setClob(int parameterIndex,
Clob x) throws SQLException {
checkSetParameterIndex(parameterIndex);
Type outType = parameterTypes[parameterIndex - 1];
switch (outType.typeCode) {
case Types.SQL_CHAR :
case Types.SQL_VARCHAR :
setClobForStringParameter(parameterIndex, x);
return;
case Types.SQL_CLOB :
setClobParameter(parameterIndex, x);
return;
default :
throw JDBCUtil.invalidArgument();
}
}
private void setClobForStringParameter(int parameterIndex,
Clob x) throws SQLException {
if (x instanceof JDBCClob) {
setParameter(parameterIndex, ((JDBCClob) x).getData());
return;
} else if (x == null) {
setParameter(parameterIndex, null);
return;
}
final long length = x.length();
if (length > Integer.MAX_VALUE) {
String msg = "Max Clob input character length exceeded: " + length; // NOI18N
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR, msg);
}
try {
java.io.Reader reader = x.getCharacterStream();
CharArrayWriter writer = new CharArrayWriter(reader, (int) length);
setParameter(parameterIndex, writer.toString());
} catch (Throwable e) {
throw JDBCUtil.sqlException(ErrorCode.SERVER_TRANSFER_CORRUPTED,
e.toString(), e);
}
}
/**
*
* Sets the designated parameter to the given java.sql.Array object.
* The driver converts this to an SQL ARRAY value when it
* sends it to the database.
*
*
*
*
* HSQLDB-Specific Information:
*
* From version 2.0, HSQLDB supports the SQL ARRAY type.
*
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x an Array object that maps an SQL ARRAY value
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.2
*/
public synchronized void setArray(int parameterIndex,
Array x) throws SQLException {
checkParameterIndex(parameterIndex);
Type type = this.parameterMetaData.columnTypes[parameterIndex - 1];
if (!type.isArrayType()) {
throw JDBCUtil.sqlException(ErrorCode.X_42561);
}
if (x == null) {
setParameter(parameterIndex, null);
return;
}
Object[] data = null;
if (x instanceof JDBCArray) {
Type baseType = type.collectionBaseType();
Object[] array = ((JDBCArray) x).getArrayInternal();
data = new Object[array.length];
for (int i = 0; i < data.length; i++) {
data[i] = baseType.convertJavaToSQL(session, array[i]);
}
} else {
Object object = x.getArray();
if (object instanceof Object[]) {
Type baseType = type.collectionBaseType();
Object[] array = (Object[]) object;
data = new Object[array.length];
for (int i = 0; i < data.length; i++) {
data[i] = baseType.convertJavaToSQL(session, array[i]);
}
} else {
// if foreign data is not Object[]
throw JDBCUtil.notSupported();
}
}
parameterValues[parameterIndex - 1] = data;
parameterSet[parameterIndex - 1] = Boolean.TRUE;
}
/**
*
* 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 pre-compiled, 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:
*
* Since 1.7.2, this feature is supported and is inexpensive as
* it is backed by underlying DBMS support. If the statement
* generates an update count, then null is returned.
*
*
* @return the description of a ResultSet object's columns or
* null if the driver cannot return a
* ResultSetMetaData object
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since JDK 1.2
*/
public synchronized ResultSetMetaData getMetaData() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (statementRetType != StatementTypes.RETURN_RESULT) {
return null;
}
if (resultSetMetaData == null) {
boolean isUpdatable = ResultProperties.isUpdatable(rsProperties);
boolean isInsertable = isUpdatable;
if (isInsertable) {
for (int i = 0; i < resultMetaData.colIndexes.length; i++) {
if (resultMetaData.colIndexes[i] < 0) {
isInsertable = false;
break;
}
}
}
resultSetMetaData = new JDBCResultSetMetaData(resultMetaData,
isUpdatable, isInsertable, connection);
}
return resultSetMetaData;
}
/**
*
* 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 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.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
* @since JDK 1.2
*/
public synchronized void setDate(int parameterIndex, Date x,
Calendar cal) throws SQLException {
checkSetParameterIndex(parameterIndex);
int i = parameterIndex - 1;
if (x == null) {
parameterValues[i] = null;
parameterSet[i] = Boolean.TRUE;
return;
}
Type outType = parameterTypes[i];
Calendar calendar = cal == null ? session.getCalendar()
: cal;
long millis = HsqlDateTime.convertMillisFromCalendar(
session.getCalendarGMT(), calendar, x.getTime());
millis = HsqlDateTime.getNormalisedDate(session.getCalendarGMT(),
millis);
switch (outType.typeCode) {
case Types.SQL_DATE :
case Types.SQL_TIMESTAMP :
parameterValues[i] = new TimestampData(millis / 1000);
break;
case Types.SQL_TIMESTAMP_WITH_TIME_ZONE :
int zoneOffset = HsqlDateTime.getZoneMillis(calendar, millis);
parameterValues[i] = new TimestampData(millis / 1000, 0,
zoneOffset / 1000);
break;
default :
throw JDBCUtil.sqlException(ErrorCode.X_42561);
}
parameterSet[i] = Boolean.TRUE;
}
/**
*
* 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 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:
*
* When a setXXX method is used to set a parameter of type
* TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including
* Daylight Saving Time) of the Calendar is used as time zone for the
* value.
*
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
* @since JDK 1.2
*/
public synchronized void setTime(int parameterIndex, Time x,
Calendar cal) throws SQLException {
checkSetParameterIndex(parameterIndex);
int i = parameterIndex - 1;
if (x == null) {
parameterValues[i] = null;
parameterSet[i] = Boolean.TRUE;
return;
}
Type outType = parameterTypes[i];
long millis = x.getTime();
int zoneOffset = 0;
Calendar calendar = cal == null ? session.getCalendar()
: cal;
millis = HsqlDateTime.convertMillisFromCalendar(
session.getCalendarGMT(), calendar, millis);
millis = HsqlDateTime.convertToNormalisedTime(session.getCalendarGMT(),
millis);
switch (outType.typeCode) {
case Types.SQL_TIME :
break;
case Types.SQL_TIME_WITH_TIME_ZONE :
zoneOffset = HsqlDateTime.getZoneMillis(calendar, millis);
break;
default :
throw JDBCUtil.sqlException(ErrorCode.X_42561);
}
parameterValues[i] = new TimeData((int) (millis / 1000), 0,
zoneOffset / 1000);
parameterSet[i] = Boolean.TRUE;
}
/**
*
* 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:
*
* When a setXXX method is used to set a parameter of type
* TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including
* Daylight Saving Time) of the Calendar is used as time zone.
* In this case, if the Calendar argument is null, then the default Calendar
* for the clients JVM is used as the Calendar
*
* When this method is used to set a parameter of type TIME or
* TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object
* is used if the TIME parameter accepts fractional seconds.
*
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
* @since JDK 1.2
*/
public synchronized void setTimestamp(int parameterIndex, Timestamp x,
Calendar cal) throws SQLException {
checkSetParameterIndex(parameterIndex);
int i = parameterIndex - 1;
if (x == null) {
parameterValues[i] = null;
parameterSet[i] = Boolean.TRUE;
return;
}
Type outType = parameterTypes[i];
long millis = x.getTime();
long seconds;
int zoneOffset = 0;
Calendar calendar = cal == null ? session.getCalendar()
: cal;
millis = HsqlDateTime.convertMillisFromCalendar(
session.getCalendarGMT(),calendar, millis);
switch (outType.typeCode) {
case Types.SQL_TIMESTAMP_WITH_TIME_ZONE :
zoneOffset = HsqlDateTime.getZoneMillis(calendar, millis);
// fall through
case Types.SQL_TIMESTAMP :
seconds = millis / 1000;
if (seconds < DateTimeType.epochSeconds
|| seconds > DateTimeType.epochLimitSeconds) {
throw JDBCUtil.sqlException(ErrorCode.X_22008);
}
parameterValues[i] = new TimestampData(seconds,
x.getNanos(), zoneOffset / 1000);
break;
case Types.SQL_TIME :
millis = HsqlDateTime.getNormalisedTime(
session.getCalendarGMT(), millis);
parameterValues[i] = new TimeData((int) (millis / 1000),
x.getNanos(), 0);
break;
case Types.SQL_TIME_WITH_TIME_ZONE :
millis = HsqlDateTime.getNormalisedTime(
session.getCalendarGMT(), millis);
zoneOffset = HsqlDateTime.getZoneMillis(calendar, millis);
parameterValues[i] = new TimeData((int) (millis / 1000),
x.getNanos(), zoneOffset / 1000);
break;
case Types.SQL_DATE :
millis = HsqlDateTime.getNormalisedDate(
session.getCalendarGMT(), millis);
seconds = millis / 1000;
if (seconds < DateTimeType.epochSeconds
|| seconds > DateTimeType.epochLimitSeconds) {
throw JDBCUtil.sqlException(ErrorCode.X_22008);
}
parameterValues[i] = new TimestampData(seconds);
break;
default :
throw JDBCUtil.sqlException(ErrorCode.X_42561);
}
parameterSet[i] = Boolean.TRUE;
}
/**
*
* 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 simply ignores the sqlType and typeName arguments.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 REF
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @exception SQLFeatureNotSupportedException if sqlType is
* a ARRAY, BLOB, CLOB,
* DATALINK, JAVA_OBJECT, NCHAR,
* NCLOB, NVARCHAR, LONGNVARCHAR,
* REF, ROWID, SQLXML
* or STRUCT data type and the JDBC driver does not support
* this data type or if the JDBC driver does not support this method
* @since JDK 1.2
*/
public synchronized void setNull(int parameterIndex, int sqlType,
String typeName) throws SQLException {
setParameter(parameterIndex, null);
}
//------------------------- JDBC 2.0 - overridden methods -------------------
/**
*
* Submits a batch of commands to the database for execution and
* if all commands execute successfully, returns an array of update counts.
* The int elements of the array that is returned are ordered
* to correspond to the commands in the batch, which are ordered
* according to the order in which they were added to the batch.
* The elements in the array returned by the method executeBatch
* may be one of the following:
*
* - A number greater than or equal to zero -- indicates that the
* command was processed successfully and is an update count giving the
* number of rows in the database that were affected by the command's
* execution
*
- A value of
SUCCESS_NO_INFO -- indicates that the command was
* processed successfully but that the number of rows affected is
* unknown
*
* If one of the commands in a batch update fails to execute properly,
* this method throws a BatchUpdateException, and a JDBC
* driver may or may not continue to process the remaining commands in
* the batch. However, the driver's behavior must be consistent with a
* particular DBMS, either always continuing to process commands or never
* continuing to process commands. If the driver continues processing
* after a failure, the array returned by the method
* BatchUpdateException.getUpdateCounts
* will contain as many elements as there are commands in the batch, and
* at least one of the elements will be the following:
*
- A value of
EXECUTE_FAILED -- indicates that the command failed
* to execute successfully and occurs only if a driver continues to
* process commands after a command fails
*
*
* A driver is not required to implement this method.
* The possible implementations and return values have been modified in
* the Java 2 SDK, Standard Edition, version 1.3 to
* accommodate the option of continuing to process commands in a batch
* update after a BatchUpdateException object has been thrown.
*
*
*
*
* HSQLDB-Specific Information:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
* HSQLDB stops execution of commands in a batch when one of the commands
* results in an exception. The size of the returned array equals the
* number of commands that were executed successfully.
*
*
*
*
* @return an array of update counts containing one element for each
* command in the batch. The elements of the array are ordered according
* to the order in which commands were added to the batch.
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the
* driver does not support batch statements. Throws {@link BatchUpdateException}
* (a subclass of SQLException) if one of the commands sent to the
* database fails to execute properly or attempts to return a result set.
*
*
* @see #addBatch
* @see java.sql.DatabaseMetaData#supportsBatchUpdates()
* @since JDK 1.3
*/
public synchronized int[] executeBatch() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
checkStatementType(StatementTypes.RETURN_COUNT);
if (!isBatch) {
if (connection.isEmptyBatchAllowed) {
return new int[]{};
}
throw JDBCUtil.sqlExceptionSQL(ErrorCode.X_07506);
}
generatedResult = null;
int batchCount = resultOut.getNavigator().getSize();
resultIn = null;
try {
resultIn = session.execute(resultOut);
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
} finally {
performPostExecute();
resultOut.getNavigator().clear();
isBatch = false;
}
if (resultIn.mode == ResultConstants.ERROR) {
throw JDBCUtil.sqlException(resultIn);
}
RowSetNavigator navigator = resultIn.getNavigator();
int[] updateCounts = new int[navigator.getSize()];
for (int i = 0; navigator.next(); i++) {
Object[] data = navigator.getCurrent();
updateCounts[i] = ((Integer) data[0]).intValue();
}
if (updateCounts.length != batchCount) {
if (errorResult == null) {
throw new BatchUpdateException(updateCounts);
} else {
throw new BatchUpdateException(errorResult.getMainString(),
errorResult.getSubString(),
errorResult.getErrorCode(), updateCounts);
}
}
return updateCounts;
}
/**
*
* Sets escape processing on or off.
*
*
*
*
* HSQLDB-Specific Information:
*
* As per JDBC spec, calling this method has no effect.
*
*
*
* @param enable true to enable escape processing;
* false to disable it
* @exception SQLException if a database access error occurs
*/
public void setEscapeProcessing(boolean enable) throws SQLException {
checkClosed();
}
/**
* This method should always throw if called for a PreparedStatement or
* CallableStatement.
*
* @param sql ignored
* @throws SQLException always
*/
public void addBatch(String sql) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
* This method should always throw if called for a PreparedStatement or
* CallableStatement.
*
* @param sql ignored
* @throws SQLException always
* @return nothing
*/
public synchronized ResultSet executeQuery(
String sql) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
* This method should always throw if called for a PreparedStatement or
* CallableStatement.
*
* @param sql ignored
* @throws SQLException always
* @return nothing
*/
public boolean execute(String sql) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
* This method should always throw if called for a PreparedStatement or
* CallableStatement.
*
* @param sql ignored
* @throws SQLException always
* @return nothing
*/
public int executeUpdate(String sql) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
* Does the specialized work required to free this object's resources and
* that of it's parent class.
*
* @throws SQLException if a database access error occurs
*/
public synchronized void close() throws SQLException {
if (isClosed()) {
return;
}
closeResultData();
HsqlException he = null;
try {
// fredt - if this is called by Connection.close() then there's no
// need to free the prepared statements on the server - it is done
// by Connection.close()
if (!connection.isClosed) {
session.execute(Result.newFreeStmtRequest(statementID));
}
} catch (HsqlException e) {
he = e;
}
parameterValues = null;
parameterSet = null;
parameterTypes = null;
parameterModes = null;
resultMetaData = null;
parameterMetaData = null;
resultSetMetaData = null;
pmd = null;
connection = null;
session = null;
resultIn = null;
resultOut = null;
isClosed = true;
if (he != null) {
throw JDBCUtil.sqlException(he);
}
}
/**
* Retrieves a String representation of this object.
*
* The representation is of the form:
*
* class-name@hash[sql=[char-sequence], parameters=[p1, ...pi, ...pn]]
*
* p1, ...pi, ...pn are the String representations of the currently set
* parameter values that will be used with the non-batch execution
* methods.
*
* @return a String representation of this object
*/
public String toString() {
StringBuilder sb = new StringBuilder();
String sql;
Object[] pv;
sb.append(super.toString());
sql = this.sql;
pv = parameterValues;
if (sql == null || pv == null) {
sb.append("[closed]");
return sb.toString();
}
sb.append("[sql=[").append(sql).append("]");
if (pv.length > 0) {
sb.append(", parameters=[");
for (int i = 0; i < pv.length; i++) {
sb.append('[');
sb.append(pv[i]);
sb.append("], ");
}
sb.setLength(sb.length() - 2);
sb.append(']');
}
sb.append(']');
return sb.toString();
}
//------------------------- JDBC 3.0 -----------------------------------
/**
*
* 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:
*
* Including 2.0, HSQLDB does not support the DATALINK SQL type for which this
* method is intended. Calling this method throws an exception.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the java.net.URL object to be set
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.4, HSQL 1.7.0
*/
public void setURL(int parameterIndex,
java.net.URL x) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
*
* Retrieves the number, types and properties of this
* PreparedStatement object's parameters.
*
*
*
*
* HSQLDB-Specific Information:
*
* Since 1.7.2, this feature is supported.
*
*
*
* @return a ParameterMetaData object that contains information
* about the number, types and properties for each
* parameter marker of this PreparedStatement object
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @see java.sql.ParameterMetaData
* @since JDK 1.4, HSQL 1.7.0
*/
public synchronized ParameterMetaData getParameterMetaData() throws SQLException {
checkClosed();
if (pmd == null) {
pmd = new JDBCParameterMetaData(connection, parameterMetaData);
}
return pmd;
}
/**
* Statement methods that must be overridden in this class and throw
* an exception.
*/
public int executeUpdate(String sql,
int autoGeneratedKeys) throws SQLException {
throw JDBCUtil.notSupported();
}
public boolean execute(String sql,
int autoGeneratedKeys) throws SQLException {
throw JDBCUtil.notSupported();
}
public int executeUpdate(String sql,
int[] columnIndexes) throws SQLException {
throw JDBCUtil.notSupported();
}
public boolean execute(String sql,
int[] columnIndexes) throws SQLException {
throw JDBCUtil.notSupported();
}
public int executeUpdate(String sql,
String[] columnNames) throws SQLException {
throw JDBCUtil.notSupported();
}
public boolean execute(String sql,
String[] columnNames) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
*
* Moves to this Statement object's next result, deals with
* any current ResultSet object(s) according to the instructions
* specified by the given flag, and returns
* true if the next result is a ResultSet object.
*
* There are no more results when the following is true:
*
{@code
* // stmt is a Statement object
* ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
* }
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB supports this feature.
*
* This is used with CallableStatement objects that return multiple
* ResultSet objects.
*
*
*
* @param current one of the following Statement
* constants indicating what should happen to current
* ResultSet objects obtained using the method
* getResultSet:
* Statement.CLOSE_CURRENT_RESULT,
* Statement.KEEP_CURRENT_RESULT, or
* Statement.CLOSE_ALL_RESULTS
* @return true if the next result is a ResultSet
* object; false if it is an update count or there are no
* more results
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the argument
* supplied is not one of the following:
* Statement.CLOSE_CURRENT_RESULT,
* Statement.KEEP_CURRENT_RESULT, or
* Statement.CLOSE_ALL_RESULTS
* @since JDK 1.4, HSQLDB 1.7
* @see #execute
*/
public synchronized boolean getMoreResults(
int current) throws SQLException {
return super.getMoreResults(current);
}
/**
*
* Retrieves any auto-generated keys created as a result of executing this
* Statement object. If this Statement object did
* not generate any keys, an empty ResultSet
* object is returned.
* (JDBC4 clarification:)
*
Note:If the columns which represent the auto-generated keys were not specified,
* the JDBC driver implementation will determine the columns which best represent the auto-generated keys.
*
*
*
*
* HSQLDB-Specific Information:
*
* Starting with version 2.0, HSQLDB supports this feature with single-row and
* multi-row insert, update and merge statements.
*
* This method returns a result set only if
* the executeUpdate methods that was used is one of the three methods that
* have the extra parameter indicating return of generated keys
*
* If the executeUpdate method did not specify the columns which represent
* the auto-generated keys the IDENTITY column or GENERATED column(s) of the
* table are returned.
*
* The executeUpdate methods with column indexes or column names return the
* post-insert or post-update values of the specified columns, whether the
* columns are generated or not. This allows values that have been modified
* by execution of triggers to be returned.
*
* If column names or indexes provided by the user in the executeUpdate()
* method calls do not correspond to table columns (incorrect names or
* indexes larger than the column count), an empty result is returned.
*
*
*
*
* @return a ResultSet object containing the auto-generated key(s)
* generated by the execution of this Statement object
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized ResultSet getGeneratedKeys() throws SQLException {
return getGeneratedResultSet();
}
/**
*
* Retrieves the result set holdability for ResultSet objects
* generated by this Statement object.
*
*
* @return either ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @since JDK 1.4, HSQLDB 1.7
*/
public synchronized int getResultSetHoldability() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return ResultProperties.getJDBCHoldability(rsProperties);
}
//------------------------- JDBC 4.0 -----------------------------------
/**
* Retrieves whether this Statement object has been closed. A Statement is closed if the
* method close has been called on it, or if it is automatically closed.
* @return true if this Statement object is closed; false if it is still open
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized boolean isClosed() {
return isClosed;
}
/**
* Sets the designated parameter to the given java.sql.RowId object. The
* driver converts this to a SQL ROWID value when it sends it
* to the database
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the parameter value
* @throws SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since JDK 1.6, HSQLDB 2.0
*/
public void setRowId(int parameterIndex, RowId x) throws SQLException {
throw JDBCUtil.notSupported();
}
/**
* Sets the designated parameter to the given String object.
* The driver converts this to a SQL NCHAR or
* NVARCHAR or LONGNVARCHAR value
* (depending on the argument's
* size relative to the driver's limits on NVARCHAR values)
* when it sends it to the database.
*
* @param parameterIndex of the first parameter is 1, the second is 2, ...
* @param value the parameter value
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur ; if a database access error occurs; or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setNString(int parameterIndex,
String value) throws SQLException {
setString(parameterIndex, value);
}
/**
* Sets the designated parameter to a Reader object. The
* Reader reads the data till end-of-file is reached. The
* driver does the necessary conversion from Java character format to
* the national character set in the database.
* @param parameterIndex of the first parameter is 1, the second is 2, ...
* @param value the parameter value
* @param length the number of characters in the parameter data.
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur ; if a database access error occurs; or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setNCharacterStream(int parameterIndex,
Reader value, long length) throws SQLException {
setCharacterStream(parameterIndex, value, length);
}
/**
* Sets the designated parameter to a java.sql.NClob object. The driver converts this to a
* SQL NCLOB value when it sends it to the database.
* @param parameterIndex of the first parameter is 1, the second is 2, ...
* @param value the parameter value
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur ; if a database access error occurs; or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setNClob(int parameterIndex,
NClob value) throws SQLException {
setClob(parameterIndex, value);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to a Reader object. The reader must contain the number
* of characters specified by length otherwise a SQLException will be
* generated when the PreparedStatement is executed.
* This method differs from the setCharacterStream (int, Reader, int) method
* because it informs the driver that the parameter value should be sent to
* the server as a CLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be send to the server as a LONGVARCHAR or a CLOB
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @param reader An object that contains the data to set the parameter value to.
* @param length the number of characters in the parameter data.
* @throws SQLException if a database access error occurs, this method is called on
* a closed PreparedStatement, if parameterIndex does not correspond to a parameter
* marker in the SQL statement, or if the length specified is less than zero.
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setClob(int parameterIndex, Reader reader,
long length) throws SQLException {
setCharacterStream(parameterIndex, reader, length);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to a InputStream object. The input stream must contain the number
* of characters specified by length otherwise a SQLException will be
* generated when the PreparedStatement is executed.
* This method differs from the setBinaryStream (int, InputStream, int)
* method because it informs the driver that the parameter value should be
* sent to the server as a BLOB. When the setBinaryStream method is used,
* the driver may have to do extra work to determine whether the parameter
* data should be send to the server as a LONGVARBINARY or a BLOB
*
*
* HSQLDB-Specific Information:
*
* In HSQLDB 2.0, this method uses streaming to send the data when the
* stream is assigned to a BLOB target. For other binary targets the
* stream is read on the client side and a byte array is sent.
*
*
*
* @param parameterIndex index of the first parameter is 1,
* the second is 2, ...
* @param inputStream An object that contains the data to set the parameter
* value to.
* @param length the number of bytes in the parameter data.
* @throws SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement,
* if parameterIndex does not correspond
* to a parameter marker in the SQL statement, if the length specified
* is less than zero or if the number of bytes in the input stream does not match
* the specified length.
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setBlob(int parameterIndex,
InputStream inputStream,
long length) throws SQLException {
setBinaryStream(parameterIndex, inputStream, length);
}
/**
* Sets the designated parameter to a Reader object. The reader must contain the number
* of characters specified by length otherwise a SQLException will be
* generated when the PreparedStatement is executed.
* This method differs from the setCharacterStream (int, Reader, int) method
* because it informs the driver that the parameter value should be sent to
* the server as a NCLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be send to the server as a LONGNVARCHAR or a NCLOB
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @param reader An object that contains the data to set the parameter value to.
* @param length the number of characters in the parameter data.
* @throws SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if the length specified is less than zero;
* if the driver does not support national character sets;
* if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since JDK 1.6, HSQLDB 2.0
*/
public synchronized void setNClob(int parameterIndex, Reader reader,
long length) throws SQLException {
setClob(parameterIndex, reader, length);
}
/**
* Sets the designated parameter to the given java.sql.SQLXML object.
* The driver converts this to an
* SQL XML value when it sends it to the database.
*
*
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @param xmlObject a SQLXML object that maps an SQL XML value
* @throws SQLException if a database access error occurs,
* this method is called on a closed PreparedStatement
* or the java.xml.transform.Result,
* Writer or OutputStream has not been closed for
* the SQLXML object
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since JDK 1.6, HSQLDB 2.0
*/
public void setSQLXML(int parameterIndex,
SQLXML xmlObject) throws SQLException {
throw JDBCUtil.notSupported();
}
// --------------------------- Added: Mustang Build 86 -------------------------
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* 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:
*
* From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes
* from the stream into the characters of a String.
* This method does not use streaming to send the data,
* whether the target is a CLOB or other binary object.
*
* For long streams (larger than a few megabytes) with CLOB targets,
* it is more efficient to use a version of setCharacterStream which takes
* the a length parameter.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
* @since JDK 1.6 b86, HSQLDB 2.0
*/
public synchronized void setAsciiStream(int parameterIndex,
java.io.InputStream x, long length) throws SQLException {
if (length < 0) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INVALID_ARGUMENT,
"length: " + length);
}
setAscStream(parameterIndex, x, length);
}
void setAscStream(int parameterIndex, java.io.InputStream x,
long length) throws SQLException {
if (length > Integer.MAX_VALUE) {
throw JDBCUtil.sqlException(ErrorCode.X_22001);
}
if (x == null) {
throw JDBCUtil.nullArgument("x");
}
try {
String s = StringConverter.inputStreamToString(x, "US-ASCII");
if (length >= 0 && s.length() > length) {
s = s.substring(0, (int) length);
}
setParameter(parameterIndex, s);
} catch (IOException e) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR, null, e);
}
}
/**
* 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:
*
* This method uses streaming to send the data when the
* stream is assigned to a BLOB target. For other binary targets the
* stream is read on the client side and a byte array is sent.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @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 or
* this method is called on a closed PreparedStatement
* @since JDK 1.6 b86, HSQLDB 2.0
*/
public synchronized void setBinaryStream(int parameterIndex,
java.io.InputStream x, long length) throws SQLException {
if (length < 0) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INVALID_ARGUMENT,
"length: " + length);
}
setBinStream(parameterIndex, x, length);
}
private void setBinStream(int parameterIndex, java.io.InputStream x,
long length) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (parameterTypes[parameterIndex - 1].typeCode == Types.SQL_BLOB) {
setBlobParameter(parameterIndex, x, length);
return;
}
if (length > Integer.MAX_VALUE) {
String msg = "Maximum Blob input length exceeded: " + length;
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR, msg);
}
try {
HsqlByteArrayOutputStream output;
if (length < 0) {
output = new HsqlByteArrayOutputStream(x);
} else {
output = new HsqlByteArrayOutputStream(x, (int) length);
}
setParameter(parameterIndex, output.toByteArray());
} catch (Throwable e) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR,
e.toString(), e);
}
}
/**
* 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:
*
* This method uses streaming to send data
* when the target is a CLOB.
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param reader the java.io.Reader object that contains the
* Unicode data
* @param length the number of characters in the stream
* @exception SQLException if a database access error occurs or
* this method is called on a closed PreparedStatement
* @since JDK 1.6 b86, HSQLDB 2.0
*/
public synchronized void setCharacterStream(int parameterIndex,
java.io.Reader reader, long length) throws SQLException {
if (length < 0) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INVALID_ARGUMENT,
"length: " + length);
}
setCharStream(parameterIndex, reader, length);
}
private void setCharStream(int parameterIndex, java.io.Reader reader,
long length) throws SQLException {
checkSetParameterIndex(parameterIndex);
if (parameterTypes[parameterIndex - 1].typeCode == Types.SQL_CLOB) {
setClobParameter(parameterIndex, reader, length);
return;
}
if (length > Integer.MAX_VALUE) {
String msg = "Maximum Clob input length exceeded: " + length;
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR, msg);
}
try {
CharArrayWriter writer;
if (length < 0) {
writer = new CharArrayWriter(reader);
} else {
writer = new CharArrayWriter(reader, (int) length);
}
setParameter(parameterIndex, writer.toString());
} catch (Throwable e) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INPUTSTREAM_ERROR,
e.toString(), e);
}
}
/**
* Sets the designated parameter to the given input stream.
* 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.
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setAsciiStream which takes a length parameter.
*
*
*
* HSQLDB-Specific Information:
*
* In HSQLDB 2.0, this method does not use streaming to send the data,
* whether the target is a CLOB or other binary object.
*
* For long streams (larger than a few megabytes), it is more efficient to
* use a version of setCharacterStream which takes the a length parameter.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the Java input stream that contains the ASCII parameter value
* @exception SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
public void setAsciiStream(int parameterIndex,
java.io.InputStream x) throws SQLException {
setAscStream(parameterIndex, x, -1);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to the given input stream.
* 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.
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setBinaryStream which takes a length parameter.
*
*
*
* HSQLDB-Specific Information:
*
* This method does not use streaming to send the data,
* whether the target is a CLOB or other binary object.
*
* For long streams (larger than a few megabytes) with CLOB targets,
* it is more efficient to use a version of setCharacterStream which takes
* the a length parameter.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the java input stream which contains the binary parameter value
* @exception SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
public synchronized void setBinaryStream(int parameterIndex,
java.io.InputStream x) throws SQLException {
setBinStream(parameterIndex, x, -1);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to the given Reader
* object.
* 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.
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setCharacterStream which takes a length parameter.
*
*
*
* HSQLDB-Specific Information:
*
* In HSQLDB 2.0, this method does not use streaming to send the data,
* whether the target is a CLOB or other binary object.
*
* For long streams (larger than a few megabytes), it is more efficient to
* use a version of setCharacterStream which takes the a length parameter.
*
*
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param reader the java.io.Reader object that contains the
* Unicode data
* @exception SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
public void setCharacterStream(int parameterIndex,
java.io.Reader reader) throws SQLException {
setCharStream(parameterIndex, reader, -1);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to a Reader object. The
* Reader reads the data till end-of-file is reached. The
* driver does the necessary conversion from Java character format to
* the national character set in the database.
*
* Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setNCharacterStream which takes a length parameter.
*
* @param parameterIndex of the first parameter is 1, the second is 2, ...
* @param value the parameter value
* @throws SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs; or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
public void setNCharacterStream(int parameterIndex,
Reader value) throws SQLException {
setCharStream(parameterIndex, value, -1);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to a Reader object.
* This method differs from the setCharacterStream (int, Reader) method
* because it informs the driver that the parameter value should be sent to
* the server as a CLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be sent to the server as a LONGVARCHAR or a CLOB
*
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setClob which takes a length parameter.
*
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if a database access error occurs; this method is called on
* a closed PreparedStatementor if parameterIndex does not correspond to a parameter
* marker in the SQL statement
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
public void setClob(int parameterIndex,
Reader reader) throws SQLException {
setCharStream(parameterIndex, reader, -1);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to a InputStream object.
* This method differs from the setBinaryStream (int, InputStream)
* method because it informs the driver that the parameter value should be
* sent to the server as a BLOB. When the setBinaryStream method is used,
* the driver may have to do extra work to determine whether the parameter
* data should be sent to the server as a LONGVARBINARY or a BLOB
*
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setBlob which takes a length parameter.
*
* @param parameterIndex index of the first parameter is 1,
* the second is 2, ...
* @param inputStream An object that contains the data to set the parameter
* value to.
* @throws SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement; if a database access error occurs;
* this method is called on a closed PreparedStatement or
* if parameterIndex does not correspond
* to a parameter marker in the SQL statement,
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
*/
public void setBlob(int parameterIndex,
InputStream inputStream) throws SQLException {
setBinStream(parameterIndex, inputStream, -1);
}
/* @todo 1.9.0 - implement streaming and remove length limits */
/**
* Sets the designated parameter to a Reader object.
* This method differs from the setCharacterStream (int, Reader) method
* because it informs the driver that the parameter value should be sent to
* the server as a NCLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be sent to the server as a LONGNVARCHAR or a NCLOB
*
Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* setNClob which takes a length parameter.
*
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if parameterIndex does not correspond to a parameter
* marker in the SQL statement;
* if the driver does not support national character sets;
* if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
*/
public void setNClob(int parameterIndex,
Reader reader) throws SQLException {
setCharStream(parameterIndex, reader, -1);
}
/**
*
* Retrieves the maximum number of bytes that can be
* returned for character and binary column values in a ResultSet
* object produced by this Statement object.
* This limit applies only to BINARY, VARBINARY,
* LONGVARBINARY, CHAR, VARCHAR,
* (JDBC4 new:) NCHAR, NVARCHAR, LONGNVARCHAR
* and LONGVARCHAR columns. If the limit is exceeded, the
* excess data is silently discarded.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB always returns zero, meaning there is no limit.
*
*
*
* @return the current column size limit for columns storing character and
* binary values; zero means there is no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #setMaxFieldSize
*/
public synchronized int getMaxFieldSize() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return 0;
}
/**
*
* (JDBC4 clarification:) Sets the limit for the maximum number of bytes in a ResultSet
* Sets the limit for the maximum number of bytes that can be returned for
* character and binary column values in a ResultSet
* object produced by this Statement object.
*
* This limit applies
* only to BINARY, VARBINARY,
* LONGVARBINARY, CHAR, VARCHAR,
* (JDBC4 new:) NCHAR, NVARCHAR, LONGNVARCHAR and
* LONGVARCHAR fields. If the limit is exceeded, the excess data
* is silently discarded. For maximum portability, use values
* greater than 256.
*
*
*
*
* HSQLDB-Specific Information:
*
* To present, calls to this method are simply ignored; HSQLDB always
* stores the full number of bytes when dealing with any of the field types
* mentioned above. These types all have an absolute maximum element upper
* bound determined by the Java array index limit
* java.lang.Integer.MAX_VALUE. For XXXBINARY types, this translates to
* Integer.MAX_VALUE bytes. For XXXCHAR types, this translates to
* 2 * Integer.MAX_VALUE bytes (2 bytes / character).
*
* In practice, field sizes are limited to values much smaller than the
* absolute maximum element upper bound, in particular due to limits imposed
* on the maximum available Java heap memory.
*
*
*
* @param max the new column size limit in bytes; zero means there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxFieldSize
*/
public synchronized void setMaxFieldSize(int max) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (max < 0) {
throw JDBCUtil.outOfRangeArgument();
}
}
/**
*
* Retrieves the maximum number of rows that a
* ResultSet object produced by this
* Statement object can contain. If this limit is exceeded,
* the excess rows are silently dropped.
*
*
* @return the current maximum number of rows for a ResultSet
* object produced by this Statement object;
* zero means there is no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #setMaxRows
*/
public synchronized int getMaxRows() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return maxRows;
}
/**
*
* (JDBC4 clarification:)
* Sets the limit for the maximum number of rows that any
* ResultSet object generated by this Statement
* object can contain to the given number.
* If the limit is exceeded, the excess
* rows are silently dropped.
*
*
* @param max the new max rows limit; zero means there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxRows
*/
public synchronized void setMaxRows(int max) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (max < 0) {
throw JDBCUtil.outOfRangeArgument();
}
maxRows = max;
}
/**
*
* Retrieves the number of seconds the driver will
* wait for a Statement object to execute.
* If the limit is exceeded, a
* SQLException is thrown.
*
*
*
*
* HSQLDB-Specific Information:
*
* To present, HSQLDB always returns zero, meaning there
* is no limit.
*
*
*
* @return the current query timeout limit in seconds; zero means there is
* no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #setQueryTimeout
*/
public synchronized int getQueryTimeout() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return queryTimeout;
}
/**
*
* Sets the number of seconds the driver will wait for a
* Statement object to execute to the given number of seconds.
* If the limit is exceeded, an SQLException is thrown. A JDBC
* (JDBC4 clarification:)
* driver must apply this limit to the execute,
* executeQuery and executeUpdate methods. JDBC driver
* implementations may also apply this limit to ResultSet methods
* (consult your driver vendor documentation for details).
*
*
*
*
* HSQLDB-Specific Information:
*
* The maximum number of seconds to wait is 32767.
*
*
*
* @param seconds the new query timeout limit in seconds; zero means
* there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement
* or the condition {@code seconds >= 0} is not satisfied
* @see #getQueryTimeout
*/
public synchronized void setQueryTimeout(int seconds) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (seconds < 0) {
throw JDBCUtil.outOfRangeArgument();
}
if (seconds > Short.MAX_VALUE) {
seconds = Short.MAX_VALUE;
}
queryTimeout = seconds;
}
/**
*
* Cancels this Statement object if both the DBMS and
* driver support aborting an SQL statement.
* This method can be used by one thread to cancel a statement that
* is being executed by another thread.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB version 2.3.4 and later supports aborting an SQL query
* or data update statement.
*
*
*
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
*/
public void cancel() throws SQLException {
checkClosed();
String sql = resultOut.getMainString();
int randomId = connection.sessionProxy.getRandomId();
Result request = Result.newCancelRequest(randomId, -1, sql);
try {
Result response = connection.sessionProxy.cancel(request);
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
}
/**
*
* Retrieves the first warning reported by calls on this Statement object.
* Subsequent Statement object warnings will be chained to this
* SQLWarning object.
*
* The warning chain is automatically cleared each time
* a statement is (re)executed. This method may not be called on a closed
* Statement object; doing so will cause an SQLException
* to be thrown.
*
*
Note: If you are processing a ResultSet object, any
* warnings associated with reads on that ResultSet object
* will be chained on it rather than on the Statement
* object that produced it.
*
*
*
*
* HSQLDB-Specific Information:
*
* From 1.9 HSQLDB, produces Statement warnings.
*
*
*
* @return the first SQLWarning object or null
* if there are no warnings
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
*/
public synchronized SQLWarning getWarnings() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return rootWarning;
}
/**
*
* Clears all the warnings reported on this Statement
* object. After a call to this method,
* the method getWarnings will return
* null until a new warning is reported for this
* Statement object.
*
*
*
*
* HSQLDB-Specific Information:
*
* Supported in HSQLDB 1.9.
*
*
*
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
*/
public synchronized void clearWarnings() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
rootWarning = null;
}
/* @todo 1.9.0 - implement */
/**
*
* Sets the SQL cursor name to the given String, which
* will be used by subsequent Statement object
* execute methods. This name can then be
* used in SQL positioned update or delete statements to identify the
* current row in the ResultSet object generated by this
* statement. If the database does not support positioned update/delete,
* this method is a noop. To insure that a cursor has the proper isolation
* level to support updates, the cursor's SELECT statement
* should have the form SELECT FOR UPDATE. If
* FOR UPDATE is not present, positioned updates may fail.
*
* Note: By definition, the execution of positioned updates and
* deletes must be done by a different Statement object than
* the one that generated the ResultSet object being used for
* positioning. Also, cursor names must be unique within a connection.
*
*
*
*
* HSQLDB-Specific Information:
*
* Including 2.0, HSQLDB does not support named cursors;
* calls to this method are ignored.
*
*
*
* @param name the new cursor name, which must be unique within
* a connection
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*/
public void setCursorName(String name) throws SQLException {
checkClosed();
}
//----------------------- Multiple Results --------------------------
/**
*
* Retrieves the current result as a ResultSet object.
* This method should be called only once per result.
*
*
*
*
* HSQLDB-Specific Information:
*
* Without an interceding call to executeXXX, each invocation of this
* method will produce a new, initialized ResultSet instance referring to
* the current result, if any.
*
*
*
* @return the current result as a ResultSet object or
* null if the result is an update count or there are no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #execute
*/
public synchronized ResultSet getResultSet() throws SQLException {
return super.getResultSet();
}
/**
*
* Retrieves the current result as an update count;
* if the result is a ResultSet object or there are no more results, -1
* is returned. This method should be called only once per result.
*
*
* @return the current result as an update count; -1 if the current result is a
* ResultSet object or there are no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #execute
*/
public synchronized int getUpdateCount() throws SQLException {
return super.getUpdateCount();
}
/**
*
* Moves to this Statement object's next result, returns
* true if it is a ResultSet object, and
* implicitly closes any current ResultSet
* object(s) obtained with the method getResultSet.
*
* There are no more results when the following is true:
*
{@code
* // stmt is a Statement object
* ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
* }
*
*
* @return true if the next result is a ResultSet
* object; false if it is an update count or there are
* no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #execute
*/
public synchronized boolean getMoreResults() throws SQLException {
return getMoreResults(JDBCStatementBase.CLOSE_CURRENT_RESULT);
}
//--------------------------JDBC 2.0-----------------------------
/**
*
* Gives the driver a hint as to the direction in which
* rows will be processed in ResultSet
* objects created using this Statement object. The
* default value is ResultSet.FETCH_FORWARD.
*
* Note that this method sets the default fetch direction for
* result sets generated by this Statement object.
* Each result set has its own methods for getting and setting
* its own fetch direction.
*
*
*
*
* HSQLDB-Specific Information:
*
* Up to 1.8.0.x, HSQLDB supports only FETCH_FORWARD;
* Setting any other value would throw an SQLException
* stating that the operation is not supported.
*
* Starting with 2.0, HSQLDB accepts any valid value.
*
*
*
* @param direction the initial direction for processing rows
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement
* or the given direction
* is not one of ResultSet.FETCH_FORWARD,
* ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN
* @since JDK 1.2
* @see #getFetchDirection
*/
public synchronized void setFetchDirection(
int direction) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (direction != ResultSet.FETCH_FORWARD
&& direction != ResultSet.FETCH_REVERSE
&& direction != ResultSet.FETCH_UNKNOWN) {
throw JDBCUtil.notSupported();
}
fetchDirection = direction;
}
/**
*
* Retrieves the direction for fetching rows from
* database tables that is the default for result sets
* generated from this Statement object.
* If this Statement object has not set
* a fetch direction by calling the method setFetchDirection,
* the return value is implementation-specific.
*
*
*
*
* HSQLDB-Specific Information:
*
* Up to 1.8.0.x, HSQLDB always returned FETCH_FORWARD.
*
* Starting with 2.0, HSQLDB returns FETCH_FORWARD by default, or
* whatever value has been explicitly assigned by invoking
* setFetchDirection.
* .
*
*
*
* @return the default fetch direction for result sets generated
* from this Statement object
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @since JDK 1.2
* @see #setFetchDirection
*/
public synchronized int getFetchDirection() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return fetchDirection;
}
/**
*
* (JDBC4 clarification:)
* Gives the JDBC driver a hint as to the number of rows that should
* be fetched from the database when more rows are needed for
* ResultSet objects generated by this Statement.
* If the value specified is zero, then the hint is ignored.
* The default value is zero.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB uses the specified value as a hint, but may process more or fewer
* rows than specified.
*
*
*
* @param rows the number of rows to fetch
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the
* (JDBC4 modified:)
* condition {@code rows >= 0} is not satisfied.
* @since JDK 1.2
* @see #getFetchSize
*/
public synchronized void setFetchSize(int rows) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (rows < 0) {
throw JDBCUtil.outOfRangeArgument();
}
fetchSize = rows;
}
/**
*
* Retrieves the number of result set rows that is the default
* fetch size for ResultSet objects
* generated from this Statement object.
* If this Statement object has not set
* a fetch size by calling the method setFetchSize,
* the return value is implementation-specific.
*
*
*
*
* HSQLDB-Specific Information
*
* HSQLDB returns 0 by default, or the fetch size specified by setFetchSize
*
*
*
* @return the default fetch size for result sets generated
* from this Statement object
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @since JDK 1.2
* @see #setFetchSize
*/
public synchronized int getFetchSize() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return fetchSize;
}
/**
*
* Retrieves the result set concurrency for ResultSet objects
* generated by this Statement object.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB supports CONCUR_READ_ONLY and
* CONCUR_READ_UPDATEBLE concurrency.
*
*
*
* @return either ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @since JDK 1.2
*/
public synchronized int getResultSetConcurrency() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return ResultProperties.getJDBCConcurrency(rsProperties);
}
/**
*
* Retrieves the result set type for ResultSet objects
* generated by this Statement object.
*
*
*
*
* HSQLDB-Specific Information:
*
* HSQLDB 1.7.0 and later versions support TYPE_FORWARD_ONLY
* and TYPE_SCROLL_INSENSITIVE.
*
*
*
* @return one of ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @since JDK 1.2
*/
public synchronized int getResultSetType() throws SQLException {
// fredt - omit checkClosed() in order to be able to handle the result of a
// SHUTDOWN query
if (isClosed || connection.isClosed) {
checkClosed();
}
return ResultProperties.getJDBCScrollability(rsProperties);
}
/**
*
* Empties this Statement object's current list of
* SQL commands.
*
* (JDBC4 clarification:)
* NOTE: Support of an ability to batch updates is optional.
*
*
*
*
* HSQLDB-Specific Information:
*
* Starting with HSQLDB 1.7.2, this feature is supported.
*
*
*
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the
* driver does not support batch updates
* @see #addBatch
* @since JDK 1.2
*/
public synchronized void clearBatch() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (isBatch) {
resultOut.getNavigator().clear();
}
}
/**
*
* Retrieves the Connection object
* that produced this Statement object.
*
*
* @return the connection that produced this statement
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @since JDK 1.2
*/
public synchronized Connection getConnection() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return connection;
}
//----------------------------- JDBC 4.0 -----------------------------------
boolean poolable = true;
/**
* Requests that a Statement be pooled or not pooled. The value
* specified is a hint to the statement pool implementation indicating
* whether the application wants the statement to be pooled. It is up to
* the statement pool manager as to whether the hint is used.
*
* The poolable value of a statement is applicable to both internal
* statement caches implemented by the driver and external statement caches
* implemented by application servers and other applications.
*
* By default, a Statement is not poolable when created, and
* a PreparedStatement and CallableStatement
* are poolable when created.
*
* @param poolable requests that the statement be pooled if true and
* that the statement not be pooled if false
*
* @throws SQLException if this method is called on a closed
* Statement
*
* @since JDK 1.6 Build 81, HSQLDB 2.0
*/
public synchronized void setPoolable(
boolean poolable) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
this.poolable = poolable;
}
/**
* Returns a value indicating whether the Statement
* is poolable or not.
*
* @return true if the Statement
* is poolable; false otherwise
* @throws SQLException if this method is called on a closed
* Statement
*
* @since JDK 1.6 Build 81, HSQLDB 2.0
*
* @see #setPoolable(boolean) setPoolable(boolean)
*/
public synchronized boolean isPoolable() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
return this.poolable;
}
// ------------------- java.sql.Wrapper implementation ---------------------
/**
* Returns an object that implements the given interface to allow access to
* non-standard methods, or standard methods not exposed by the proxy.
*
* If the receiver implements the interface then the result is the receiver
* or a proxy for the receiver. If the receiver is a wrapper
* and the wrapped object implements the interface then the result is the
* wrapped object or a proxy for the wrapped object. Otherwise return the
* the result of calling unwrap recursively on the wrapped object
* or a proxy for that result. If the receiver is not a
* wrapper and does not implement the interface, then an SQLException is thrown.
*
* @param iface A Class defining an interface that the result must implement.
* @return an object that implements the interface. May be a proxy for the actual implementing object.
* @throws java.sql.SQLException If no object found that implements the interface
* @since JDK 1.6, HSQLDB 2.0
*/
@SuppressWarnings("unchecked")
public T unwrap(Class iface) throws java.sql.SQLException {
if (isWrapperFor(iface)) {
return (T) this;
}
throw JDBCUtil.invalidArgument("iface: " + iface);
}
/**
* Returns true if this either implements the interface argument or is directly or indirectly a wrapper
* for an object that does. Returns false otherwise. If this implements the interface then return true,
* else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped
* object. If this does not implement the interface and is not a wrapper, return false.
* This method should be implemented as a low-cost operation compared to unwrap so that
* callers can use this method to avoid expensive unwrap calls that may fail. If this method
* returns true then calling unwrap with the same argument should succeed.
*
* @param iface a Class defining an interface.
* @return true if this implements the interface or directly or indirectly wraps an object that does.
* @throws java.sql.SQLException if an error occurs while determining whether this is a wrapper
* for an object with the given interface.
* @since JDK 1.6, HSQLDB 2.0
*/
public boolean isWrapperFor(
java.lang.Class iface) throws java.sql.SQLException {
return (iface != null && iface.isAssignableFrom(this.getClass()));
}
//------------------------- JDBC 4.2 -----------------------------------
/**
* Retrieves the current result as an update count; if the result
* is a ResultSet object or there are no more results, -1
* is returned. This method should be called only once per result.
*
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
*
* The public implementation will throw {@code UnsupportedOperationException}
*
* @return the current result as an update count; -1 if the current result
* is a ResultSet object or there are no more results
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #execute
* @since 1.8
*/
//#ifdef JAVA8
public long getLargeUpdateCount() throws SQLException {
return super.getUpdateCount();
}
//#endif JAVA8
/**
* Sets the limit for the maximum number of rows that any
* ResultSet object generated by this Statement
* object can contain to the given number.
* If the limit is exceeded, the excess
* rows are silently dropped.
*
* This method should be used when the row limit may exceed
* {@link Integer#MAX_VALUE}.
*
* The default implementation will throw {@code UnsupportedOperationException}
*
* @param max the new max rows limit; zero means there is no limit
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement
* or the condition {@code max >= 0} is not satisfied
* @see #getMaxRows
* @since 1.8
*/
//#ifdef JAVA8
public void setLargeMaxRows(long max) throws SQLException {
int maxRows = max > Integer.MAX_VALUE ? Integer.MAX_VALUE :
(int) max;
setMaxRows(maxRows);
}
//#endif JAVA8
/**
* Retrieves the maximum number of rows that a
* ResultSet object produced by this
* Statement object can contain. If this limit is exceeded,
* the excess rows are silently dropped.
*
* This method should be used when the returned row limit may exceed
* {@link Integer#MAX_VALUE}.
*
* The default implementation will return {@code 0}
*
* @return the current maximum number of rows for a ResultSet
* object produced by this Statement object;
* zero means there is no limit
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @see #setMaxRows
* @since 1.8
*/
//#ifdef JAVA8
public long getLargeMaxRows() throws SQLException {
return maxRows;
}
//#endif JAVA8
/**
* Submits a batch of commands to the database for execution and
* if all commands execute successfully, returns an array of update counts.
* The long elements of the array that is returned are ordered
* to correspond to the commands in the batch, which are ordered
* according to the order in which they were added to the batch.
* The elements in the array returned by the method {@code executeLargeBatch}
* may be one of the following:
*
* - A number greater than or equal to zero -- indicates that the
* command was processed successfully and is an update count giving the
* number of rows in the database that were affected by the command's
* execution
*
- A value of
SUCCESS_NO_INFO -- indicates that the command was
* processed successfully but that the number of rows affected is
* unknown
*
* If one of the commands in a batch update fails to execute properly,
* this method throws a BatchUpdateException, and a JDBC
* driver may or may not continue to process the remaining commands in
* the batch. However, the driver's behavior must be consistent with a
* particular DBMS, either always continuing to process commands or never
* continuing to process commands. If the driver continues processing
* after a failure, the array returned by the method
* BatchUpdateException.getLargeUpdateCounts
* will contain as many elements as there are commands in the batch, and
* at least one of the elements will be the following:
*
*
- A value of
EXECUTE_FAILED -- indicates that the command failed
* to execute successfully and occurs only if a driver continues to
* process commands after a command fails
*
*
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
*
* The default implementation will throw {@code UnsupportedOperationException}
*
* @return an array of update counts containing one element for each
* command in the batch. The elements of the array are ordered according
* to the order in which commands were added to the batch.
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the
* driver does not support batch statements. Throws {@link BatchUpdateException}
* (a subclass of SQLException) if one of the commands sent to the
* database fails to execute properly or attempts to return a result set.
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
*
* @see #addBatch
* @see DatabaseMetaData#supportsBatchUpdates
* @since 1.8
*/
//#ifdef JAVA8
public long[] executeLargeBatch() throws SQLException {
int[] updateCounts = executeBatch();
long[] longCounts = new long[updateCounts.length];
for(int i = 0; i < updateCounts.length; i++) {
longCounts[i] = updateCounts[i];
}
return longCounts;
}
//#endif JAVA8
/**
*
Sets the value of the designated parameter with the given object.
*
* If the second argument is an {@code InputStream} then the stream
* must contain the number of bytes specified by scaleOrLength.
* If the second argument is a {@code Reader} then the reader must
* contain the number of characters specified by scaleOrLength. If these
* conditions are not true the driver will generate a
* {@code SQLException} when the prepared statement is executed.
*
*
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 {@code SQLData}),
* the JDBC driver should call the method {@code SQLData.writeSQL} to
* write it to the SQL data stream.
* If, on the other hand, the object is of a class implementing
* {@code Ref}, {@code Blob}, {@code Clob}, {@code NClob},
* {@code Struct}, {@code java.net.URL},
* or {@code 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.
*
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type to be sent to the database. The
* scale argument may further qualify this type.
* @param scaleOrLength for {@code java.sql.JDBCType.DECIMAL}
* or {@code java.sql.JDBCType.NUMERIC types},
* this is the number of digits after the decimal point. For
* Java Object types {@code InputStream} and {@code Reader},
* this is the length
* of the data in the stream or reader. For all other types,
* this value will be ignored.
* @exception SQLException if parameterIndex does not correspond to a
* parameter marker in the SQL statement; if a database access error occurs
* or this method is called on a closed {@code PreparedStatement} or
* if the Java Object specified by x is an InputStream
* or Reader object and the value of the scale parameter is less
* than zero
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified targetSqlType
* @see JDBCType
* @see SQLType
* @since 1.8
*/
//#ifdef JAVA8
public void setObject(int parameterIndex, Object x, SQLType targetSqlType,
int scaleOrLength) throws SQLException {
int typeNo = targetSqlType.getVendorTypeNumber().intValue();
setObject(parameterIndex, x, typeNo, scaleOrLength);
}
//#endif JAVA8
/**
* Sets the value of the designated parameter with the given object.
*
* This method is similar to {@link #setObject(int parameterIndex,
* Object x, SQLType targetSqlType, int scaleOrLength)},
* except that it assumes a scale of zero.
*
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type to be sent to the database
* @exception SQLException if parameterIndex does not correspond to a
* parameter marker in the SQL statement; if a database access error occurs
* or this method is called on a closed {@code PreparedStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* the specified targetSqlType
* @see JDBCType
* @see SQLType
* @since 1.8
*/
//#ifdef JAVA8
public void setObject(int parameterIndex, Object x, SQLType targetSqlType)
throws SQLException {
int typeNo = targetSqlType.getVendorTypeNumber().intValue();
setObject(parameterIndex, x, typeNo);
}
//#endif JAVA8
/**
* Executes the SQL statement in this PreparedStatement object,
* which must be an SQL Data Manipulation Language (DML) statement,
* such as INSERT, UPDATE or
* DELETE; or an SQL statement that returns nothing,
* such as a DDL statement.
*
* This method should be used when the returned row count may exceed
* {@link Integer#MAX_VALUE}.
*
* The default implementation will throw {@code UnsupportedOperationException}
*
* @return either (1) the row count for SQL Data Manipulation Language
* (DML) statements or (2) 0 for SQL statements that return nothing
* @exception SQLException if a database access error occurs;
* this method is called on a closed PreparedStatement
* or the SQL statement returns a ResultSet object
* @throws SQLTimeoutException when the driver has determined that the
* timeout value that was specified by the {@code setQueryTimeout}
* method has been exceeded and has at least attempted to cancel
* the currently running {@code Statement}
* @since 1.8
*/
public long executeLargeUpdate() throws SQLException {
return executeUpdate();
}
//-------------------- Internal Implementation -----------------------------
/**
* Constructs a statement that produces results of the requested
* type.
*
* A prepared statement must be a single SQL statement.
*
* @param c the Connection used execute this statement
* @param sql the SQL statement this object represents
* @param resultSetType the type of result this statement will produce (scrollability)
* @param resultSetConcurrency (updatability)
* @param resultSetHoldability (validity beyond commit)
* @param generatedKeys internal mode of handling generated key reporting
* @param generatedIndexes column indexes for generated keys
* @param generatedNames column names for generated keys are given
* @throws HsqlException if the statement is not accepted by the database
* @throws SQLException if preprocessing by driver fails
*/
JDBCPreparedStatement(JDBCConnection c, String sql, int resultSetType,
int resultSetConcurrency, int resultSetHoldability,
int generatedKeys, int[] generatedIndexes,
String[] generatedNames) throws HsqlException,
SQLException {
isResult = false;
connection = c;
connectionIncarnation = connection.incarnation;
session = c.sessionProxy;
sql = c.nativeSQL(sql);
resultOut = Result.newPrepareStatementRequest();
int props = ResultProperties.getValueForJDBC(resultSetType,
resultSetConcurrency, resultSetHoldability);
resultOut.setPrepareOrExecuteProperties(sql, 0, 0, 0, queryTimeout,
props, generatedKeys, generatedIndexes, generatedNames);
Result in = session.execute(resultOut);
if (in.mode == ResultConstants.ERROR) {
throw JDBCUtil.sqlException(in);
}
rootWarning = null;
Result current = in;
while (current.getChainedResult() != null) {
current = current.getUnlinkChainedResult();
if (current.isWarning()) {
SQLWarning w = JDBCUtil.sqlWarning(current);
if (rootWarning == null) {
rootWarning = w;
} else {
rootWarning.setNextWarning(w);
}
}
}
connection.setWarnings(rootWarning);
statementID = in.getStatementID();
statementRetType = in.getStatementType();
resultMetaData = in.metaData;
parameterMetaData = in.parameterMetaData;
parameterTypes = parameterMetaData.getParameterTypes();
parameterModes = parameterMetaData.paramModes;
rsProperties = in.rsProperties;
//
int paramCount = parameterMetaData.getColumnCount();
parameterValues = new Object[paramCount];
parameterSet = new Boolean[paramCount];
streamLengths = new long[paramCount];
//
//
for (int i = 0; i < paramCount; i++) {
if (parameterTypes[i].isLobType()) {
hasLOBs = true;
break;
}
}
//
resultOut = Result.newPreparedExecuteRequest(parameterTypes,
statementID);
resultOut.setStatement(in.getStatement());
// for toString()
this.sql = sql;
}
/**
* Constructor for updatable ResultSet
*/
JDBCPreparedStatement(JDBCConnection c, Result result) {
isResult = true;
connection = c;
connectionIncarnation = connection.incarnation;
session = c.sessionProxy;
int paramCount = result.metaData.getExtendedColumnCount();
parameterMetaData = result.metaData;
parameterTypes = result.metaData.columnTypes;
parameterModes = new byte[paramCount];
parameterValues = new Object[paramCount];
parameterSet = new Boolean[paramCount];
streamLengths = new long[paramCount];
//
for (int i = 0; i < paramCount; i++) {
parameterModes[i] = SchemaObject.ParameterModes.PARAM_IN;
if (parameterTypes[i].isLobType()) {
hasLOBs = true;
}
}
//
resultOut = Result.newUpdateResultRequest(parameterTypes,
result.getResultId());
}
/**
* Checks if execution does or does not generate a single row
* update count, throwing if the argument, yes, does not match.
*
* @param type type of statement regarding what it returns
* something other than a single row update count.
* @throws SQLException if the argument, yes, does not match
*/
protected void checkStatementType(int type) throws SQLException {
if (type != statementRetType) {
if (statementRetType == StatementTypes.RETURN_COUNT) {
throw JDBCUtil.sqlException(ErrorCode.X_07504);
} else {
throw JDBCUtil.sqlException(ErrorCode.X_07503);
}
}
}
protected void checkParameterIndex(int i) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (i < 1 || i > parameterValues.length) {
String msg = "parameter index out of range: " + i;
throw JDBCUtil.outOfRangeArgument(msg);
}
}
/**
* Checks if the specified parameter index value is valid in terms of
* setting an IN or IN OUT parameter value.
*
* @param i The parameter index to check
* @throws SQLException if the specified parameter index is invalid
*/
protected void checkSetParameterIndex(int i) throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
if (i < 1 || i > parameterValues.length) {
String msg = "parameter index out of range: " + i;
throw JDBCUtil.outOfRangeArgument(msg);
}
if (parameterModes[i - 1] == SchemaObject.ParameterModes.PARAM_OUT) {
String msg = "Not IN or INOUT mode for parameter: " + i;
throw JDBCUtil.invalidArgument(msg);
}
}
/**
* Checks if the specified parameter index value is valid in terms of
* getting an OUT or INOUT parameter value.
*
* @param i The parameter index to check
* @throws SQLException if the specified parameter index is invalid
*/
protected void checkGetParameterIndex(int i) throws SQLException {
String msg;
if (isClosed || connection.isClosed) {
checkClosed();
}
if (i < 1 || i > parameterValues.length) {
msg = "parameter index out of range: " + i;
throw JDBCUtil.outOfRangeArgument(msg);
}
int mode = parameterModes[i - 1];
switch (mode) {
case SchemaObject.ParameterModes.PARAM_UNKNOWN :
case SchemaObject.ParameterModes.PARAM_OUT :
case SchemaObject.ParameterModes.PARAM_INOUT :
break;
case SchemaObject.ParameterModes.PARAM_IN :
default :
msg = "Not OUT or INOUT mode: " + mode + " for parameter: "
+ i;
throw JDBCUtil.invalidArgument(msg);
}
}
/**
* Called just before execution or adding to batch, this ensures all the
* parameters have been set.
*
* If a parameter has been set using a stream method, it should be set
* again for the next reuse. When set using other methods, the parameter
* setting is retained for the next use.
* @throws SQLException
*/
private void checkParametersSet() throws SQLException {
if (isResult) {
return;
}
for (int i = 0; i < parameterSet.length; i++) {
if (parameterModes[i] != SchemaObject.ParameterModes.PARAM_OUT) {
if (parameterSet[i] == null) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_PARAMETER_NOT_SET);
}
}
}
}
/**
* The internal parameter value setter always converts the parameter to
* the type required for data transmission.
*
* @param i parameter index
* @param o object
* @throws SQLException if either argument is not acceptable.
*/
void setParameter(int i, Object o) throws SQLException {
checkSetParameterIndex(i);
i--;
if (o == null) {
parameterValues[i] = null;
parameterSet[i] = Boolean.TRUE;
return;
}
Type outType = parameterTypes[i];
switch (outType.typeCode) {
case Types.OTHER :
try {
if (connection.isStoreLiveObject) {
o = new JavaObjectDataInternal(o);
break;
}
if (o instanceof Serializable) {
o = new JavaObjectData((Serializable) o);
break;
}
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
throw JDBCUtil.sqlException(ErrorCode.X_42563);
case Types.SQL_BIT :
case Types.SQL_BIT_VARYING :
try {
if (o instanceof Boolean) {
o = outType.convertToDefaultType(session, o);
break;
}
if (o instanceof Integer) {
o = outType.convertToDefaultType(session, o);
break;
}
if (o instanceof byte[]) {
o = outType.convertToDefaultType(session, o);
break;
}
if (o instanceof String) {
o = outType.convertToDefaultType(session, o);
break;
}
if (o instanceof BitSet) {
o = outType.convertToDefaultType(session, o);
break;
}
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
throw JDBCUtil.sqlException(ErrorCode.X_42563);
case Types.SQL_BINARY :
case Types.SQL_VARBINARY :
case Types.SQL_GUID :
if (o instanceof byte[]) {
o = new BinaryData((byte[]) o, !connection.isNetConn);
break;
}
if (o instanceof UUID) {
o = BinaryUUIDType.getBinary((UUID) o);
break;
}
try {
if (o instanceof String) {
o = outType.convertToDefaultType(session, o);
break;
}
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
throw JDBCUtil.sqlException(ErrorCode.X_42563);
case Types.SQL_ARRAY :
if (o instanceof Array) {
setArray(i + 1, (Array) o);
return;
}
if (o instanceof ArrayList) {
o = ((ArrayList) o).toArray();
}
if (o instanceof Object[]) {
Type baseType = outType.collectionBaseType();
Object[] array = (Object[]) o;
Object[] data = new Object[array.length];
for (int j = 0; j < data.length; j++) {
data[j] = baseType.convertJavaToSQL(session, array[j]);
}
o = data;
break;
}
throw JDBCUtil.sqlException(ErrorCode.X_42563);
case Types.SQL_BLOB :
setBlobParameter(i + 1, o);
return;
case Types.SQL_CLOB :
setClobParameter(i + 1, o);
return;
case Types.SQL_DATE :
case Types.SQL_TIME_WITH_TIME_ZONE :
case Types.SQL_TIMESTAMP_WITH_TIME_ZONE :
case Types.SQL_TIME :
case Types.SQL_TIMESTAMP : {
try {
if (o instanceof String) {
o = outType.convertToType(session, o,
Type.SQL_VARCHAR);
break;
}
o = outType.convertJavaToSQL(session, o);
break;
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
}
case Types.TINYINT :
case Types.SQL_SMALLINT :
case Types.SQL_INTEGER :
case Types.SQL_BIGINT :
case Types.SQL_REAL :
case Types.SQL_FLOAT :
case Types.SQL_DOUBLE :
case Types.SQL_NUMERIC :
case Types.SQL_DECIMAL :
try {
if (o instanceof String) {
o = outType.convertToType(session, o,
Type.SQL_VARCHAR);
break;
} else if (o instanceof Boolean) {
boolean value = ((Boolean) o).booleanValue();
o = value ? Integer.valueOf(1)
: Integer.valueOf(0);
}
o = outType.convertToDefaultType(session, o);
break;
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
case Types.SQL_VARCHAR : {
if (o instanceof String) {
break;
} else {
try {
o = outType.convertToDefaultType(session, o);
break;
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
}
}
case Types.SQL_CHAR : {
if (outType.precision == 1) {
if (o instanceof Character) {
o = new String(new char[] {
((Character) o).charValue() });
break;
} else if (o instanceof Boolean) {
o = ((Boolean) o).booleanValue() ? "1"
: "0";
break;
}
}
try {
o = outType.convertToDefaultType(session, o);
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
break;
}
default :
try {
o = outType.convertToDefaultType(session, o);
break;
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
}
}
parameterValues[i] = o;
parameterSet[i] = Boolean.TRUE;
}
/**
* setParameterForClob
*
* @param i int
* @param o Object
* @throws SQLException
*/
void setClobParameter(int i, Object o) throws SQLException {
setClobParameter(i, o, 0);
}
void setClobParameter(int i, Object o,
long streamLength) throws SQLException {
if (o instanceof JDBCClobClient) {
JDBCClobClient clob = (JDBCClobClient) o;
if (!clob.session.getDatabaseUniqueName().equals(
session.getDatabaseUniqueName())) {
streamLength = clob.length();
Reader is = clob.getCharacterStream();
parameterValues[i - 1] = is;
streamLengths[i - 1] = streamLength;
parameterSet[i - 1] = Boolean.FALSE;
return;
}
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.TRUE;
return;
} else if (o instanceof Clob) {
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.TRUE;
return;
} else if (o instanceof ClobInputStream) {
ClobInputStream is = (ClobInputStream) o;
if (is.session.getDatabaseUniqueName().equals(
session.getDatabaseUniqueName())) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INVALID_ARGUMENT,
"invalid Reader");
}
parameterValues[i - 1] = o;
streamLengths[i - 1] = streamLength;
parameterSet[i - 1] = Boolean.FALSE;
return;
} else if (o instanceof Reader) {
parameterValues[i - 1] = o;
streamLengths[i - 1] = streamLength;
parameterSet[i - 1] = Boolean.FALSE;
return;
} else if (o instanceof String) {
JDBCClob clob = new JDBCClob((String) o);
parameterValues[i - 1] = clob;
parameterSet[i - 1] = Boolean.FALSE;
return;
}
throw JDBCUtil.invalidArgument();
}
/**
* setParameterForBlob
*
* @param i int
* @param o Object
*/
void setBlobParameter(int i, Object o) throws SQLException {
setBlobParameter(i, o, 0);
}
void setBlobParameter(int i, Object o,
long streamLength) throws SQLException {
if (o instanceof JDBCBlobClient) {
JDBCBlobClient blob = (JDBCBlobClient) o;
if (!blob.session.getDatabaseUniqueName().equals(
session.getDatabaseUniqueName())) {
streamLength = blob.length();
InputStream is = blob.getBinaryStream();
parameterValues[i - 1] = is;
streamLengths[i - 1] = streamLength;
parameterSet[i - 1] = Boolean.FALSE;
return;
}
// in the same database
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.TRUE;
return;
} else if (o instanceof Blob) {
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.FALSE;
return;
} else if (o instanceof BlobInputStream) {
BlobInputStream is = (BlobInputStream) o;
if (is.session.getDatabaseUniqueName().equals(
session.getDatabaseUniqueName())) {
throw JDBCUtil.sqlException(ErrorCode.JDBC_INVALID_ARGUMENT,
"invalid Reader");
}
// in the same database ? see if it blocks in
parameterValues[i - 1] = o;
streamLengths[i - 1] = streamLength;
parameterSet[i - 1] = Boolean.FALSE;
return;
} else if (o instanceof InputStream) {
parameterValues[i - 1] = o;
streamLengths[i - 1] = streamLength;
parameterSet[i - 1] = Boolean.FALSE;
return;
} else if (o instanceof byte[]) {
JDBCBlob blob = new JDBCBlob((byte[]) o);
parameterValues[i - 1] = blob;
parameterSet[i - 1] = Boolean.TRUE;
return;
}
throw JDBCUtil.invalidArgument();
}
/**
* Used with int and narrower integral primitives
* @param i parameter index
* @param value object to set
* @throws SQLException if either argument is not acceptable
*/
void setIntParameter(int i, int value) throws SQLException {
checkSetParameterIndex(i);
int outType = parameterTypes[i - 1].typeCode;
switch (outType) {
case Types.TINYINT :
case Types.SQL_SMALLINT :
case Types.SQL_INTEGER : {
Object o = Integer.valueOf(value);
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.TRUE;
break;
}
case Types.SQL_BIGINT : {
Object o = Long.valueOf(value);
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.TRUE;
break;
}
case Types.SQL_BINARY :
case Types.SQL_VARBINARY :
case Types.OTHER :
throw JDBCUtil.sqlException(ErrorCode.X_42563);
default :
setParameter(i, Integer.valueOf(value));
}
}
/**
* Used with long and narrower integral primitives. Conversion to BINARY
* or OTHER types will throw here and not passed to setParameter().
*
* @param i parameter index
* @param value object to set
* @throws SQLException if either argument is not acceptable
*/
void setLongParameter(int i, long value) throws SQLException {
checkSetParameterIndex(i);
int outType = parameterTypes[i - 1].typeCode;
switch (outType) {
case Types.SQL_BIGINT :
Object o = Long.valueOf(value);
parameterValues[i - 1] = o;
parameterSet[i - 1] = Boolean.TRUE;
break;
case Types.SQL_BINARY :
case Types.SQL_VARBINARY :
case Types.OTHER :
throw JDBCUtil.sqlException(ErrorCode.X_42563);
default :
setParameter(i, Long.valueOf(value));
}
}
private void performPreExecute() throws SQLException, HsqlException {
if (!hasLOBs) {
return;
}
for (int i = 0; i < parameterValues.length; i++) {
Object value = parameterValues[i];
if (value == null) {
continue;
}
if (parameterTypes[i].typeCode == Types.SQL_BLOB) {
long id;
BlobDataID blob = null;
if (value instanceof JDBCBlobClient) {
// check or fix id mismatch
blob = ((JDBCBlobClient) value).blob;
id = blob.getId();
} else if (value instanceof Blob) {
long length = ((Blob) value).length();
blob = session.createBlob(length);
id = blob.getId();
InputStream stream = ((Blob) value).getBinaryStream();
ResultLob resultLob =
ResultLob.newLobCreateBlobRequest(session.getId(), id,
stream, length);
session.allocateResultLob(resultLob, null);
resultOut.addLobResult(resultLob);
} else if (value instanceof InputStream) {
long length = streamLengths[i];
long createLength = length > 0 ? length : 0;
blob = session.createBlob(createLength);
id = blob.getId();
InputStream stream = (InputStream) value;
ResultLob resultLob =
ResultLob.newLobCreateBlobRequest(session.getId(), id,
stream, length);
session.allocateResultLob(resultLob, null);
resultOut.addLobResult(resultLob);
} else if (value instanceof BlobDataID) {
blob = (BlobDataID) value;
}
parameterValues[i] = blob;
} else if (parameterTypes[i].typeCode == Types.SQL_CLOB) {
long id;
ClobDataID clob = null;
if (value instanceof JDBCClobClient) {
// check or fix id mismatch
clob = ((JDBCClobClient) value).clob;
id = clob.getId();
} else if (value instanceof Clob) {
long length = ((Clob) value).length();
Reader reader = ((Clob) value).getCharacterStream();
clob = session.createClob(length);
id = clob.getId();
ResultLob resultLob =
ResultLob.newLobCreateClobRequest(session.getId(), id,
reader, length);
session.allocateResultLob(resultLob, null);
resultOut.addLobResult(resultLob);
} else if (value instanceof Reader) {
long length = streamLengths[i];
long createLength = length > 0 ? length : 0;
clob = session.createClob(createLength);
id = clob.getId();
Reader reader = (Reader) value;
ResultLob resultLob =
ResultLob.newLobCreateClobRequest(session.getId(), id,
reader, length);
session.allocateResultLob(resultLob, null);
resultOut.addLobResult(resultLob);
} else if (value instanceof ClobDataID) {
clob = (ClobDataID) value;
}
parameterValues[i] = clob;
}
}
}
/**
* Internal result producer for JDBCStatement (sqlExecDirect mode).
*
*
* @throws SQLException when a database access error occurs
*/
void fetchResult() throws SQLException {
if (isClosed || connection.isClosed) {
checkClosed();
}
closeResultData();
checkParametersSet();
if (isBatch) {
throw JDBCUtil.sqlExceptionSQL(ErrorCode.X_07505);
}
//
if (isResult) {
resultOut.setPreparedResultUpdateProperties(parameterValues);
} else {
resultOut.setPreparedExecuteProperties(parameterValues, maxRows,
fetchSize, rsProperties, queryTimeout);
}
try {
performPreExecute();
resultIn = session.execute(resultOut);
} catch (HsqlException e) {
throw JDBCUtil.sqlException(e);
} finally {
performPostExecute();
}
if (resultIn.mode == ResultConstants.ERROR) {
throw JDBCUtil.sqlException(resultIn);
}
if (resultIn.isData()) {
currentResultSet = new JDBCResultSet(connection, this, resultIn,
resultIn.metaData);
} else if (statementRetType == StatementTypes.RETURN_RESULT) {
getMoreResults();
}
}
boolean isAnyParameterSet() {
for (int i = 0; i < parameterValues.length; i++) {
if (parameterSet[i] != null) {
return true;
}
}
return false;
}
/**
* processes chained warnings and any generated columns result set
*/
void performPostExecute() throws SQLException {
super.performPostExecute();
}
/** The parameter values for the next non-batch execution. */
protected Object[] parameterValues;
/** Flags for bound variables. */
protected Boolean[] parameterSet;
/** The SQL types of the parameters. */
protected Type[] parameterTypes;
/** The (IN, IN OUT, or OUT) modes of parameters */
protected byte[] parameterModes;
/** Lengths for streams. */
protected long[] streamLengths;
/** Has one or more CLOB / BLOB type parameters. */
protected boolean hasLOBs;
/** Is in batch mode. */
protected boolean isBatch;
/** Description of result set metadata. */
protected ResultMetaData resultMetaData;
/** Description of parameter metadata. */
protected ResultMetaData parameterMetaData;
/** This object's one and one ResultSetMetaData object. */
protected JDBCResultSetMetaData resultSetMetaData;
/** This object's one and only ParameterMetaData object. */
protected ParameterMetaData pmd;
/** The SQL character sequence that this object represents. */
protected String sql;
/** ID of the statement. */
protected long statementID;
/** Statement type - whether it generates a row update count or a result set. */
protected int statementRetType;
/** Is part of a Result. */
protected final boolean isResult;
/** The session attribute of the connection */
protected SessionInterface session;
}