org.firebirdsql.jdbc.AbstractStatement Maven / Gradle / Ivy
Show all versions of jaybird-jdk17 Show documentation
/*
* Firebird Open Source JavaEE Connector - JDBC Driver
*
* Distributable under LGPL license.
* You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* LGPL License for more details.
*
* This file was created by members of the firebird development team.
* All individual contributions remain the Copyright (C) of those
* individuals. Contributors to this file are either listed here or
* can be obtained from a source control history command.
*
* All rights reserved.
*/
package org.firebirdsql.jdbc;
import java.sql.*;
import java.util.*;
import org.firebirdsql.gds.*;
import org.firebirdsql.gds.impl.*;
/**
* The object used for executing a static SQL statement and obtaining the results produced by it.
*
*
* Only one ResultSet object per Statement object
* can be open at any point in
* time. Therefore, if the reading of one ResultSet object is interleaved
* with the reading of another, each must have been generated by
* different Statement objects. All statement execute
* methods implicitly close a statement's current ResultSet object
* if an open one exists.
*
*
* @see Connection#createStatement
* @see ResultSet
*
* @author David Jencks
*/
public abstract class AbstractStatement implements FirebirdStatement, Synchronizable {
protected GDSHelper gdsHelper;
private final Object syncObject;
protected FBObjectListener.StatementListener statementListener;
protected AbstractIscStmtHandle fixedStmt;
//The normally retrieved result set. (no autocommit, not a cached rs).
private FBResultSet currentRs;
private boolean closed;
protected boolean completed = true;
private boolean escapedProcessing = true;
private volatile boolean closeOnCompletion = false;
protected SQLWarning firstWarning = null;
protected StatementResult currentStatementResult = StatementResult.NO_MORE_RESULTS;
protected int maxRows = 0;
protected int fetchSize = 0;
private int maxFieldSize = 0;
private int queryTimeout = 0;
private String cursorName;
private int rsConcurrency;
private int rsType;
private int rsHoldability = ResultSet.CLOSE_CURSORS_AT_COMMIT;
private FBObjectListener.ResultSetListener resultSetListener = new RSListener();
protected AbstractConnection connection;
/**
* Listener for the result sets.
*/
private class RSListener implements FBObjectListener.ResultSetListener {
/**
* Notify that result set was closed. This method cleans the result
* set reference, so that call to {@link #close()} method will not cause
* exception.
*
* @param rs result set that was closed.
*/
public void resultSetClosed(ResultSet rs) throws SQLException {
currentRs = null;
// notify listener that statement is completed.
notifyStatementCompleted();
if (closeOnCompletion) {
close();
}
}
/* (non-Javadoc)
* @see org.firebirdsql.jdbc.FBObjectListener.ResultSetListener#allRowsFetched(java.sql.ResultSet)
*/
public void allRowsFetched(ResultSet rs) throws SQLException {
/*
* According to the JDBC 3.0 specification (p.62) the result set
* is closed in the autocommit mode if one of the following occurs:
*
* - all of the rows have been retrieved
* - the associated Statement object is re-executed
* - another Statement object is executed on the same connection
*/
// according to the specification we close the result set and
// generate the "resultSetClosed" event, that in turn generates
// the "statementCompleted" event
if (statementListener.getConnection().getAutoCommit())
rs.close();
}
/* (non-Javadoc)
* @see org.firebirdsql.jdbc.FBObjectListener.ResultSetListener#executionCompleted(org.firebirdsql.jdbc.FirebirdRowUpdater, boolean)
*/
public void executionCompleted(FirebirdRowUpdater updater, boolean success) throws SQLException {
notifyStatementCompleted(success);
}
/* (non-Javadoc)
* @see org.firebirdsql.jdbc.FBObjectListener.ResultSetListener#executionStarted(org.firebirdsql.jdbc.FirebirdRowUpdater)
*/
public void executionStarted(FirebirdRowUpdater updater) throws SQLException {
notifyStatementStarted(false);
}
}
protected AbstractStatement(GDSHelper c, int rsType, int rsConcurrency, int rsHoldability, FBObjectListener.StatementListener statementListener) throws SQLException {
this.gdsHelper = c;
syncObject = c.getSynchronizationObject();
this.rsConcurrency = rsConcurrency;
this.rsType = rsType;
this.rsHoldability = rsHoldability;
this.statementListener = statementListener;
this.connection = statementListener != null ?
statementListener.getConnection() : null;
closed = false;
}
String getCursorName() {
return cursorName;
}
public boolean isValid() {
return !closed && (fixedStmt == null || fixedStmt.isValid());
}
public final Object getSynchronizationObject() {
return syncObject;
}
protected void finalize() throws Throwable {
try {
if (!closed)
close();
} finally {
super.finalize();
}
}
public void completeStatement() throws SQLException {
completeStatement(CompletionReason.OTHER);
}
public void completeStatement(CompletionReason reason) throws SQLException {
if (currentRs != null && (reason != CompletionReason.COMMIT || currentRs.getHoldability() == ResultSet.CLOSE_CURSORS_AT_COMMIT)) {
closeResultSet(false, reason);
}
if (!completed)
notifyStatementCompleted();
}
/**
* Executes an SQL statement that returns a single ResultSet object.
*
* @param sql typically this is a static SQL SELECT statement
* @return a ResultSet object that contains the data produced by the
* given query; never null
* @exception SQLException if a database access error occurs
*/
public ResultSet executeQuery(String sql) throws SQLException {
checkValidity();
synchronized(getSynchronizationObject()) {
notifyStatementStarted();
try {
if (!internalExecute(sql)) {
throw new FBSQLException("Query did not return a result set.",
FBSQLException.SQL_STATE_NO_RESULT_SET);
}
return getResultSet();
} catch (GDSException ge) {
throw new FBSQLException(ge);
}
}
}
protected void notifyStatementStarted() throws SQLException {
notifyStatementStarted(true);
}
protected void notifyStatementStarted(boolean closeResultSet) throws SQLException {
if (closeResultSet)
closeResultSet(false);
// notify listener that statement execution is about to start
statementListener.executionStarted(this);
completed = false;
}
protected void notifyStatementCompleted() throws SQLException {
notifyStatementCompleted(true);
}
protected void notifyStatementCompleted(boolean success) throws SQLException {
completed = true;
statementListener.statementCompleted(this, success);
}
/**
* Executes an SQL INSERT, UPDATE or
* DELETE statement. In addition,
* SQL statements that return nothing, such as SQL DDL statements,
* can be executed.
*
* @param sql an SQL INSERT, UPDATE or
* DELETE statement or an SQL statement that returns nothing
* @return either the row count for INSERT, UPDATE
* or DELETE statements, or 0 for SQL statements that return nothing
* @exception SQLException if a database access error occurs
*/
public int executeUpdate(String sql) throws SQLException {
checkValidity();
synchronized (getSynchronizationObject()) {
notifyStatementStarted();
try {
try {
if (internalExecute(sql)) { throw new FBSQLException(
"Update statement returned results."); }
return getUpdateCount();
} catch (GDSException ge) {
throw new FBSQLException(ge);
}
} finally {
notifyStatementCompleted();
}
}
}
/**
* Executes the given SQL statement and signals the driver with the
* given flag about whether the
* auto-generated keys produced by this Statement object
* should be made available for retrieval. The driver will ignore the
* flag if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* @param sql 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.
*
* @param autoGeneratedKeys a flag indicating whether auto-generated keys
* should be made available for retrieval;
* one of the following constants:
* Statement.RETURN_GENERATED_KEYS
* Statement.NO_GENERATED_KEYS
* @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 Statement, the given
* SQL statement returns a ResultSet object, or
* the given constant is not one of those allowed
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method with a constant of Statement.RETURN_GENERATED_KEYS
* @since 1.4
*/
public int executeUpdate(String sql, int autoGeneratedKeys)
throws SQLException {
execute(sql, autoGeneratedKeys);
return getUpdateCount();
}
/**
* Executes the given SQL statement and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the indexes of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* @param sql 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.
*
* @param columnIndexes an array of column indexes indicating the columns
* that should be returned from the inserted row
* @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 Statement, the SQL
* statement returns a ResultSet object, or the
* second argument supplied to this method is not an int array
* whose elements are valid column indexes
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.4
*/
public int executeUpdate(String sql, int[] columnIndexes)
throws SQLException {
execute(sql, columnIndexes);
return getUpdateCount();
}
/**
* Executes the given SQL statement and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the names of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* @param sql 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.
* @param columnNames an array of the names of the columns that should be
* returned from the inserted row
* @return either the row count for INSERT, UPDATE,
* or DELETE statements, or 0 for SQL statements
* that return nothing
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement, the SQL
* statement returns a ResultSet object, or the
* second argument supplied to this method is not a String array
* whose elements are valid column names
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.4
*/
public int executeUpdate(String sql, String[] columnNames)
throws SQLException {
execute(sql, columnNames);
return getUpdateCount();
}
/**
* Executes the given SQL statement, which may return multiple results,
* and signals the driver that any
* auto-generated keys should be made available
* for retrieval. The driver will ignore this signal if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* In some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
*
* The execute method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* getResultSet or getUpdateCount
* to retrieve the result, and getMoreResults to
* move to any subsequent result(s).
*
* @param sql any SQL statement
* @param autoGeneratedKeys a constant indicating whether auto-generated
* keys should be made available for retrieval using the method
* getGeneratedKeys; one of the following constants:
* Statement.RETURN_GENERATED_KEYS or
* Statement.NO_GENERATED_KEYS
* @return true if the first result is a ResultSet
* object; false if it is an update count or there are
* no results
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the second
* parameter supplied to this method is not
* Statement.RETURN_GENERATED_KEYS or
* Statement.NO_GENERATED_KEYS.
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method with a constant of Statement.RETURN_GENERATED_KEYS
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
* @see #getGeneratedKeys
*
* @since 1.4
*/
public boolean execute(String sql, int autoGeneratedKeys)
throws SQLException {
checkValidity();
if (autoGeneratedKeys == Statement.RETURN_GENERATED_KEYS) {
connection.checkAutoGeneratedKeysSupport();
}
AbstractGeneratedKeysQuery query = connection.new GeneratedKeysQuery(sql, autoGeneratedKeys);
return execute(query.getQueryString());
}
/**
* Executes the given SQL statement, which may return multiple results,
* and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the indexes of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* Under some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
*
* The execute method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* getResultSet or getUpdateCount
* to retrieve the result, and getMoreResults to
* move to any subsequent result(s).
*
* @param sql any SQL statement
* @param columnIndexes an array of the indexes of the columns in the
* inserted row that should be made available for retrieval by a
* call to the method getGeneratedKeys
* @return true if the first result is a ResultSet
* object; false if it is an update count or there
* are no results
* @exception SQLException if a database access error occurs,
* this method is called on a closed Statement or the
* elements in the int array passed to this method
* are not valid column indexes
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
*
* @since 1.4
*/
public boolean execute(String sql, int[] columnIndexes) throws SQLException {
checkValidity();
connection.checkAutoGeneratedKeysSupport();
AbstractGeneratedKeysQuery query = connection.new GeneratedKeysQuery(sql, columnIndexes);
return execute(query.getQueryString());
}
/**
* Executes the given SQL statement, which may return multiple results,
* and signals the driver that the
* auto-generated keys indicated in the given array should be made available
* for retrieval. This array contains the names of the columns in the
* target table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* In some (uncommon) situations, a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string.
*
* The execute method executes an SQL statement and indicates the
* form of the first result. You must then use the methods
* getResultSet or getUpdateCount
* to retrieve the result, and getMoreResults to
* move to any subsequent result(s).
*
* @param sql any SQL statement
* @param columnNames an array of the names of the columns in the inserted
* row that should be made available for retrieval by a call to the
* method getGeneratedKeys
* @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
* elements of the String array passed to this
* method are not valid column names
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
* @see #getGeneratedKeys
*
* @since 1.4
*/
public boolean execute(String sql, String[] columnNames)
throws SQLException {
checkValidity();
connection.checkAutoGeneratedKeysSupport();
AbstractGeneratedKeysQuery query = connection.new GeneratedKeysQuery(sql, columnNames);
return execute(query.getQueryString());
}
/**
* 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.
*
*
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.
*
* @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 1.4
*/
public ResultSet getGeneratedKeys() throws SQLException {
checkValidity();
ResultSet rs = getResultSet();
if (rs == null) {
rs = new FBResultSet(new XSQLVAR[0], new ArrayList());
}
return rs;
}
/**
* Releases this Statement object's database
* and JDBC resources immediately instead of waiting for
* this to happen when it is automatically closed.
* It is generally good practice to release resources as soon as
* you are finished with them to avoid tying up database
* resources.
*
* Calling the method close on a Statement
* object that is already closed has no effect.
*
Note: A Statement object is automatically closed when it is
* garbage collected. When a Statement object is closed, its current
* ResultSet object, if one exists, is also closed.
*
* @exception SQLException if a database access error occurs
*/
public void close() throws SQLException {
close(true);
}
void close(boolean ignoreAlreadyClosed) throws SQLException {
if (isClosed()) {
if (ignoreAlreadyClosed)
return;
throw new FBSQLException("This statement is already closed.");
}
synchronized(getSynchronizationObject()) {
if (fixedStmt != null) {
try {
try {
closeResultSet(false);
} finally {
//may need ensureTransaction?
if (fixedStmt.isValid())
gdsHelper.closeStatement(fixedStmt, true);
}
} catch (GDSException ge) {
throw new FBSQLException(ge);
} finally {
fixedStmt = null;
}
}
}
closed = true;
statementListener.statementClosed(this);
}
/**
* Check if this statement was closed. This is quick workaround to avoid
* additional {@link #close()} in our cleanup code.
*
* @return true if this statement was already closed.
*/
public boolean isClosed() {
return closed;
}
//----------------------------------------------------------------------
/**
* Returns the maximum number of bytes allowed
* for any column value.
* This limit is the maximum number of bytes that can be
* returned for any column value.
* The limit applies only to BINARY,
* VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR
* columns. If the limit is exceeded, the excess data is silently
* discarded.
*
* @return the current max column size limit; zero means unlimited
* @exception SQLException if a database access error occurs
*/
public int getMaxFieldSize() throws SQLException {
return maxFieldSize;
}
/**
* Sets the limit for the maximum number of bytes in a column to
* the given number of bytes. This is the maximum number of bytes
* that can be returned for any column value. This limit applies
* only to BINARY, VARBINARY,
* LONGVARBINARY, CHAR, VARCHAR, and
* LONGVARCHAR fields. If the limit is exceeded, the excess data
* is silently discarded. For maximum portability, use values
* greater than 256.
*
* @param max the new max column size limit; zero means unlimited
* @exception SQLException if a database access error occurs
*/
public void setMaxFieldSize(int max) throws SQLException {
if (max<0)
throw new FBSQLException("Can't set max field size negative",
FBSQLException.SQL_STATE_INVALID_ARG_VALUE);
else
maxFieldSize = max;
}
/**
* Retrieves the maximum number of rows that a
* ResultSet object can contain. If the limit is exceeded, the excess
* rows are silently dropped.
*
* @return the current max row limit; zero means unlimited
* @exception SQLException if a database access error occurs
*/
public int getMaxRows() throws SQLException {
return maxRows;
}
/**
* Sets the limit for the maximum number of rows that any
* ResultSet 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 unlimited
* @exception SQLException if a database access error occurs
*/
public void setMaxRows(int max) throws SQLException {
if (max < 0)
throw new FBSQLException("Max rows can't be less than 0",
FBSQLException.SQL_STATE_INVALID_ARG_VALUE);
else
maxRows = max;
}
/**
* Sets escape processing on or off.
* If escape scanning is on (the default), the driver will do
* escape substitution before sending the SQL to the database.
*
* Note: Since prepared statements have usually been parsed prior
* to making this call, disabling escape processing for prepared
* statements will have no effect.
*
* @param enable true to enable; false to disable
* @exception SQLException if a database access error occurs
*/
public void setEscapeProcessing(boolean enable) throws SQLException {
escapedProcessing = enable;
}
/**
* Retrieves the number of seconds the driver will
* wait for a Statement object to execute. If the limit is exceeded, a
* SQLException is thrown.
*
* @return the current query timeout limit in seconds; zero means unlimited
* @exception SQLException if a database access error occurs
*/
public int getQueryTimeout() throws SQLException {
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.
*
* @param seconds the new query timeout limit in seconds; zero means
* unlimited
* @exception SQLException if a database access error occurs
*/
public void setQueryTimeout(int seconds) throws SQLException {
if (seconds<0)
throw new FBSQLException("Can't set query timeout negative",
FBSQLException.SQL_STATE_INVALID_ARG_VALUE);
else
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.
*
* @exception SQLException if a database access error occurs
*/
public void cancel() throws SQLException {
try {
gdsHelper.cancelOperation();
} catch(GDSException ex) {
throw new FBSQLException(ex);
}
}
/**
* 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.
*
*
Note: If you are processing a ResultSet object, any
* warnings associated with reads on that ResultSet object
* will be chained on it.
*
* @return the first SQLWarning object or null
* @exception SQLException if a database access error occurs
*/
public SQLWarning getWarnings() throws SQLException {
return firstWarning;
}
/**
* 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.
*
* @exception SQLException if a database access error occurs
*/
public void clearWarnings() throws SQLException {
firstWarning = null;
}
/**
* Defines the SQL cursor name that will be used by
* subsequent Statement object execute methods.
* This name can then be
* used in SQL positioned update/delete statements to identify the
* current row in the ResultSet object generated by this statement. If
* the database doesn't 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 be
* of the form 'select for update ...'. If the 'for update' phrase is
* omitted, positioned updates may fail.
*
*
Note: By definition, positioned update/delete
* execution must be done by a different Statement object than the one
* which generated the ResultSet object being used for positioning. Also,
* cursor names must be unique within a connection.
*
* @param name the new cursor name, which must be unique within
* a connection
* @exception SQLException if a database access error occurs
*/
public void setCursorName(String name) throws SQLException {
this.cursorName = name;
}
boolean isUpdatableCursor() {
return cursorName != null;
}
//----------------------- Multiple Results --------------------------
/**
* Executes an SQL statement that may return multiple results.
* Under some (uncommon) situations a single SQL statement may return
* multiple result sets and/or update counts. Normally you can ignore
* this unless you are (1) executing a stored procedure that you know may
* return multiple results or (2) you are dynamically executing an
* unknown SQL string. The methods execute,
* getMoreResults, getResultSet,
* and getUpdateCount let you navigate through multiple results.
*
* The execute method executes an SQL statement and indicates the
* form of the first result. You can then use the methods
* getResultSet or getUpdateCount
* to retrieve the result, and getMoreResults to
* move to any subsequent result(s).
*
* @param sql any SQL statement
* @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
* @see #getResultSet
* @see #getUpdateCount
* @see #getMoreResults
*/
public boolean execute(String sql) throws SQLException {
checkValidity();
synchronized (getSynchronizationObject()) {
notifyStatementStarted();
boolean hasResultSet = false;
try {
try {
hasResultSet = internalExecute(sql);
} catch (GDSException ge) {
throw new FBSQLException(ge);
}
} finally {
if (!hasResultSet) {
notifyStatementCompleted();
}
}
return hasResultSet;
}
}
/**
* Returns the current result as a ResultSet object.
* This method should be called only once per result.
* Calling this method twice with autocommit on and used will probably
* throw an inappropriate or uninformative exception.
*
* @return the current result as a ResultSet object;
* null if the result is an update count or there are no more results
* @exception SQLException if a database access error occurs
* @see #execute
*/
public ResultSet getResultSet() throws SQLException {
checkValidity();
return getResultSet(false);
}
public ResultSet getResultSet(boolean metaDataQuery) throws SQLException {
try {
if (cursorName != null)
gdsHelper.setCursorName(fixedStmt, cursorName);
} catch(GDSException ex) {
throw new FBSQLException(ex);
}
if (currentRs != null) {
throw new FBSQLException("Only one resultset at a time/statement.");
}
if (fixedStmt == null) {
throw new FBSQLException("No statement was executed.");
}
if (currentStatementResult == StatementResult.RESULT_SET) {
currentRs = new FBResultSet(connection, this, fixedStmt,
resultSetListener, metaDataQuery, rsType, rsConcurrency,
rsHoldability, false);
return currentRs;
}
return null;
}
public boolean hasOpenResultSet() {
return currentRs != null;
}
/**
* Returns 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
* @see #execute
*/
public int getUpdateCount() throws SQLException {
checkValidity();
if (currentStatementResult != StatementResult.UPDATE_COUNT) {
return -1;
}
return getUpdateCountInternal();
}
/**
* Gets the current update count, even when a result set is currently open.
*
* @return Update count.
* @throws SQLException
*/
protected int getUpdateCountInternal() throws SQLException {
populateSqlCounts();
int insCount = fixedStmt.getInsertCount();
int updCount = fixedStmt.getUpdateCount();
int delCount = fixedStmt.getDeleteCount();
return Math.max(Math.max(updCount, delCount), insCount);
}
private void populateSqlCounts() throws SQLException {
try {
gdsHelper.getSqlCounts(fixedStmt);
} catch (GDSException ge) {
throw new FBSQLException(ge);
}
}
private static final int INSERTED_ROWS_COUNT = 1;
private static final int UPDATED_ROWS_COUNT = 2;
private static final int DELETED_ROWS_COUNT = 3;
private int getChangedRowsCount(int type) throws SQLException {
if (currentStatementResult != StatementResult.UPDATE_COUNT) {
return -1;
}
populateSqlCounts();
switch(type) {
case INSERTED_ROWS_COUNT :
return fixedStmt.getInsertCount();
case UPDATED_ROWS_COUNT :
return fixedStmt.getUpdateCount();
case DELETED_ROWS_COUNT :
return fixedStmt.getDeleteCount();
default :
throw new IllegalArgumentException(String.format("Specified type %d is unknown.", type));
}
}
public int getDeletedRowsCount() throws SQLException {
return getChangedRowsCount(DELETED_ROWS_COUNT);
}
public int getInsertedRowsCount() throws SQLException {
return getChangedRowsCount(INSERTED_ROWS_COUNT);
}
public int getUpdatedRowsCount() throws SQLException {
return getChangedRowsCount(UPDATED_ROWS_COUNT);
}
/**
* Moves to a Statement object's next result. It returns
* true if this result is a ResultSet object.
* This method also implicitly closes any current ResultSet
* object obtained with the method getResultSet.
*
*
There are no more results when the following is true:
*
* (!getMoreResults() && (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
* @see #execute
*/
public boolean getMoreResults() throws SQLException {
return getMoreResults(Statement.CLOSE_ALL_RESULTS);
}
public boolean getMoreResults(int mode) throws SQLException {
checkValidity();
boolean closeResultSet = mode == Statement.CLOSE_ALL_RESULTS
|| mode == Statement.CLOSE_CURRENT_RESULT;
if (closeResultSet && currentRs != null) {
closeResultSet(true);
}
currentStatementResult = currentStatementResult.nextResult();
// Technically the statement below is always false, as only the first result is ever a ResultSet
return currentStatementResult == StatementResult.RESULT_SET;
}
/**
* Gives the driver a hint as to the direction in which
* the rows in a result set
* will be processed. The hint applies only to result sets 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.
* @param direction the initial direction for processing rows
* @exception SQLException if a database access error occurs
* or the given direction
* is not one of ResultSet.FETCH_FORWARD,
* ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public void setFetchDirection(int direction) throws SQLException {
if (direction != ResultSet.FETCH_FORWARD)
throw new FBDriverNotCapableException();
}
/**
* 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.
*
* @return the default fetch direction for result sets generated
* from this Statement object
* @exception SQLException if a database access error occurs
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public int getFetchDirection() throws SQLException {
return ResultSet.FETCH_FORWARD;
}
/**
* Gives the JDBC driver a hint as to the number of rows that should
* be fetched from the database when more rows are needed. The number
* of rows specified affects only result sets created using this
* statement. If the value specified is zero, then the hint is ignored.
* The default value is zero.
*
* @param rows the number of rows to fetch
* @exception SQLException if a database access error occurs, or the
* condition 0 <= rows <= this.getMaxRows() is not satisfied.
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public void setFetchSize(int rows) throws SQLException {
if (rows < 0)
throw new FBSQLException("Can't set negative fetch size",
FBSQLException.SQL_STATE_INVALID_ARG_VALUE);
else if (maxRows > 0 && rows > maxRows)
throw new FBSQLException("Can't set fetch size > maxRows",
FBSQLException.SQL_STATE_INVALID_ARG_VALUE);
else
fetchSize = rows;
}
/**
* Retrieves the number of result set rows that is the default
* fetch size for result sets
* 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.
* @return the default fetch size for result sets generated
* from this Statement object
* @exception SQLException if a database access error occurs
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public int getFetchSize() throws SQLException {
return fetchSize;
}
/**
* Retrieves the result set concurrency for ResultSet objects
* generated by this Statement object.
*
* @return either ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public int getResultSetConcurrency() throws SQLException {
return rsConcurrency;
}
/**
* Retrieves the result set type for ResultSet objects
* generated by this Statement object.
*
* @return one of ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public int getResultSetType() throws SQLException {
return rsType;
}
/**
* Retrieves the result set holdability for ResultSet objects
* generated by this Statement object.
*
* @return either {@link ResultSet#HOLD_CURSORS_OVER_COMMIT} or
* {@link ResultSet#CLOSE_CURSORS_AT_COMMIT}
*
* @throws SQLException if a database access error occurs
*/
public int getResultSetHoldability() throws SQLException {
return rsHoldability;
}
private LinkedList batchList = new LinkedList();
/**
* Adds an SQL command to the current batch of commmands for this
* Statement object. This method is optional.
*
* @param sql typically this is a static SQL INSERT or
* UPDATE statement
* @exception SQLException if a database access error occurs, or the
* driver does not support batch statements
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public void addBatch(String sql) throws SQLException {
batchList.add(sql);
}
/**
* Makes the set of commands in the current batch empty.
* This method is optional.
*
* @exception SQLException if a database access error occurs or the
* driver does not support batch statements
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public void clearBatch() throws SQLException {
batchList.clear();
}
/**
* 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
-2 -- 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
-3 -- 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 proccess commands in a batch
* update after a BatchUpdateException obejct has been thrown.
*
* @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 or the
* driver does not support batch statements. Throws {@link java.sql.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.
* @since 1.3
* @see What Is in the JDBC
* 2.0 API
*/
public int[] executeBatch() throws SQLException {
checkValidity();
if (statementListener.getConnection().getAutoCommit())
addWarning(new SQLWarning("Batch updates should be run with auto-commit disabled.", "1000"));
notifyStatementStarted();
synchronized (getSynchronizationObject()) {
boolean success = false;
try {
List responses = new ArrayList(batchList.size());
try {
for (Object value : batchList) {
String sql = (String) value;
try {
boolean hasResultSet = internalExecute(sql);
if (hasResultSet)
throw new BatchUpdateException(toArray(responses));
else
responses.add(getUpdateCount());
} catch (GDSException ge) {
throw new BatchUpdateException(ge.getMessage(),
FBSQLException.SQL_STATE_GENERAL_ERROR, ge.getFbErrorCode(),
toArray(responses));
}
}
success = true;
return toArray(responses);
} finally {
clearBatch();
}
} finally {
notifyStatementCompleted(success);
}
}
}
/**
* Convert collection of {@link Integer} elements into array of int.
*
* @param list
* collection of integer elements.
*
* @return array of int.
*/
protected int[] toArray(Collection list) {
int[] result = new int[list.size()];
int counter = 0;
for (int value : list) {
result[counter++] = value;
}
return result;
}
/**
* Returns the Connection object that produced this
* Statement object.
*
* @return the connection that produced this statement
*/
public Connection getConnection() throws SQLException {
checkValidity();
return connection;
}
//package level
void closeResultSet(boolean notifyListener) throws SQLException {
closeResultSet(notifyListener, CompletionReason.OTHER);
}
void closeResultSet(boolean notifyListener, CompletionReason completionReason) throws SQLException {
boolean wasCompleted = completed;
try {
if (currentRs != null) {
try {
currentRs.close(notifyListener, completionReason);
} finally {
currentRs = null;
}
}
} finally {
if (notifyListener && !wasCompleted)
statementListener.statementCompleted(this);
}
}
public void forgetResultSet() { //yuck should be package
currentRs = null;
if (fixedStmt != null) {
fixedStmt.clearRows();
}
}
public ResultSet getCurrentResultSet() throws SQLException {
return currentRs;
}
public boolean isPoolable() throws SQLException {
checkValidity();
return false;
}
public void setPoolable(boolean poolable) throws SQLException {
checkValidity();
// ignore the hint
}
public boolean isWrapperFor(Class iface) throws SQLException {
return iface != null && iface.isAssignableFrom(getClass());
}
public T unwrap(Class iface) throws SQLException {
if (!isWrapperFor(iface))
throw new FBDriverNotCapableException();
return iface.cast(this);
}
// JDBC 4.1
public void closeOnCompletion() {
closeOnCompletion = true;
}
public boolean isCloseOnCompletion() {
return closeOnCompletion;
}
/**
* This method checks if supplied statement is executing procedure or
* it is generic statement. This check is needed to handle correctly
* parameters that are returned from non-selectable procedures.
*
* @param sql SQL statement to check
*
* @return true if supplied statement is EXECUTE PROCEDURE
* type of statement.
*
* @throws SQLException if translating statement into native code failed.
*/
protected boolean isExecuteProcedureStatement(String sql) throws SQLException {
String trimmedSql = nativeSQL(sql).trim();
return trimmedSql.startsWith("EXECUTE");
}
protected boolean internalExecute(String sql) throws GDSException, SQLException {
checkValidity();
prepareFixedStatement(sql, false);
gdsHelper.executeStatement(fixedStmt, fixedStmt.getStatementType() == ISCConstants.isc_info_sql_stmt_exec_procedure);
boolean hasResultSet = fixedStmt.getOutSqlda().sqld > 0;
currentStatementResult = hasResultSet
? StatementResult.RESULT_SET
: StatementResult.UPDATE_COUNT;
return hasResultSet;
}
protected void prepareFixedStatement(String sql, boolean describeBind) throws GDSException, SQLException {
if (fixedStmt == null) {
fixedStmt = gdsHelper.allocateStatement();
}
if (!fixedStmt.isValid())
throw new FBSQLException("Corresponding connection is not valid.",
FBSQLException.SQL_STATE_CONNECTION_FAILURE_IN_TX);
gdsHelper.prepareStatement(
fixedStmt,
escapedProcessing ? nativeSQL(sql) : sql,
describeBind);
}
protected void addWarning(SQLWarning warning) {
if (firstWarning == null)
firstWarning = warning;
else{
SQLWarning lastWarning = firstWarning;
while (lastWarning.getNextWarning() != null){
lastWarning = lastWarning.getNextWarning();
}
lastWarning.setNextWarning(warning);
}
}
protected String nativeSQL(String sql) throws SQLException {
DatabaseParameterBuffer dpb = gdsHelper.getDatabaseParameterBuffer();
int mode = FBEscapedParser.USE_BUILT_IN;
if (dpb.hasArgument(DatabaseParameterBufferExtension.USE_STANDARD_UDF))
mode = FBEscapedParser.USE_STANDARD_UDF;
return new FBEscapedParser(mode).parse(sql);
}
/**
* Get the execution plan of this PreparedStatement
*
* @return The execution plan of the statement
*/
String getExecutionPlan() throws FBSQLException {
populateStatementInfo();
return fixedStmt.getExecutionPlan();
}
public String getLastExecutionPlan() throws SQLException {
checkValidity();
if (fixedStmt == null)
throw new FBSQLException("No statement was executed, plan cannot be obtained.");
return getExecutionPlan();
}
/**
* Get the statement type of this PreparedStatement.
* The returned value will be one of the TYPE_* constant
* values.
*
* @return The identifier for the given statement's type
*/
int getStatementType() throws FBSQLException {
if (fixedStmt == null) {
return 0;
}
populateStatementInfo();
return fixedStmt.getStatementType();
}
private void populateStatementInfo() throws FBSQLException {
if (fixedStmt.getExecutionPlan() == null){
try {
gdsHelper.populateStatementInfo(fixedStmt);
} catch(GDSException ex) {
throw new FBSQLException(ex);
}
}
}
/**
* Check if this statement is valid. This method should be invoked before
* executing any action which requires a valid connection.
*
* @throws SQLException if this Statement has been closed and cannot be
* used anymore.
*/
protected void checkValidity() throws SQLException {
if (isClosed())
throw new FBSQLException("Statement is already closed.", FBSQLException.SQL_STATE_INVALID_STATEMENT_ID);
}
/**
* The current result of a statement.
*/
protected enum StatementResult {
RESULT_SET {
@Override
public StatementResult nextResult() {
return UPDATE_COUNT;
}
},
UPDATE_COUNT {
@Override
public StatementResult nextResult() {
return NO_MORE_RESULTS;
}
},
NO_MORE_RESULTS {
@Override
public StatementResult nextResult() {
return NO_MORE_RESULTS;
}
};
/**
* @return Next result
*/
public abstract StatementResult nextResult();
}
}