|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.firebirdsql.jdbc.AbstractStatement
public abstract class AbstractStatement
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 statment's current ResultSet
object
if an open one exists.
Connection.createStatement()
,
ResultSet
Field Summary | |
---|---|
protected boolean |
completed
|
protected int |
fetchSize
|
protected java.sql.SQLWarning |
firstWarning
|
protected org.firebirdsql.gds.impl.AbstractIscStmtHandle |
fixedStmt
|
protected org.firebirdsql.gds.impl.GDSHelper |
gdsHelper
|
protected boolean |
hasMoreResults
|
protected boolean |
isResultSet
|
protected int |
maxRows
|
protected FBObjectListener.StatementListener |
statementListener
|
Fields inherited from interface org.firebirdsql.jdbc.FirebirdStatement |
---|
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, KEEP_CURRENT_RESULT |
Fields inherited from interface java.sql.Statement |
---|
EXECUTE_FAILED, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
Constructor Summary | |
---|---|
protected |
AbstractStatement(org.firebirdsql.gds.impl.GDSHelper c,
int rsType,
int rsConcurrency,
int rsHoldability,
FBObjectListener.StatementListener statementListener)
|
Method Summary | |
---|---|
void |
addBatch(java.lang.String sql)
Adds an SQL command to the current batch of commmands for this Statement object. |
protected void |
addWarning(java.sql.SQLWarning warning)
|
void |
cancel()
Cancels this Statement object if both the DBMS and
driver support aborting an SQL statement. |
void |
clearBatch()
Makes the set of commands in the current batch empty. |
void |
clearWarnings()
Clears all the warnings reported on this Statement
object. |
void |
close()
Releases this Statement object's database
and JDBC resources immediately instead of waiting for
this to happen when it is automatically closed. |
void |
completeStatement()
|
boolean |
execute(java.lang.String sql)
Executes an SQL statement that may return multiple results. |
int[] |
executeBatch()
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. |
java.sql.ResultSet |
executeQuery(java.lang.String sql)
Executes an SQL statement that returns a single ResultSet object. |
int |
executeUpdate(java.lang.String sql)
Executes an SQL INSERT , UPDATE or
DELETE statement. |
protected void |
finalize()
|
void |
forgetResultSet()
|
java.sql.Connection |
getConnection()
Returns the Connection object that produced this
Statement object. |
java.sql.ResultSet |
getCurrentResultSet()
Get current result set. |
int |
getDeletedRowsCount()
Get number of deleted rows. |
int |
getFetchDirection()
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object. |
int |
getFetchSize()
Retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object. |
int |
getInsertedRowsCount()
Get number of inserted rows. |
java.lang.String |
getLastExecutionPlan()
Get execution plan for the last executed statement. |
int |
getMaxFieldSize()
Returns the maximum number of bytes allowed for any column value. |
int |
getMaxRows()
Retrieves the maximum number of rows that a ResultSet object can contain. |
boolean |
getMoreResults()
Moves to a Statement object's next result. |
boolean |
getMoreResults(int mode)
|
int |
getQueryTimeout()
Retrieves the number of seconds the driver will wait for a Statement object to execute. |
java.sql.ResultSet |
getResultSet()
Returns the current result as a ResultSet object. |
java.sql.ResultSet |
getResultSet(boolean trimStrings)
|
int |
getResultSetConcurrency()
Retrieves the result set concurrency for ResultSet objects
generated by this Statement object. |
int |
getResultSetHoldability()
Retrieves the result set holdability for ResultSet objects
generated by this Statement object. |
int |
getResultSetType()
Retrieves the result set type for ResultSet objects
generated by this Statement object. |
java.lang.Object |
getSynchronizationObject()
Get synchronization object for this statement object. |
int |
getUpdateCount()
Returns the current result as an update count; if the result is a ResultSet object or there are no more results, -1
is returned. |
int |
getUpdatedRowsCount()
Get number of updated rows. |
java.sql.SQLWarning |
getWarnings()
Retrieves the first warning reported by calls on this Statement object. |
boolean |
hasOpenResultSet()
Check if this statement has open result set. |
protected boolean |
internalExecute(java.lang.String sql)
|
boolean |
isClosed()
Check if this statement was closed. |
protected boolean |
isExecuteProcedureStatement(org.firebirdsql.gds.impl.AbstractIscStmtHandle handle)
This method checks if supplied statement is executing procedure or it is generic statement. |
boolean |
isValid()
Check if this statement is valid. |
protected java.lang.String |
nativeSQL(java.lang.String sql)
|
protected void |
notifyStatementCompleted()
|
protected void |
notifyStatementCompleted(boolean success)
|
protected void |
notifyStatementStarted()
|
protected void |
notifyStatementStarted(boolean closeResultSet)
|
protected void |
prepareFixedStatement(java.lang.String sql,
boolean describeBind)
|
void |
setCursorName(java.lang.String name)
Defines the SQL cursor name that will be used by subsequent Statement object execute methods. |
void |
setEscapeProcessing(boolean enable)
Sets escape processing on or off. |
void |
setFetchDirection(int direction)
Gives the driver a hint as to the direction in which the rows in a result set will be processed. |
void |
setFetchSize(int rows)
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. |
void |
setMaxFieldSize(int max)
Sets the limit for the maximum number of bytes in a column to the given number of bytes. |
void |
setMaxRows(int max)
Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number. |
void |
setQueryTimeout(int seconds)
Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. |
protected int[] |
toArray(java.util.Collection list)
Convert collection of Integer elements into array of int. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.sql.Statement |
---|
execute, execute, execute, executeUpdate, executeUpdate, executeUpdate, getGeneratedKeys, isPoolable, setPoolable |
Methods inherited from interface java.sql.Wrapper |
---|
isWrapperFor, unwrap |
Field Detail |
---|
protected org.firebirdsql.gds.impl.GDSHelper gdsHelper
protected FBObjectListener.StatementListener statementListener
protected org.firebirdsql.gds.impl.AbstractIscStmtHandle fixedStmt
protected boolean completed
protected java.sql.SQLWarning firstWarning
protected boolean isResultSet
protected boolean hasMoreResults
protected int maxRows
protected int fetchSize
Constructor Detail |
---|
protected AbstractStatement(org.firebirdsql.gds.impl.GDSHelper c, int rsType, int rsConcurrency, int rsHoldability, FBObjectListener.StatementListener statementListener) throws java.sql.SQLException
java.sql.SQLException
Method Detail |
---|
public boolean isValid()
FirebirdStatement
isValid
in interface FirebirdStatement
true
if statement is valid and can be used to
execute SQL.public java.lang.Object getSynchronizationObject() throws java.sql.SQLException
getSynchronizationObject
in interface Synchronizable
java.sql.SQLException
- if something went wrong.protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
public void completeStatement() throws java.sql.SQLException
java.sql.SQLException
public java.sql.ResultSet executeQuery(java.lang.String sql) throws java.sql.SQLException
ResultSet
object.
executeQuery
in interface java.sql.Statement
sql
- typically this is a static SQL SELECT
statement
ResultSet
object that contains the data produced by the
given query; never null
java.sql.SQLException
- if a database access error occursprotected void notifyStatementStarted() throws java.sql.SQLException
java.sql.SQLException
protected void notifyStatementStarted(boolean closeResultSet) throws java.sql.SQLException
java.sql.SQLException
protected void notifyStatementCompleted() throws java.sql.SQLException
java.sql.SQLException
protected void notifyStatementCompleted(boolean success) throws java.sql.SQLException
java.sql.SQLException
public int executeUpdate(java.lang.String sql) throws java.sql.SQLException
INSERT
, UPDATE
or
DELETE
statement. In addition,
SQL statements that return nothing, such as SQL DDL statements,
can be executed.
executeUpdate
in interface java.sql.Statement
sql
- an SQL INSERT
, UPDATE
or
DELETE
statement or an SQL statement that returns nothing
INSERT
, UPDATE
or DELETE
statements, or 0 for SQL statements that return nothing
java.sql.SQLException
- if a database access error occurspublic void close() throws java.sql.SQLException
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.
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.
close
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic boolean isClosed()
close()
in our cleanup code.
isClosed
in interface java.sql.Statement
true
if this statement was already closed.public int getMaxFieldSize() throws java.sql.SQLException
BINARY
,
VARBINARY
, LONGVARBINARY
, CHAR
, VARCHAR
, and LONGVARCHAR
columns. If the limit is exceeded, the excess data is silently
discarded.
getMaxFieldSize
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic void setMaxFieldSize(int max) throws java.sql.SQLException
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.
setMaxFieldSize
in interface java.sql.Statement
max
- the new max column size limit; zero means unlimited
java.sql.SQLException
- if a database access error occurspublic int getMaxRows() throws java.sql.SQLException
ResultSet
object can contain. If the limit is exceeded, the excess
rows are silently dropped.
getMaxRows
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic void setMaxRows(int max) throws java.sql.SQLException
ResultSet
object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
setMaxRows
in interface java.sql.Statement
max
- the new max rows limit; zero means unlimited
java.sql.SQLException
- if a database access error occurspublic void setEscapeProcessing(boolean enable) throws java.sql.SQLException
setEscapeProcessing
in interface java.sql.Statement
enable
- true
to enable; false
to disable
java.sql.SQLException
- if a database access error occurspublic int getQueryTimeout() throws java.sql.SQLException
Statement
object to execute. If the limit is exceeded, a
SQLException
is thrown.
getQueryTimeout
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic void setQueryTimeout(int seconds) throws java.sql.SQLException
Statement
object to execute to the given number of seconds.
If the limit is exceeded, an SQLException
is thrown.
setQueryTimeout
in interface java.sql.Statement
seconds
- the new query timeout limit in seconds; zero means
unlimited
java.sql.SQLException
- if a database access error occurspublic void cancel() throws java.sql.SQLException
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.
cancel
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic java.sql.SQLWarning getWarnings() throws java.sql.SQLException
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.
getWarnings
in interface java.sql.Statement
SQLWarning
object or null
java.sql.SQLException
- if a database access error occurspublic void clearWarnings() throws java.sql.SQLException
Statement
object. After a call to this method,
the method getWarnings
will return
null
until a new warning is reported for this
Statement
object.
clearWarnings
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic void setCursorName(java.lang.String name) throws java.sql.SQLException
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.
setCursorName
in interface java.sql.Statement
name
- the new cursor name, which must be unique within
a connection
java.sql.SQLException
- if a database access error occurspublic boolean execute(java.lang.String sql) throws java.sql.SQLException
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).
execute
in interface java.sql.Statement
sql
- any SQL statement
true
if the next result is a ResultSet
object;
false
if it is an update count or there are no more results
java.sql.SQLException
- if a database access error occursgetResultSet()
,
getUpdateCount()
,
getMoreResults()
public java.sql.ResultSet getResultSet() throws java.sql.SQLException
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.
getResultSet
in interface java.sql.Statement
ResultSet
object;
null
if the result is an update count or there are no more results
java.sql.SQLException
- if a database access error occursexecute(java.lang.String)
public java.sql.ResultSet getResultSet(boolean trimStrings) throws java.sql.SQLException
java.sql.SQLException
public boolean hasOpenResultSet()
FirebirdStatement
false
because from the statement's point of view
result set is not open (in auto-commit mode complete result set is fetched
and cached in wrapping object before returning from the
Statement.getResultSet()
method).
hasOpenResultSet
in interface FirebirdStatement
true
if there's already open result set associated
with this statement, otherwise false
.public int getUpdateCount() throws java.sql.SQLException
ResultSet
object or there are no more results, -1
is returned. This method should be called only once per result.
getUpdateCount
in interface java.sql.Statement
ResultSet
object or there are no more results
java.sql.SQLException
- if a database access error occursexecute(java.lang.String)
public int getDeletedRowsCount() throws java.sql.SQLException
FirebirdStatement
getDeletedRowsCount
in interface FirebirdStatement
java.sql.SQLException
- if database error occurs.public int getInsertedRowsCount() throws java.sql.SQLException
FirebirdStatement
getInsertedRowsCount
in interface FirebirdStatement
java.sql.SQLException
- if database error occurs.public int getUpdatedRowsCount() throws java.sql.SQLException
FirebirdStatement
getUpdatedRowsCount
in interface FirebirdStatement
java.sql.SQLException
- if database error occurs.public boolean getMoreResults() throws java.sql.SQLException
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)
getMoreResults
in interface java.sql.Statement
true
if the next result is a ResultSet
object;
false
if it is an update count or there are no more results
java.sql.SQLException
- if a database access error occursexecute(java.lang.String)
public boolean getMoreResults(int mode) throws java.sql.SQLException
getMoreResults
in interface java.sql.Statement
java.sql.SQLException
public void setFetchDirection(int direction) throws java.sql.SQLException
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.
setFetchDirection
in interface java.sql.Statement
direction
- the initial direction for processing rows
java.sql.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
public int getFetchDirection() throws java.sql.SQLException
Statement
object.
If this Statement
object has not set
a fetch direction by calling the method setFetchDirection
,
the return value is implementation-specific.
getFetchDirection
in interface java.sql.Statement
Statement
object
java.sql.SQLException
- if a database access error occurspublic void setFetchSize(int rows) throws java.sql.SQLException
setFetchSize
in interface java.sql.Statement
rows
- the number of rows to fetch
java.sql.SQLException
- if a database access error occurs, or the
condition 0 <= rows <= this.getMaxRows() is not satisfied.public int getFetchSize() throws java.sql.SQLException
Statement
object.
If this Statement
object has not set
a fetch size by calling the method setFetchSize
,
the return value is implementation-specific.
getFetchSize
in interface java.sql.Statement
Statement
object
java.sql.SQLException
- if a database access error occurspublic int getResultSetConcurrency() throws java.sql.SQLException
ResultSet
objects
generated by this Statement
object.
getResultSetConcurrency
in interface java.sql.Statement
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
java.sql.SQLException
public int getResultSetType() throws java.sql.SQLException
ResultSet
objects
generated by this Statement
object.
getResultSetType
in interface java.sql.Statement
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
java.sql.SQLException
public int getResultSetHoldability() throws java.sql.SQLException
ResultSet
objects
generated by this Statement
object.
getResultSetHoldability
in interface java.sql.Statement
FirebirdResultSet.HOLD_CURSORS_OVER_COMMIT
or
FirebirdResultSet.CLOSE_CURSORS_AT_COMMIT
java.sql.SQLException
- if a database access error occurspublic void addBatch(java.lang.String sql) throws java.sql.SQLException
Statement
object. This method is optional.
addBatch
in interface java.sql.Statement
sql
- typically this is a static SQL INSERT
or
UPDATE
statement
java.sql.SQLException
- if a database access error occurs, or the
driver does not support batch statementspublic void clearBatch() throws java.sql.SQLException
clearBatch
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or the
driver does not support batch statementspublic int[] executeBatch() throws java.sql.SQLException
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:
-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:
-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.
executeBatch
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or the
driver does not support batch statements. Throws 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.protected int[] toArray(java.util.Collection list)
Integer
elements into array of int.
list
- collection of integer elements.
public java.sql.Connection getConnection() throws java.sql.SQLException
Connection
object that produced this
Statement
object.
getConnection
in interface java.sql.Statement
java.sql.SQLException
public void forgetResultSet()
public java.sql.ResultSet getCurrentResultSet() throws java.sql.SQLException
FirebirdStatement
Statement.getResultSet()
, except that this method
can be called as much as you like.
getCurrentResultSet
in interface FirebirdStatement
ResultSet
representing current result set
or null
if it is not available.
java.sql.SQLException
- if database access error happened.protected boolean isExecuteProcedureStatement(org.firebirdsql.gds.impl.AbstractIscStmtHandle handle) throws java.sql.SQLException
sql
- SQL statement to check
true
if supplied statement is EXECUTE PROCEDURE
type of statement.
java.sql.SQLException
- if translating statement into native code failed.protected boolean internalExecute(java.lang.String sql) throws GDSException, java.sql.SQLException
GDSException
java.sql.SQLException
protected void prepareFixedStatement(java.lang.String sql, boolean describeBind) throws GDSException, java.sql.SQLException
GDSException
java.sql.SQLException
protected void addWarning(java.sql.SQLWarning warning)
protected java.lang.String nativeSQL(java.lang.String sql) throws java.sql.SQLException
java.sql.SQLException
public java.lang.String getLastExecutionPlan() throws java.sql.SQLException
FirebirdStatement
FirebirdPreparedStatement.getExecutionPlan()
, this method can be
called only after executing a query or update statement.
getLastExecutionPlan
in interface FirebirdStatement
java.sql.SQLException
- if no statement was executed before calling this
method, statement is not valid, or there was an error when obtaining
the execution plan.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |