public abstract class StatementWrapper extends Object implements Statement, StatementLeakListener
Modifier and Type | Field and Description |
---|---|
protected static Logger |
_logger |
protected Connection |
connection |
protected MethodExecutor |
executor |
protected Statement |
jdbcStatement |
protected StatementLeakDetector |
leakDetector |
protected AtomicInteger |
resultSetCount |
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
Constructor and Description |
---|
StatementWrapper(Connection con,
Statement statement)
Abstract class for wrapping Statement
|
Modifier and Type | Method and Description |
---|---|
void |
actualCloseOnCompletion() |
void |
addBatch(String sql)
Adds the given SQL command to the current list of commmands for this
Statement object. |
void |
cancel()
Cancels this
Statement object if both the DBMS and
driver support aborting an SQL statement. |
void |
clearBatch()
Empties this
Statement object's current list of
SQL commands. |
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 |
closeOnCompletion() |
void |
decrementResultSetCount() |
boolean |
execute(String sql)
Executes the given SQL statement, which may return multiple results.
|
boolean |
execute(String sql,
int autoGeneratedKeys)
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.
|
boolean |
execute(String sql,
int[] columnIndexes)
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.
|
boolean |
execute(String sql,
String[] columnNames)
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.
|
int[] |
executeBatch()
Submits a batch of commands to the database for execution and
if all commands execute successfully, returns an array of update counts.
|
int |
executeUpdate(String sql)
Executes the given SQL statement, which may be an
INSERT ,
UPDATE , or DELETE statement or an
SQL statement that returns nothing, such as an SQL DDL statement. |
int |
executeUpdate(String sql,
int autoGeneratedKeys)
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. |
int |
executeUpdate(String sql,
int[] columnIndexes)
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.
|
int |
executeUpdate(String sql,
String[] columnNames)
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.
|
Connection |
getActualConnection()
Returns the underlying physical connection.
|
boolean |
getCloseOnCompletion() |
Connection |
getConnection()
Retrieves the
Connection object
that produced this Statement object. |
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
ResultSet objects
generated from this Statement object. |
int |
getMaxFieldSize()
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. |
int |
getMaxRows()
Retrieves the maximum number of rows that a
ResultSet object produced by this
Statement object can contain. |
boolean |
getMoreResults()
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 . |
boolean |
getMoreResults(int current)
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. |
int |
getQueryTimeout()
Retrieves the number of seconds the driver will
wait for a
Statement object to execute. |
int |
getResultSetConcurrency()
Retrieves the result set concurrency for
ResultSet objects
generated by this Statement object. |
int |
getResultSetCount() |
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. |
int |
getUpdateCount()
Retrieves the current result as an update count;
if the result is a
ResultSet object or there are no more results, -1
is returned. |
SQLWarning |
getWarnings()
Retrieves the first warning reported by calls on this
Statement object. |
void |
incrementResultSetCount() |
boolean |
isCloseOnCompletion() |
boolean |
isMarkedForReclaim() |
void |
markForReclaim(boolean reclaimStatus) |
void |
reclaimStatement()
Reclaim the leaked statement
|
void |
setCursorName(String name)
Sets the SQL cursor name to the given
String , which
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
rows will be processed in
ResultSet
objects created using this Statement object. |
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
ResultSet
column storing character or binary values 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. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getResultSet, isClosed, isPoolable, setLargeMaxRows, setPoolable
isWrapperFor, unwrap
protected Connection connection
protected Statement jdbcStatement
protected StatementLeakDetector leakDetector
protected static final Logger _logger
protected MethodExecutor executor
protected AtomicInteger resultSetCount
public StatementWrapper(Connection con, Statement statement)
con
- ConnectionWrapper statement
- Statement that is to be wrappedpublic int executeUpdate(String sql) throws SQLException
INSERT
,
UPDATE
, or DELETE
statement or an
SQL statement that returns nothing, such as an SQL DDL statement.executeUpdate
in interface Statement
sql
- an SQL INSERT
, UPDATE
or
DELETE
statement or an SQL statement that returns nothingINSERT
, UPDATE
or DELETE
statements, or 0
for SQL statements
that return nothingSQLException
- if a database access error occurs or the given
SQL statement produces a ResultSet
objectpublic void close() throws 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.
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.close
in interface AutoCloseable
close
in interface Statement
SQLException
- if a database access error occurspublic int getMaxFieldSize() throws SQLException
ResultSet
object produced by this Statement
object.
This limit applies only to BINARY
,
VARBINARY
, LONGVARBINARY
, CHAR
,
VARCHAR
, and LONGVARCHAR
columns. If the limit is exceeded, the excess data is silently
discarded.getMaxFieldSize
in interface Statement
SQLException
- if a database access error occurssetMaxFieldSize(int)
public void setMaxFieldSize(int max) throws SQLException
ResultSet
column storing character or binary values to
the given number of bytes. 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.setMaxFieldSize
in interface Statement
max
- the new column size limit in bytes; zero means there is no limitSQLException
- if a database access error occurs
or the condition max >= 0 is not satisfiedgetMaxFieldSize()
public int getMaxRows() throws SQLException
ResultSet
object produced by this
Statement
object can contain. If this limit is exceeded,
the excess rows are silently dropped.getMaxRows
in interface Statement
ResultSet
object produced by this Statement
object;
zero means there is no limitSQLException
- if a database access error occurssetMaxRows(int)
public void setMaxRows(int max) throws SQLException
ResultSet
object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.setMaxRows
in interface Statement
max
- the new max rows limit; zero means there is no limitSQLException
- if a database access error occurs
or the condition max >= 0 is not satisfiedgetMaxRows()
public void setEscapeProcessing(boolean enable) throws SQLException
PreparedStatements
objects will have no effect.setEscapeProcessing
in interface Statement
enable
- true
to enable escape processing;
false
to disable itSQLException
- if a database access error occurspublic int getQueryTimeout() throws SQLException
Statement
object to execute. If the limit is exceeded, a
SQLException
is thrown.getQueryTimeout
in interface Statement
SQLException
- if a database access error occurssetQueryTimeout(int)
public void setQueryTimeout(int seconds) throws SQLException
Statement
object to execute to the given number of seconds.
If the limit is exceeded, an SQLException
is thrown.setQueryTimeout
in interface Statement
seconds
- the new query timeout limit in seconds; zero means
there is no limitSQLException
- if a database access error occurs
or the condition seconds >= 0 is not satisfiedgetQueryTimeout()
public void cancel() throws 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 Statement
SQLException
- if a database access error occurspublic SQLWarning getWarnings() throws 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. 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.
getWarnings
in interface Statement
SQLWarning
object or null
if there are no warningsSQLException
- if a database access error occurs or this
method is called on a closed statementpublic void clearWarnings() throws 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 Statement
SQLException
- if a database access error occurspublic void setCursorName(String name) throws SQLException
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.
setCursorName
in interface Statement
name
- the new cursor name, which must be unique within
a connectionSQLException
- if a database access error occurspublic boolean execute(String sql) throws SQLException
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).execute
in interface Statement
sql
- any SQL statementtrue
if the first result is a ResultSet
object; false
if it is an update count or there are
no resultsSQLException
- if a database access error occursStatement.getResultSet()
,
getUpdateCount()
,
getMoreResults()
public int getUpdateCount() throws SQLException
ResultSet
object or there are no more results, -1
is returned. This method should be called only once per result.getUpdateCount
in interface Statement
ResultSet
object or there are no more resultsSQLException
- if a database access error occursexecute(java.lang.String)
public boolean getMoreResults() throws SQLException
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:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
getMoreResults
in interface Statement
true
if the next result is a ResultSet
object; false
if it is an update count or there are
no more resultsSQLException
- if a database access error occursexecute(java.lang.String)
public void setFetchDirection(int direction) throws SQLException
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.setFetchDirection
in interface Statement
direction
- the initial direction for processing rowsSQLException
- if a database access error occurs
or the given direction
is not one of ResultSet.FETCH_FORWARD
,
ResultSet.FETCH_REVERSE
, or ResultSet.FETCH_UNKNOWN
getFetchDirection()
public int getFetchDirection() throws 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 Statement
Statement
objectSQLException
- if a database access error occurssetFetchDirection(int)
public void setFetchSize(int rows) throws SQLException
setFetchSize
in interface Statement
rows
- the number of rows to fetchSQLException
- if a database access error occurs, or the
condition 0 <= rows
<= this.getMaxRows()
is not satisfied.getFetchSize()
public int getFetchSize() throws SQLException
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.getFetchSize
in interface Statement
Statement
objectSQLException
- if a database access error occurssetFetchSize(int)
public int getResultSetConcurrency() throws SQLException
ResultSet
objects
generated by this Statement
object.getResultSetConcurrency
in interface Statement
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
SQLException
- if a database access error occurspublic int getResultSetType() throws SQLException
ResultSet
objects
generated by this Statement
object.getResultSetType
in interface Statement
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
SQLException
- if a database access error occurspublic void addBatch(String sql) throws SQLException
Statement
object. The commands in this list can be
executed as a batch by calling the method executeBatch
.
NOTE: This method is optional.addBatch
in interface Statement
sql
- typically this is a static SQL INSERT
or
UPDATE
statementSQLException
- if a database access error occurs, or the
driver does not support batch updatesexecuteBatch()
public void clearBatch() throws SQLException
Statement
object's current list of
SQL commands.
NOTE: This method is optional.clearBatch
in interface Statement
SQLException
- if a database access error occurs or the
driver does not support batch updatesaddBatch(java.lang.String)
public int[] executeBatch() throws 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:
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:
EXECUTE_FAILED
-- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails
BatchUpdateException
obejct has been thrown.executeBatch
in interface Statement
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.public Connection getConnection() throws SQLException
Connection
object
that produced this Statement
object.getConnection
in interface Statement
SQLException
- if a database access error occurspublic Connection getActualConnection() throws SQLException
SQLException
public boolean getMoreResults(int current) throws SQLException
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:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
getMoreResults
in interface Statement
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
true
if the next result is a ResultSet
object; false
if it is an update count or there are no
more resultsSQLException
- if a database access error occurs or the argument
supplied is not one of the following:
Statement.CLOSE_CURRENT_RESULT
,
Statement.KEEP_CURRENT_RESULT
, or
Statement.CLOSE_ALL_RESULTS
execute(java.lang.String)
public int executeUpdate(String sql, int autoGeneratedKeys) throws SQLException
Statement
object
should be made available for retrieval.executeUpdate
in interface Statement
sql
- must be an SQL INSERT
, UPDATE
or
DELETE
statement or an SQL statement that
returns nothingautoGeneratedKeys
- 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
INSERT
, UPDATE
or DELETE
statements, or 0
for SQL
statements that return nothingSQLException
- if a database access error occurs, the given
SQL statement returns a ResultSet
object, or
the given constant is not one of those allowedpublic int executeUpdate(String sql, int[] columnIndexes) throws SQLException
INSERT
statement.executeUpdate
in interface Statement
sql
- an SQL INSERT
, UPDATE
or
DELETE
statement or an SQL statement that returns nothing,
such as an SQL DDL statementcolumnIndexes
- an array of column indexes indicating the columns
that should be returned from the inserted rowINSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothingSQLException
- if a database access error occurs, 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 indexespublic int executeUpdate(String sql, String[] columnNames) throws SQLException
INSERT
statement.executeUpdate
in interface Statement
sql
- an SQL INSERT
, UPDATE
or
DELETE
statement or an SQL statement that returns nothingcolumnNames
- an array of the names of the columns that should be
returned from the inserted rowINSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothingSQLException
- if a database access error occurs, 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 namespublic boolean execute(String sql, int autoGeneratedKeys) throws SQLException
INSERT
statement.
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).execute
in interface Statement
sql
- any SQL statementautoGeneratedKeys
- 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
true
if the first result is a ResultSet
object; false
if it is an update count or there are
no resultsSQLException
- if a database access error occurs or the second
parameter supplied to this method is not
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
.Statement.getResultSet()
,
getUpdateCount()
,
getMoreResults()
,
Statement.getGeneratedKeys()
public boolean execute(String sql, int[] columnIndexes) throws SQLException
INSERT
statement.
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).execute
in interface Statement
sql
- any SQL statementcolumnIndexes
- 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
true
if the first result is a ResultSet
object; false
if it is an update count or there
are no resultsSQLException
- if a database access error occurs or the
elements in the int
array passed to this method
are not valid column indexesStatement.getResultSet()
,
getUpdateCount()
,
getMoreResults()
public boolean execute(String sql, String[] columnNames) throws SQLException
INSERT
statement.
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).execute
in interface Statement
sql
- any SQL statementcolumnNames
- 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
true
if the next result is a ResultSet
object; false
if it is an update count or there
are no more resultsSQLException
- if a database access error occurs or the
elements of the String
array passed to this
method are not valid column namesStatement.getResultSet()
,
getUpdateCount()
,
getMoreResults()
,
Statement.getGeneratedKeys()
public int getResultSetHoldability() throws SQLException
ResultSet
objects
generated by this Statement
object.getResultSetHoldability
in interface Statement
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access error occurspublic void reclaimStatement() throws SQLException
StatementLeakListener
reclaimStatement
in interface StatementLeakListener
SQLException
public void markForReclaim(boolean reclaimStatus)
public boolean isMarkedForReclaim()
public void closeOnCompletion() throws SQLException
closeOnCompletion
in interface Statement
SQLException
public void actualCloseOnCompletion() throws SQLException
SQLException
public boolean isCloseOnCompletion() throws SQLException
isCloseOnCompletion
in interface Statement
SQLException
public boolean getCloseOnCompletion()
public void incrementResultSetCount()
public void decrementResultSetCount()
public int getResultSetCount()
Copyright © 2018. All rights reserved.