|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.sapjcosupport.jdbc.SapQLStatement
Created by IntelliJ IDEA. User: NDE1677 Date: Jul 5, 2006 Time: 12:40:14 PM To change this template use File | Settings | File Templates.
Field Summary |
Fields inherited from interface java.sql.Statement |
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
Constructor Summary | |
SapQLStatement(SapConnection connection)
|
Method Summary | |
void |
addBatch(String sql)
Adds an SQL command to the current batch of commmands for this SapQLStatement object. |
void |
cancel()
Cancels this SapQLStatement 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 SapQLStatement
object. |
void |
close()
Releases this SapQLStatement object's database
and JDBC resources immediately instead of waiting for
this to happen when it is automatically closed.
|
boolean |
execute(String sql)
Executes an SQL statement that 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. |
ResultSet |
executeQuery(String sql)
Executes an SQL statement that returns a single ResultSet object. |
int |
executeUpdate(String sql)
Executes an SQL INSERT , UPDATE or
DELETE 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 |
getConnection()
Returns the SapConnection object
that produced this SapQLStatement object. |
int |
getFetchDirection()
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this SapQLStatement object.
|
int |
getFetchSize()
Retrieves the number of result set rows that is the default fetch size for result sets generated from this SapQLStatement object.
|
ResultSet |
getGeneratedKeys()
Retrieves any auto-generated keys created as a result of executing this Statement object. |
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 SapQLStatement object's next result. |
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 SapQLStatement object to execute. |
ResultSet |
getResultSet()
Returns the current result as a ResultSet object.
|
int |
getResultSetConcurrency()
Retrieves the result set concurrency for ResultSet objects
generated by this SapQLStatement 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 SapQLStatement 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. |
SQLWarning |
getWarnings()
Retrieves the first warning reported by calls on this SapQLStatement object.
|
void |
setCursorName(String name)
Defines the SQL cursor name that will be used by subsequent SapQLStatement 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 SapQLStatement object to execute to the given number of seconds.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SapQLStatement(SapConnection connection)
Method Detail |
public ResultSet executeQuery(String sql) throws SQLException
ResultSet
object.
executeQuery
in interface Statement
sql
- typically this is a static SQL SELECT
statement
ResultSet
object that contains the data produced by the
given query; never null
SQLException
- if a database access error occurspublic int executeUpdate(String sql) throws SQLException
INSERT
, UPDATE
or
DELETE
statement. In addition,
SQL statements that return nothing, such as SQL DDL statements,
can be executed.
executeUpdate
in interface 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
SQLException
- if a database access error occurspublic void close() throws SQLException
SapQLStatement
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 SapQLStatement
object is automatically closed when it is
garbage collected. When a SapQLStatement
object is closed, its current
ResultSet
object, if one exists, is also closed.
close
in interface Statement
SQLException
- if a database access error occurspublic int getMaxFieldSize() throws SQLException
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 occurspublic void setMaxFieldSize(int max) throws 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 Statement
max
- the new max column size limit; zero means unlimited
SQLException
- if a database access error occurspublic int getMaxRows() throws SQLException
ResultSet
object can contain. If the limit is exceeded, the excess
rows are silently dropped.
getMaxRows
in interface Statement
SQLException
- if a database access error occurspublic 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 unlimited
SQLException
- if a database access error occurspublic void setEscapeProcessing(boolean enable) throws SQLException
Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing for prepared statements will have no effect.
setEscapeProcessing
in interface Statement
enable
- true
to enable; false
to disable
SQLException
- if a database access error occurspublic int getQueryTimeout() throws SQLException
SapQLStatement
object to execute. If the limit is exceeded, a
SQLException
is thrown.
getQueryTimeout
in interface Statement
SQLException
- if a database access error occurspublic void setQueryTimeout(int seconds) throws SQLException
SapQLStatement
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
unlimited
SQLException
- if a database access error occurspublic void cancel() throws SQLException
SapQLStatement
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
SapQLStatement
object.
Subsequent SapQLStatement
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 Statement
SQLWarning
object or null
SQLException
- if a database access error occurspublic void clearWarnings() throws SQLException
SapQLStatement
object. After a call to this method,
the method getWarnings
will return
null
until a new warning is reported for this
SapQLStatement
object.
clearWarnings
in interface Statement
SQLException
- if a database access error occurspublic void setCursorName(String name) throws SQLException
SapQLStatement
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 SapQLStatement
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 Statement
name
- the new cursor name, which must be unique within
a connection
SQLException
- if a database access error occurspublic boolean execute(String sql) throws 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 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
SQLException
- if a database access error occursgetResultSet()
,
getUpdateCount()
,
getMoreResults()
public ResultSet getResultSet() throws SQLException
ResultSet
object.
This method should be called only once per result.
getResultSet
in interface Statement
ResultSet
object;
null
if the result is an update count or there are no more results
SQLException
- if a database access error occursexecute(java.lang.String)
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 results
SQLException
- if a database access error occursexecute(java.lang.String)
public boolean getMoreResults() throws SQLException
SapQLStatement
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 Statement
true
if the next result is a ResultSet
object;
false
if it is an update count or there are no more results
SQLException
- if a database access error occursexecute(java.lang.String)
public void setFetchDirection(int direction) throws SQLException
SapQLStatement
object. The default value is
ResultSet.FETCH_FORWARD
.
Note that this method sets the default fetch direction for
result sets generated by this SapQLStatement
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 rows
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 SQLException
SapQLStatement
object.
If this SapQLStatement
object has not set
a fetch direction by calling the method setFetchDirection
,
the return value is implementation-specific.
getFetchDirection
in interface Statement
SapQLStatement
object
SQLException
- if a database access error occurspublic void setFetchSize(int rows) throws SQLException
setFetchSize
in interface Statement
rows
- the number of rows to fetch
SQLException
- if a database access error occurs, or the
condition 0 <= rows <= this.getMaxRows() is not satisfied.public int getFetchSize() throws SQLException
SapQLStatement
object.
If this SapQLStatement
object has not set
a fetch size by calling the method setFetchSize
,
the return value is implementation-specific.
getFetchSize
in interface Statement
SapQLStatement
object
SQLException
- if a database access error occurspublic int getResultSetConcurrency() throws SQLException
ResultSet
objects
generated by this SapQLStatement
object.
getResultSetConcurrency
in interface Statement
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
SQLException
public int getResultSetType() throws SQLException
ResultSet
objects
generated by this SapQLStatement
object.
getResultSetType
in interface Statement
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
SQLException
public void addBatch(String sql) throws SQLException
SapQLStatement
object. This method is optional.
addBatch
in interface Statement
sql
- typically this is a static SQL INSERT
or
UPDATE
statement
SQLException
- if a database access error occurs, or the
driver does not support batch statementspublic void clearBatch() throws SQLException
clearBatch
in interface Statement
SQLException
- if a database access error occurs or the
driver does not support batch statementspublic 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:
-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 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
SapConnection
object
that produced this SapQLStatement
object.
getConnection
in interface Statement
SQLException
- if a database access error occurspublic 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 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 results
SQLException
- 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 nothing
SQLException
- if a database access error occurs, the given
SQL statement returns a ResultSet
object, or
the given constant is not one of those allowedpublic 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 results
SQLException
- 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
.getResultSet()
,
getUpdateCount()
,
getMoreResults()
,
getGeneratedKeys()
public 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 row
INSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothing
SQLException
- 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 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 results
SQLException
- if a database access error occurs or the
elements in the int
array passed to this method
are not valid column indexesgetResultSet()
,
getUpdateCount()
,
getMoreResults()
public ResultSet getGeneratedKeys() throws SQLException
Statement
object. If this Statement
object did
not generate any keys, an empty ResultSet
object is returned.
getGeneratedKeys
in interface Statement
ResultSet
object containing the auto-generated key(s)
generated by the execution of this Statement
object
SQLException
- if a database access error occurspublic 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 row
INSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothing
SQLException
- 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, 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 results
SQLException
- if a database access error occurs or the
elements of the String
array passed to this
method are not valid column namesgetResultSet()
,
getUpdateCount()
,
getMoreResults()
,
getGeneratedKeys()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |