Java Doc for DbStatement.java in  » Web-Framework » rife-1.6.1 » com » uwyn » rife » database » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Framework » rife 1.6.1 » com.uwyn.rife.database 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.uwyn.rife.database.DbStatement

All known Subclasses:   com.uwyn.rife.database.DbPreparedStatement,
DbStatement
public class DbStatement implements Cloneable(Code)
Provides a wrapper around the regular JDBC Statement class. It can only be instantiated by calling the createStatement method on an existing DbConnection instance.

This class hooks into the database connection pool and cleans up as much as possible in case of errors. The thrown DatabaseException exceptions should thus only be used for error reporting and not for releasing resources used by the framework.

The execute and executeQuery methods store their result set in the executing DbStatement instance. It's recommended to use the DbQueryManager's fetch method to process the result set. If needed, one can also use the getResultSet method to manually process the results through plain JDBC. However, when exceptions are thrown during this procedure, it's also the responsability of the user to correctly clean up all resources.

Additional methods have been implemented to facilitate the retrieval of queries which return only a single field and to easily check if a query returned any result rows.
author:
   Geert Bevin (gbevin[remove] at uwyn dot com)
version:
   $Revision: 3648 $
See Also:   DbStatement.executeQuery(String)
See Also:   DbStatement.execute(String)
See Also:   DbStatement.execute(String,int)
See Also:   DbStatement.execute(String,int[])
See Also:   DbStatement.execute(String,String[])
See Also:   DbStatement.getResultSet()
See Also:   com.uwyn.rife.database.DbConnection.createStatement
See Also:   com.uwyn.rife.database.DbQueryManager.fetch(ResultSetDbRowProcessor)
See Also:   java.sql.ResultSet
See Also:   java.sql.Statement
since:
   1.0



Field Summary
final  DbConnectionmConnection
    
final  StatementmStatement
    

Constructor Summary
 DbStatement(DbConnection connection, Statement statement)
     Constructs a new DbStatement from an existing DbConnection and Statement.

Method Summary
public  voidaddBatch(String sql)
     Adds the given SQL command to the current list of commmands for this Statement object.
public  voidcancel()
     Cancels this DbStatement object if both the DBMS and driver support aborting a SQL statement.
 voidcleanResultSet()
     Cleans up and closes the current ResultSet object.
public  voidclearBatch()
     Empties this Statement object's current list of SQL commands.
public  voidclearWarnings()
     Clears all the warnings reported on this DbStatement object.
public  Objectclone()
     Simply clones the instance with the default clone method.
public  voidclose()
     Releases this DbStatement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
public  booleanexecute(String sql)
     Executes the given SQL statement, which may return multiple results.
public  booleanexecute(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.
public  booleanexecute(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.
public  booleanexecute(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.
public  int[]executeBatch()
     Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
public  voidexecuteQuery(String sql)
     Executes the given SQL statement.
public  voidexecuteQuery(ReadQuery query)
     Executes the given Query builder's SQL statement.
public  intexecuteUpdate(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.
public  intexecuteUpdate(Query query)
     Executes the given Query builder's SQL statement, which may be an INSERT, UPDATE, or DELETE statement or a SQL statement that returns nothing, such as an SQL DDL statement.
protected  voidfinalize()
     Ensures that this DbStatement is correctly closed when it's garbage collected.
public  DbConnectiongetConnection()
     Returns the DbConnection object from which this DbStatement object has been instantiated.
public  intgetFetchDirection()
     Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this DbStatement object.
public  intgetFetchSize()
     Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this DbStatement object.
public  intgetFirstGeneratedIntKey()
     Retrieves the first auto-generated key created as a result of executing this DbStatement object as an integer.
public  DbResultSetgetGeneratedKeys()
     Retrieves any auto-generated keys created as a result of executing this DbStatement object.
public  intgetMaxFieldSize()
     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.
public  intgetMaxRows()
     Retrieves the maximum number of rows that a ResultSet object produced by this DbStatement object can contain.
public  booleangetMoreResults()
     Moves to this DbStatement 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.
public  booleangetMoreResults(int current)
     Moves to this DbStatement 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.
public  intgetQueryTimeout()
     Retrieves the number of seconds the driver will wait for a DbStatement object to execute.
public  DbResultSetgetResultSet()
     Retrieves the current result as a ResultSet object.
public  intgetResultSetConcurrency()
     Retrieves the result set concurrency for ResultSet objects generated by this DbStatement object.
public  intgetResultSetHoldability()
     Retrieves the result set holdability for ResultSet objects generated by this DbStatement object.
public  intgetResultSetType()
     Retrieves the result set type for ResultSet objects generated by this DbStatement object.
public  intgetUpdateCount()
     Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.
public  SQLWarninggetWarnings()
     Retrieves the first warning reported by calls on this Statement object.
protected  voidhandleException()
     Performs the cleanup logic in case an exeception is thrown during execution.
 booleanhasResultset()
     Checks if there's a ResultSet object present.
protected  voidoutputTrace(long start, String sql)
    
public  voidsetFetchDirection(int direction)
     Gives the driver a hint as to the direction in which rows will be processed in ResultSet objects created using this DbStatement object.
public  voidsetFetchSize(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.
public  voidsetMaxFieldSize(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.
public  voidsetMaxRows(int max)
     Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number.
public  voidsetQueryTimeout(int max)
     Sets the number of seconds the driver will wait for a DbStatement object to execute to the given number of seconds.
protected  voidsetResultset(ResultSet resultSet)
     Set the current ResultSet object and cleans up the previous ResultSet object automatically.
protected  longstartTrace()
    
protected  voidtraceBatch(String sql)
    
 voidwaitForConnection()
     Waits until the DbConnection method is available for use.
public  booleanwasNull()
     Reports whether the last column read had a value of SQL NULL.

Field Detail
mConnection
final DbConnection mConnection(Code)



mStatement
final Statement mStatement(Code)




Constructor Detail
DbStatement
DbStatement(DbConnection connection, Statement statement) throws DatabaseException(Code)
Constructs a new DbStatement from an existing DbConnection and Statement. This constructor will never be called by a user of the api. The createStatement of an existing DbConnection instance should be used instead.
Parameters:
  connection - a DbConnection instance
Parameters:
  statement - a JDBC Statement instance
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




Method Detail
addBatch
public void addBatch(String sql) throws DatabaseException(Code)
Adds the given SQL command to the current list of commmands for this Statement object. The commands in this list can be executed as a batch by calling the method executeBatch.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - typically this is a static SQL INSERT orUPDATE statement
exception:
  DatabaseException - if a database access error occurs, or thedriver does not support batch updates
See Also:   DbStatement.executeBatch
since:
   1.0




cancel
public void cancel() throws DatabaseException(Code)
Cancels this DbStatement object if both the DBMS and driver support aborting a SQL statement. This method can be used by one thread to cancel a statement that is being executed by another thread.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




cleanResultSet
void cleanResultSet() throws DatabaseException(Code)
Cleans up and closes the current ResultSet object.
exception:
  DatabaseException - if a database access error occurred.
since:
   1.0



clearBatch
public void clearBatch() throws DatabaseException(Code)
Empties this Statement object's current list of SQL commands.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
exception:
  DatabaseException - if a database access error occurs or thedriver does not support batch updates
See Also:   DbStatement.addBatch
since:
   1.0




clearWarnings
public void clearWarnings() throws DatabaseException(Code)
Clears all the warnings reported on this DbStatement object. After a call to this method, the method getWarnings will return null until a new warning is reported for this DbStatement object.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




clone
public Object clone()(Code)
Simply clones the instance with the default clone method. This creates a shallow copy of all fields and the clone will in fact just be another reference to the same underlying data. The independence of each cloned instance is consciously not respected since they rely on resources that can't be cloned.
since:
   1.0



close
public void close() throws DatabaseException(Code)
Releases this DbStatement 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 DbStatement object that is already closed has no effect.

Note: A DbStatement object is automatically closed when it is garbage collected. When a DbStatement object is closed, its current ResultSet object, if one exists, is also closed.
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




execute
public boolean execute(String sql) throws DatabaseException(Code)
Executes the given SQL statement, which may return multiple results. 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 a 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).

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - any SQL statement true if the first result is aResultSet object; or

false if it is an update count or there are no results
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.getResultSet
See Also:   DbStatement.getUpdateCount
See Also:   DbStatement.getMoreResults
since:
   1.0




execute
public boolean execute(String sql, int autoGeneratedKeys) throws DatabaseException(Code)
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.

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 a 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).

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - any SQL statement
Parameters:
  autoGeneratedKeys - a constant indicating whether auto-generatedkeys should be made available for retrieval using the methodgetGeneratedKeys; one of the following constants:Statement.RETURN_GENERATED_KEYS orStatement.NO_GENERATED_KEYS true if the first result is aResultSet object; or

false if it is an update count or there are no results
exception:
  DatabaseException - if a database access error occurs
See Also:   Statement
See Also:   DbStatement.getResultSet
See Also:   DbStatement.getUpdateCount
See Also:   DbStatement.getMoreResults
See Also:   DbStatement.getGeneratedKeys
since:
   1.0




execute
public boolean execute(String sql, int[] columnIndexes) throws DatabaseException(Code)
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 given SQL statement is not an 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 a 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).

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - any SQL statement
Parameters:
  columnIndexes - an array of the indexes of the columns in theinserted row that should be made available for retrieval by a call tothe method getGeneratedKeys true if the first result is aResultSet object; or

false if it is an update count or there are no results
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.getResultSet
See Also:   DbStatement.getUpdateCount
See Also:   DbStatement.getMoreResults
since:
   1.0




execute
public boolean execute(String sql, String[] columnNames) throws DatabaseException(Code)
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 given SQL statement is not an 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 a 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).

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - any SQL statement
Parameters:
  columnNames - an array of the names of the columns in the insertedrow that should be made available for retrieval by a call to the methodgetGeneratedKeys true if the next result is aResultSet object; or

false if it is an update count or there are no moreresults
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.getResultSet
See Also:   DbStatement.getUpdateCount
See Also:   DbStatement.getMoreResults
See Also:   DbStatement.getGeneratedKeys
since:
   1.0




executeBatch
public int[] executeBatch() throws DatabaseException(Code)
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:
  1. 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
  2. A value of SUCCESS_NO_INFO -- indicates that the command was processed successfully but that the number of rows affected is unknown

    If one of the commands in a batch update fails to execute properly, this method throws a BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts will contain as many elements as there are commands in the batch, and at least one of the elements will be the following:

  3. A value of EXECUTE_FAILED -- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails

A driver is not required to implement this method.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. an array of update counts containing one element for eachcommand in the batch. The elements of the array are ordered accordingto the order in which commands were added to the batch.
exception:
  DatabaseException - if a database access error occurs or thedriver does not support batch statements. The cause is a java.sql.BatchUpdateException (a subclass of SQLException)if one of the commands sent to the database fails to execute properlyor attempts to return a result set.
since:
   1.0




executeQuery
public void executeQuery(String sql) throws DatabaseException(Code)
Executes the given SQL statement. The returned ResultSet object is stored and can be retrieved with the getResultSet method.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - a SQL statement to be sent to the database, typically astatic SQL SELECT statement
exception:
  DatabaseException - if a database access error occurs or thegiven SQL statement produces anything other than a singleResultSet object
See Also:   DbStatement.getResultSet
since:
   1.0




executeQuery
public void executeQuery(ReadQuery query) throws DatabaseException(Code)
Executes the given Query builder's SQL statement. The returned ResultSet object is stored and can be retrieved with the getResultSet method.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  query - a Query builder instance which provides a SQLstatement that queries the database
exception:
  DatabaseException - if a database access error occurs or thegiven SQL statement produces anything other than a singleResultSet object
See Also:   DbStatement.getResultSet
since:
   1.0




executeUpdate
public int executeUpdate(String sql) throws DatabaseException(Code)
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.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  sql - an SQL INSERT, UPDATE orDELETE statement or a SQL statement that returns nothing the row count for INSERT, UPDATE orDELETE statements; or

0 for SQL statements that return nothing
exception:
  DatabaseException - if a database access error occurs or thegiven SQL statement produces a ResultSet object
since:
   1.0




executeUpdate
public int executeUpdate(Query query) throws DatabaseException(Code)
Executes the given Query builder's SQL statement, which may be an INSERT, UPDATE, or DELETE statement or a SQL statement that returns nothing, such as an SQL DDL statement.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  query - a Query builder instance which provides a SQLstatement that modifies the database the row count for INSERT, UPDATE orDELETE statements; or

0 for SQL statements that return nothing
exception:
  DatabaseException - if a database access error occurs or thegiven SQL statement produces a ResultSet object
since:
   1.0




finalize
protected void finalize() throws Throwable(Code)
Ensures that this DbStatement is correctly closed when it's garbage collected.
exception:
  Throwable - if an error occurred during the finalization
since:
   1.0



getConnection
public DbConnection getConnection()(Code)
Returns the DbConnection object from which this DbStatement object has been instantiated. the instantiating DbConnection object.
since:
   1.0



getFetchDirection
public int getFetchDirection() throws DatabaseException(Code)
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this DbStatement object. If this DbStatement object has not set a fetch direction by calling the method setFetchDirection, the return value is implementation-specific.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the default fetch direction for result sets generated from thisDbStatement object
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.setFetchDirection
since:
   1.0




getFetchSize
public int getFetchSize() throws DatabaseException(Code)
Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this DbStatement object. If this DbStatement object has not set a fetch size by calling the method setFetchSize, the return value is implementation-specific.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the default fetch size for result sets generated from thisDbStatement object
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.setFetchSize
since:
   1.0




getFirstGeneratedIntKey
public int getFirstGeneratedIntKey() throws DatabaseException(Code)
Retrieves the first auto-generated key created as a result of executing this DbStatement object as an integer. If this DbStatement object did not generate any keys, a exception is thrown.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the first auto-generated key as an integer
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




getGeneratedKeys
public DbResultSet getGeneratedKeys() throws DatabaseException(Code)
Retrieves any auto-generated keys created as a result of executing this DbStatement object. If this DbStatement object did not generate any keys, an empty DbResultSet object is returned.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. a DbResultSet object containing the auto-generatedkey(s) generated by the execution of this DbStatementobject
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




getMaxFieldSize
public int getMaxFieldSize() throws DatabaseException(Code)
Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object. This limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the current column size limit for columns storing character andbinary values; or

0 if there's no limit
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.setMaxFieldSize
since:
   1.0




getMaxRows
public int getMaxRows() throws DatabaseException(Code)
Retrieves the maximum number of rows that a ResultSet object produced by this DbStatement object can contain. If this limit is exceeded, the excess rows are silently dropped.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the current maximum number of rows for a ResultSetobject produced by this Statement object; or

0 if there's no limit
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.setMaxRows
since:
   1.0




getMoreResults
public boolean getMoreResults() throws DatabaseException(Code)
Moves to this DbStatement 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:

 (!getMoreResults() && (getUpdateCount() == -1)
 

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. true if the next result is aResultSet object; or

false if it is an update count or there are no moreresults
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.execute
since:
   1.0




getMoreResults
public boolean getMoreResults(int current) throws DatabaseException(Code)
Moves to this DbStatement 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:

 (!getMoreResults() && (getUpdateCount() == -1)
 

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  current - one of the following Statement constantsindicating what should happen to current ResultSet objectsobtained using the method getResultSet:CLOSE_CURRENT_RESULT, KEEP_CURRENT_RESULT, orCLOSE_ALL_RESULTS true if the next result is aResultSet object; or

false if it is an update count or there are no moreresults
exception:
  DatabaseException - if a database access error occurs
See Also:   Statement
See Also:   DbStatement.execute
since:
   1.0




getQueryTimeout
public int getQueryTimeout() throws DatabaseException(Code)
Retrieves the number of seconds the driver will wait for a DbStatement object to execute. If the limit is exceeded, a DatabaseException is thrown.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the current query timeout limit in seconds; or

0 if there's no limit
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.setQueryTimeout
since:
   1.0




getResultSet
public DbResultSet getResultSet()(Code)
Retrieves the current result as a ResultSet object. This method returns the internally stored result and can be called as many times as wanted, contrary to the regular JDBC counterpart. the current result as a ResultSet object; or

NULL if the result is an update count.
See Also:   DbStatement.execute
since:
   1.0




getResultSetConcurrency
public int getResultSetConcurrency() throws DatabaseException(Code)
Retrieves the result set concurrency for ResultSet objects generated by this DbStatement object.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. either ResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE
exception:
  DatabaseException - if a database access error occurs
See Also:   ResultSet
since:
   1.0




getResultSetHoldability
public int getResultSetHoldability() throws DatabaseException(Code)
Retrieves the result set holdability for ResultSet objects generated by this DbStatement object.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. either ResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
exception:
  DatabaseException - if a database access error occurs
See Also:   ResultSet
since:
   1.0




getResultSetType
public int getResultSetType() throws DatabaseException(Code)
Retrieves the result set type for ResultSet objects generated by this DbStatement object.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. one of ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE
exception:
  DatabaseException - if a database access error occurs
See Also:   ResultSet
since:
   1.0




getUpdateCount
public int getUpdateCount() throws DatabaseException(Code)
Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned. This method should be called only once per result.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. the current result as an update count; or

-1 if the current result is a ResultSetobject or there are no more results
exception:
  DatabaseException - if a database access error occurs
See Also:   DbStatement.execute
since:
   1.0




getWarnings
public SQLWarning getWarnings() throws DatabaseException(Code)
Retrieves the first warning reported by calls on this Statement object. Subsequent DbStatement 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 DbStatement object; doing so will cause an SQLException to be thrown.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.

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 DbStatement object that produced it. the first SQLWarning object; or

null if there are no warnings
exception:
  DatabaseException - if a database access error occurs or thismethod is called on a closed statement
since:
   1.0




handleException
protected void handleException() throws DatabaseException(Code)
Performs the cleanup logic in case an exeception is thrown during execution. The statement will be closed and if a transaction is active, it will be automatically rolled back.
exception:
  DatabaseException - when an error occurs during the cleanup ofthe connection, or when an error occurs during the roll-back.



hasResultset
boolean hasResultset()(Code)
Checks if there's a ResultSet object present. true if a ResultSet object isavailable; or

false otherwise.
since:
   1.0




outputTrace
protected void outputTrace(long start, String sql)(Code)



setFetchDirection
public void setFetchDirection(int direction) throws DatabaseException(Code)
Gives the driver a hint as to the direction in which rows will be processed in ResultSet objects created using this DbStatement object. The default value is ResultSet.FETCH_FORWARD.

Note that this method sets the default fetch direction for result sets generated by this DbStatement object. Each result set has its own methods for getting and setting its own fetch direction.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  direction - the initial direction for processing rows
exception:
  DatabaseException - if a database access error occurs or thegiven direction is not one of ResultSet.FETCH_FORWARD,ResultSet.FETCH_REVERSE, orResultSet.FETCH_UNKNOWN
See Also:   DbStatement.getFetchDirection
See Also:   ResultSet
since:
   1.0




setFetchSize
public void setFetchSize(int rows) throws DatabaseException(Code)
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.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  rows - the number of rows to fetch
exception:
  DatabaseException - if a database access error occurs, or thecondition 0 <= rows <=this.getMaxRows() is not satisfied.
See Also:   DbStatement.getFetchSize
See Also:   DbStatement.getMaxRows
since:
   1.0




setMaxFieldSize
public void setMaxFieldSize(int max) throws DatabaseException(Code)
Sets the limit for the maximum number of bytes in a 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.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  max - the new column size limit in bytes; zero means there is nolimit
exception:
  DatabaseException - if a database access error occurs or thecondition max >= 0 is not satisfied
See Also:   DbStatement.getMaxFieldSize
since:
   1.0




setMaxRows
public void setMaxRows(int max) throws DatabaseException(Code)
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.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread.
Parameters:
  max - the new max rows limit; zero means there is no limit
exception:
  DatabaseException - if a database access error occurs or thecondition max >= 0 is not satisfied
See Also:   DbStatement.getMaxRows
since:
   1.0




setQueryTimeout
public void setQueryTimeout(int max) throws DatabaseException(Code)
Sets the number of seconds the driver will wait for a DbStatement object to execute to the given number of seconds. If the limit is exceeded, an DatabaseException is thrown.
Parameters:
  max - the new query timeout limit in seconds; zero means there isno limit
exception:
  DatabaseException - if a database access error occurs or thecondition seconds >= 0 is not satisfied
See Also:   DbStatement.getQueryTimeout
since:
   1.0



setResultset
protected void setResultset(ResultSet resultSet) throws DatabaseException(Code)
Set the current ResultSet object and cleans up the previous ResultSet object automatically.
Parameters:
  resultSet - the new current ResultSet object
exception:
  DatabaseException - if a database access error occurred.
since:
   1.0



startTrace
protected long startTrace()(Code)



traceBatch
protected void traceBatch(String sql)(Code)



waitForConnection
void waitForConnection() throws DatabaseException(Code)
Waits until the DbConnection method is available for use. This method is used by all the execution methods to effectively integrate with the connection pool.
exception:
  DatabaseException - when a database access error occurs or theconnection isn't open or has timed-out
since:
   1.0



wasNull
public boolean wasNull() throws DatabaseException(Code)
Reports whether the last column read had a value of SQL NULL. Note that you must first call one of the getter methods on a column to try to read its value and then call the method wasNull to see if the value read was SQL NULL.

If an exception is thrown, this DbStatement is automatically closed and an ongoing transaction will be automatically rolled back if it belongs to the executing thread. true if the last column value read was SQLNULL; or

false otherwise
exception:
  DatabaseException - if a database access error occurs
since:
   1.0




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.