org.objectweb.cjdbc.driver.Statement Class Reference

Inheritance diagram for org.objectweb.cjdbc.driver.Statement:

[legend]Collaboration diagram for org.objectweb.cjdbc.driver.Statement:

[legend]List of all members.

Public Member Functions
	Statement (Connection c)
void	addBatch (String sql) throws SQLException
void	cancel () throws SQLException
void	clearBatch () throws SQLException
void	clearWarnings () throws SQLException
int[]	executeBatch () throws SQLException
void	close () throws SQLException
boolean	execute (String sql) throws SQLException
java.sql.ResultSet	executeQuery (String sql) throws SQLException
int	executeUpdate (String sql) throws SQLException
java.sql.Connection	getConnection () throws SQLException
int	getFetchDirection () throws SQLException
int	getFetchSize () throws SQLException
int	getMaxFieldSize () throws SQLException
int	getMaxRows () throws SQLException
boolean	getMoreResults () throws SQLException
int	getQueryTimeout () throws SQLException
java.sql.ResultSet	getResultSet () throws SQLException
int	getResultSetConcurrency () throws SQLException
int	getResultSetType () throws SQLException
int	getUpdateCount () throws SQLException
SQLWarning	getWarnings () throws SQLException
void	setCursorName (String name) throws SQLException
void	setEscapeProcessing (boolean enable) throws SQLException
void	setFetchDirection (int direction) throws SQLException
void	setFetchSize (int rows) throws SQLException
void	setMaxFieldSize (int max) throws SQLException
void	setMaxRows (int max) throws SQLException
void	setQueryTimeout (int seconds) throws SQLException
void	setResultSetConcurrency (int value) throws SQLException
void	setResultSetType (int value) throws SQLException
boolean	getMoreResults (int current) throws SQLException
java.sql.ResultSet	getGeneratedKeys () throws SQLException
int	executeUpdate (String sql, int autoGeneratedKeys) throws SQLException
int	executeUpdate (String sql, int columnIndexes[]) throws SQLException
int	executeUpdate (String sql, String columnNames[]) throws SQLException
boolean	execute (String sql, int autoGeneratedKeys) throws SQLException
boolean	execute (String sql, int columnIndexes[]) throws SQLException
boolean	execute (String sql, String columnNames[]) throws SQLException
int	getResultSetHoldability () throws SQLException
Protected Member Functions
java.sql.ResultSet	executeQuery (String sqlSkeleton, String sqlQuery) throws SQLException
int	executeUpdateWithSkeleton (String sqlSkeleton, String sqlQuery) throws SQLException
Protected Attributes
Connection	connection = null
ResultSet	result = null
int	updateCount = -1
boolean	escapeProcessing = true
ResultSet	generatedKeys = null
int	generatedKeysFlag = java.sql.Statement.NO_GENERATED_KEYS

---

Detailed Description

A Statement object is used for executing a static SQL statement and obtaining the results produced by it.

Only one ResultSet per Statement can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by different Statements. All Statements execute methods implicitly close a statement's current ResultSet if an open one exists.

See also:

java.sql.Statement

DriverResultSet

Author:

Emmanuel Cecchet

Vadim Kassin

Jean-Bernard van Zuylen

Version:

1.0

Definition at line 62 of file org/objectweb/cjdbc/driver/Statement.java.

---

Constructor & Destructor Documentation

org.objectweb.cjdbc.driver.Statement.Statement (  Connection  c  )

Creates a new Statement instance. Parameters: c  the Connection that created us Definition at line 113 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.connection. { connection = c; }

---

Member Function Documentation

void org.objectweb.cjdbc.driver.Statement.addBatch (  String  sql  )  throws SQLException

Adds sql to the current list of commands. Parameters: sql  an SQL statement that returns an update count (INSERT or UPDATE) Exceptions: SQLException  if an error occurs Implements java.sql.Statement. Definition at line 124 of file org/objectweb/cjdbc/driver/Statement.java. { if (batch == null) batch = new Vector(); batch.addElement(sql.trim()); }

void org.objectweb.cjdbc.driver.Statement.cancel (   )  throws SQLException

Could be use by one thread to cancel a statement that is being executed by another thread. We don't support that for instance. Exceptions: SQLException  if an error occurs Implements java.sql.Statement. Definition at line 137 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("cancel()"); }

void org.objectweb.cjdbc.driver.Statement.clearBatch (   )  throws SQLException

Empties the current list of commands. Exceptions: SQLException  if an error occurs Implements java.sql.Statement. Definition at line 147 of file org/objectweb/cjdbc/driver/Statement.java. { if (batch != null) batch.removeAllElements(); }

void org.objectweb.cjdbc.driver.Statement.clearWarnings (   )  throws SQLException

After this call, getWarnings returns null until a new warning is reported for this Statement. Exceptions: SQLException  if a database access error occurs (why?) Implements java.sql.Statement. Definition at line 159 of file org/objectweb/cjdbc/driver/Statement.java. { warnings = null; }

void org.objectweb.cjdbc.driver.Statement.close (   )  throws SQLException

In many cases, it is desirable to immediately release a Statement's database and JDBC resources instead of waiting for this to happen when it is automatically closed. The close method provides this immediate release. Note: A Statement is automatically closed when it is garbage collected. When a Statement is closed, its current ResultSet, if one exists, is also closed. Exceptions: SQLException  if a database access error occurs (why?) Implements java.sql.Statement. Reimplemented in org.objectweb.cjdbc.driver.PreparedStatement. Definition at line 213 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Connection.close(), org.objectweb.cjdbc.driver.Statement.connection, and org.objectweb.cjdbc.driver.Statement.result. { // Force the ResultSet to close if (result != null) result.close(); // Disasociate it from us (For Garbage Collection) result = null; connection = null; }

boolean org.objectweb.cjdbc.driver.Statement.execute (  String  sql, String  columnNames[] )  throws SQLException

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 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). Parameters: sql  any SQL statement columnNames  an array of the names of the columns in the inserted row that should be made available for retrieval by a call to the method getGeneratedKeys Returns: true if the next result is a ResultSet object; false if it is an update count or there are no more results Exceptions: SQLException  if a database access error occurs See also: getResultSet getUpdateCount getMoreResults() getGeneratedKeys Since: JDK 1.4 Implements java.sql.Statement. Definition at line 937 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("execute"); }

boolean org.objectweb.cjdbc.driver.Statement.execute (  String  sql, int  columnIndexes[] )  throws SQLException

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 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). Parameters: sql  any SQL statement columnIndexes  an array of the indexes of the columns in the inserted row that should be made available for retrieval by a call to the method getGeneratedKeys Returns: true if the first result is a ResultSet object; false if it is an update count or there are no results Exceptions: SQLException  if a database access error occurs See also: getResultSet getUpdateCount getMoreResults() Since: JDK 1.4 Implements java.sql.Statement. Definition at line 899 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("execute"); }

boolean org.objectweb.cjdbc.driver.Statement.execute (  String  sql, int  autoGeneratedKeys )  throws SQLException

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 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). Parameters: sql  any SQL statement autoGeneratedKeys  a constant indicating whether auto-generated keys should be made available for retrieval using the method getGeneratedKeys; one of the following constants: Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS Returns: true if the first result is a ResultSet object; false if it is an update count or there are no results Exceptions: SQLException  if a database access error occurs See also: getResultSet getUpdateCount getMoreResults() getGeneratedKeys Since: JDK 1.4 Implements java.sql.Statement. Definition at line 860 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.execute(). { generatedKeysFlag = autoGeneratedKeys; return execute(sql); }

boolean org.objectweb.cjdbc.driver.Statement.execute (  String  sql  )  throws SQLException

Execute a SQL statement that may return multiple results. Parameters: sql  any SQL statement Returns: true if the result is a ResultSet or false if it is an integer Exceptions: SQLException  if an error occurs Implements java.sql.Statement. Definition at line 231 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.executeQuery(), org.objectweb.cjdbc.driver.Statement.executeUpdate(), org.objectweb.cjdbc.driver.Statement.result, and org.objectweb.cjdbc.driver.Statement.updateCount. Referenced by org.objectweb.cjdbc.driver.Statement.execute(). { int start = 0; try { // Ignore any leading parenthesis while (sql.charAt(start) == '(') start++; } catch (IndexOutOfBoundsException e) { // Probably a buggy request, let it go through and let thefollowing code // to report an accurate error if any. start = 0; } if (sql.regionMatches(true, start, "select", 0, 6) || (sql.regionMatches(true, start, "{call", 0, 5))) { result = executeQuery(sql); return true; } else { updateCount = executeUpdate(sql); return false; } }

int [] org.objectweb.cjdbc.driver.Statement.executeBatch (   )  throws SQLException

Execute a batch of commands Returns: an array containing update count that corresponding to the commands that executed successfully Exceptions: SQLException  if an error occurs Implements java.sql.Statement. Definition at line 171 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.result. { if (batch == null || batch.isEmpty()) return new int[0]; int size = batch.size(); int[] result = new int[size]; int i = 0; try { for (i = 0; i < size; i++) result[i] = this.executeUpdate((String) batch.elementAt(i)); return result; } catch (SQLException e) { String message = "Batch failed for request " + i + ": " + batch.elementAt(i) + " (" + e + ")"; int[] updateCounts = new int[i]; System.arraycopy(result, 0, updateCounts, 0, i); throw new BatchUpdateException(message, updateCounts); } finally { batch.removeAllElements(); } }

java.sql.ResultSet org.objectweb.cjdbc.driver.Statement.executeQuery (  String  sqlSkeleton, String  sqlQuery )  throws SQLException [protected]

Execute a SQL statement that returns a single ResultSet Parameters: sqlSkeleton  the SQL request squeleton or null sqlQuery  typically a static SQL SELECT statement that is already trimed Returns: a ResulSet that contains the data produced by the query Exceptions: SQLException  if a database access error occurs Definition at line 281 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Connection.close(), org.objectweb.cjdbc.driver.Statement.connection, org.objectweb.cjdbc.driver.Statement.escapeProcessing, org.objectweb.cjdbc.driver.Connection.execReadRequest(), org.objectweb.cjdbc.driver.Connection.execReadStoredProcedure(), org.objectweb.cjdbc.driver.Connection.isDriverProcessed(), org.objectweb.cjdbc.driver.Connection.needSqlSkeleton, org.objectweb.cjdbc.driver.Statement.result, org.objectweb.cjdbc.common.sql.SelectRequest.setCursorName(), org.objectweb.cjdbc.common.sql.AbstractRequest.setFetchSize(), org.objectweb.cjdbc.common.sql.AbstractRequest.setMaxRows(), org.objectweb.cjdbc.common.sql.AbstractRequest.setSqlSkeleton(), and org.objectweb.cjdbc.driver.Statement.updateCount. { updateCount = -1; // invalidate the last write result if (result != null) { // Discard the previous result result.close(); result = null; } if (sqlQuery.regionMatches(true, 0, "{call", 0, 5)) { StoredProcedure proc = new StoredProcedure(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); if (connection.needSqlSkeleton || !connection.isDriverProcessed()) proc.setSqlSkeleton(sqlSkeleton); proc.setMaxRows(maxRows); result = connection.execReadStoredProcedure(proc); } else { SelectRequest request = new SelectRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); if (connection.needSqlSkeleton || !connection.isDriverProcessed()) request.setSqlSkeleton(sqlSkeleton); request.setMaxRows(maxRows); request.setFetchSize(fetchSize); request.setCursorName(cursorName); result = connection.execReadRequest(request); } if (result instanceof DriverResultSet) ((DriverResultSet) result).setStatement(this); return result; }

java.sql.ResultSet org.objectweb.cjdbc.driver.Statement.executeQuery (  String  sql  )  throws SQLException

Execute a SQL statement that returns a single ResultSet Parameters: sql  typically a static SQL SELECT statement Returns: a ResulSet that contains the data produced by the query Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 267 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Statement.execute(). { return executeQuery(null, sql.trim()); }

int org.objectweb.cjdbc.driver.Statement.executeUpdate (  String  sql, String  columnNames[] )  throws SQLException

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. The driver will ignore the array if the SQL statement is not an INSERT statement. Parameters: sql  an SQL INSERT,UPDATE or DELETE statement or an SQL statement that returns nothing columnNames  an array of the names of the columns that should be returned from the inserted row Returns: either the row count for INSERT, UPDATE, or DELETE statements, or 0 for SQL statements that return nothing Exceptions: SQLException  if a database access error occurs Since: JDK 1.4 Implements java.sql.Statement. Definition at line 821 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("executeUpdate"); }

int org.objectweb.cjdbc.driver.Statement.executeUpdate (  String  sql, int  columnIndexes[] )  throws SQLException

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. The driver will ignore the array if the SQL statement is not an INSERT statement. Parameters: sql  an SQL INSERT,UPDATE or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement columnIndexes  an array of column indexes indicating the columns that should be returned from the inserted row Returns: either the row count for INSERT, UPDATE, or DELETE statements, or 0 for SQL statements that return nothing Exceptions: SQLException  if a database access error occurs or the SQL statement returns a ResultSet object Since: JDK 1.4 Implements java.sql.Statement. Definition at line 799 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("executeUpdate"); }

int org.objectweb.cjdbc.driver.Statement.executeUpdate (  String  sql, int  autoGeneratedKeys )  throws SQLException

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. Parameters: sql  must be an SQL INSERT,UPDATE or DELETE statement or an SQL statement that returns nothing autoGeneratedKeys  a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants: Statement.RETURN_GENERATED_KEYS Statement.NO_GENERATED_KEYS Returns: either the row count for INSERT, UPDATE or DELETE statements, or 0 for SQL statements that return nothing Exceptions: SQLException  if a database access error occurs, the given SQL statement returns a ResultSet object, or the given constant is not one of those allowed Since: JDK 1.4 Implements java.sql.Statement. Definition at line 774 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.executeUpdate(). { generatedKeysFlag = autoGeneratedKeys; return executeUpdate(sql); }

int org.objectweb.cjdbc.driver.Statement.executeUpdate (  String  sql  )  throws SQLException

Execute a SQL INSERT, UPDATE or DELETE statement. In addition SQL statements that return nothing such as SQL DDL statements can be executed Parameters: sql  a SQL statement Returns: either a row count, or 0 for SQL commands Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 325 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton(). Referenced by org.objectweb.cjdbc.driver.Statement.execute(), and org.objectweb.cjdbc.driver.Statement.executeUpdate(). { return executeUpdateWithSkeleton(null, sql.trim()); }

int org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton (  String  sqlSkeleton, String  sqlQuery )  throws SQLException [protected]

Execute a SQL INSERT, UPDATE or DELETE statement. In addition SQL statements that return nothing such as SQL DDL statements can be executed Parameters: sqlSkeleton  the SQL request squeleton or null sqlQuery  a static SQL statement that is already trimed Returns: either a row count, or 0 for SQL commands Exceptions: SQLException  if a database access error occurs Definition at line 339 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Connection.close(), org.objectweb.cjdbc.driver.Statement.connection, org.objectweb.cjdbc.driver.Statement.escapeProcessing, org.objectweb.cjdbc.driver.Connection.execWriteRequest(), org.objectweb.cjdbc.driver.Connection.execWriteRequestWithKeys(), org.objectweb.cjdbc.driver.Connection.execWriteStoredProcedure(), org.objectweb.cjdbc.driver.Statement.generatedKeys, org.objectweb.cjdbc.driver.Connection.isDriverProcessed(), org.objectweb.cjdbc.driver.Connection.needSqlSkeleton, org.objectweb.cjdbc.driver.Statement.result, org.objectweb.cjdbc.common.sql.AbstractRequest.setSqlSkeleton(), and org.objectweb.cjdbc.driver.Statement.updateCount. Referenced by org.objectweb.cjdbc.driver.PreparedStatement.execute(), and org.objectweb.cjdbc.driver.Statement.executeUpdate(). { if (result != null) { // Discard the previous result result.close(); result = null; } // Check that the command starts with // insert/update/delete/create/drop/{call String lower = sqlQuery.substring(0, 6 < sqlQuery.length() ? 6 : sqlQuery.length()).toLowerCase(); AbstractWriteRequest request; if (lower.equals("insert")) request = new InsertRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); else if (lower.equals("update")) request = new UpdateRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); else if (lower.equals("delete")) request = new DeleteRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); else if (lower.startsWith("create")) request = new CreateRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); else if (lower.startsWith("drop")) request = new DropRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); else if (lower.startsWith("alter")) request = new AlterRequest(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); else if (lower.startsWith("{call")) { // Call stored procedure and return StoredProcedure proc = new StoredProcedure(sqlQuery, escapeProcessing, timeout, Connection.LINE_SEPARATOR); if (connection.needSqlSkeleton || !connection.isDriverProcessed()) proc.setSqlSkeleton(sqlSkeleton); updateCount = connection.execWriteStoredProcedure(proc); return updateCount; } else if (lower.startsWith("}call")) { // Call stored procedure and return. This hack is used to allow someone to // use execute() to call a write stored procedure. StoredProcedure proc = new StoredProcedure("{" + sqlQuery.substring(1), escapeProcessing, timeout, Connection.LINE_SEPARATOR); if (connection.needSqlSkeleton || !connection.isDriverProcessed()) proc.setSqlSkeleton(sqlSkeleton); updateCount = connection.execWriteStoredProcedure(proc); return updateCount; } else throw new SQLException( "executeUpdate only accepts statements starting with insert/update/delete/create/drop/{call (" + sqlQuery + ")"); if (connection.needSqlSkeleton || !connection.isDriverProcessed()) request.setSqlSkeleton(sqlSkeleton); if (generatedKeysFlag == Statement.RETURN_GENERATED_KEYS) { // Get the auto generated key back generatedKeys = connection.execWriteRequestWithKeys(request); /* * Usually it is one autoincrement field and one generated key but if it * is not acceptable - better way to make another function for return * count of updates Or leave execWriteRequestWithKeys to return count and * add function for return ResultSet */ return 1; } else { // No generated keys updateCount = connection.execWriteRequest(request); return updateCount; } }

java.sql.Connection org.objectweb.cjdbc.driver.Statement.getConnection (   )  throws SQLException

Retrieve the connection that created this Statement object Returns: a java.sql.Connection object Exceptions: SQLException  never Implements java.sql.Statement. Definition at line 423 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.DriverResultSet.getBytes(). { return connection; }

int org.objectweb.cjdbc.driver.Statement.getFetchDirection (   )  throws SQLException

Not supported yet. Returns: nothing Exceptions: SQLException  not supported Implements java.sql.Statement. Definition at line 434 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("getFetchDirection()"); }

int org.objectweb.cjdbc.driver.Statement.getFetchSize (   )  throws SQLException

See also: java.sql.Statement.getFetchSize() Implements java.sql.Statement. Definition at line 442 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.DriverResultSet.setStatement(). { return fetchSize; }

java.sql.ResultSet org.objectweb.cjdbc.driver.Statement.getGeneratedKeys (   )  throws SQLException

Retrieves any auto-generated keys created as a result of executing this Statement object. If this Statement object did not generate any keys, an empty ResultSet object is returned. Returns: a ResultSet object containing the auto-generated key(s) generated by the execution of this Statement object Exceptions: SQLException  if a database access error occurs Since: JDK 1.4 Implements java.sql.Statement. Definition at line 749 of file org/objectweb/cjdbc/driver/Statement.java. { return generatedKeys; }

int org.objectweb.cjdbc.driver.Statement.getMaxFieldSize (   )  throws SQLException

The maxFieldSize limit (in bytes) is the maximum amount of data returned for any column value; it only applies to BINARY, VARBINARY,LONGVARBINARY,CHAR, VARCHAR and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. Note: We don't do anything with this value yet. Returns: the current max column size limit; zero means unlimited Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 459 of file org/objectweb/cjdbc/driver/Statement.java. { return maxFieldSize; }

int org.objectweb.cjdbc.driver.Statement.getMaxRows (   )  throws SQLException

The maxRows limit is set to limit the number of rows that any ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped. Returns: the current maximum row limit; zero means unlimited Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 472 of file org/objectweb/cjdbc/driver/Statement.java. { return maxRows; }

boolean org.objectweb.cjdbc.driver.Statement.getMoreResults (  int  current  )  throws SQLException

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. There are no more results when the following is true: (!getMoreResults() && (getUpdateCount() == -1) Parameters: current  one of the following Statement constants indicating what should happen to current ResultSet objects obtained using the method getResultSet</code: CLOSE_CURRENT_RESULT, KEEP_CURRENT_RESULT, or CLOSE_ALL_RESULTS Returns: true if the next result is a ResultSet object; false if it is an update count or there are no more results Exceptions: SQLException  if a database access error occurs Since: JDK 1.4 See also: execute(String) Implements java.sql.Statement. Definition at line 732 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("getMoreResults"); }

boolean org.objectweb.cjdbc.driver.Statement.getMoreResults (   )  throws SQLException

Multiple results are not suppoted so this method always return false and reset the update count to -1. Any open ResultSet is implicitly closed. Returns: false Exceptions: SQLException  if an error occurs Implements java.sql.Statement. Definition at line 484 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Connection.close(), org.objectweb.cjdbc.driver.Statement.result, and org.objectweb.cjdbc.driver.Statement.updateCount. { if (result != null) result.close(); updateCount = -1; return false; }

int org.objectweb.cjdbc.driver.Statement.getQueryTimeout (   )  throws SQLException

The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute. If the limit is exceeded, a SQLException is thrown. Returns: the current query timeout limit in seconds; 0 = unlimited Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 500 of file org/objectweb/cjdbc/driver/Statement.java. { return timeout; }

java.sql.ResultSet org.objectweb.cjdbc.driver.Statement.getResultSet (   )  throws SQLException

Returns the current result as a ResultSet. Returns: the current result set; null if there are no more Exceptions: SQLException  never Implements java.sql.Statement. Definition at line 511 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.PreparedStatement.getMetaData(). { return result; }

int org.objectweb.cjdbc.driver.Statement.getResultSetConcurrency (   )  throws SQLException

Retrieve the concurrency mode for the ResultSet. Returns: CONCUR_READ_ONLY or CONCUR_UPDATABLE Exceptions: SQLException  never Implements java.sql.Statement. Definition at line 523 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.DriverResultSet.setStatement(). { return resultSetConcurrency; }

int org.objectweb.cjdbc.driver.Statement.getResultSetHoldability (   )  throws SQLException

Retrieves the result set holdability for ResultSet objects generated by this Statement object. Returns: either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT Exceptions: SQLException  if a database access error occurs Since: JDK 1.4 Implements java.sql.Statement. Definition at line 951 of file org/objectweb/cjdbc/driver/Statement.java. { throw new NotImplementedException("getResultSetHoldability"); }

int org.objectweb.cjdbc.driver.Statement.getResultSetType (   )  throws SQLException

Retrieve the type of the generated ResultSet. Returns: one of TYPE_FORWARD_ONLY or TYPE_SCROLL_INSENSITIVE Exceptions: SQLException  never Implements java.sql.Statement. Definition at line 535 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.DriverResultSet.setStatement(). { return resultSetType; }

int org.objectweb.cjdbc.driver.Statement.getUpdateCount (   )  throws SQLException

Returns the current result as an update count, if the result is a ResultSet or there are no more results, -1 is returned. It should only be called once per result. Returns: the current result as an update count. Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 548 of file org/objectweb/cjdbc/driver/Statement.java. { return updateCount; }

SQLWarning org.objectweb.cjdbc.driver.Statement.getWarnings (   )  throws SQLException

The first warning reported by calls on this Statement is returned. A Statement's execute methods clear its SQLWarning chain. Subsequent Statement warnings will be chained to this SQLWarning. The Warning chain is automatically cleared each time a statement is (re)executed. Note: if you are processing a ResultSet then any warnings associated with ResultSet reads will be chained on the ResultSet object. Returns: the first SQLWarning on null Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 568 of file org/objectweb/cjdbc/driver/Statement.java. { return warnings; }

void org.objectweb.cjdbc.driver.Statement.setCursorName (  String  name  )  throws SQLException

Defines the SQL cursor name that will be used by subsequent execute methods. This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If a database doesn't support positioned update/delete, this method is a no-op. Parameters: name  the new cursor name Exceptions: SQLException  not supported Implements java.sql.Statement. Definition at line 584 of file org/objectweb/cjdbc/driver/Statement.java. { cursorName = name; }

void org.objectweb.cjdbc.driver.Statement.setEscapeProcessing (  boolean  enable  )  throws SQLException

If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database. Parameters: enable  true to enable; false to disable Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 596 of file org/objectweb/cjdbc/driver/Statement.java. References org.objectweb.cjdbc.driver.Statement.escapeProcessing. { escapeProcessing = enable; }

void org.objectweb.cjdbc.driver.Statement.setFetchDirection (  int  direction  )  throws SQLException

This hint is silently ignored and assumes FETCH_FORWARD which is the way C-JDBC has been optimized for. Parameters: direction  ignored Exceptions: SQLException  not supported Implements java.sql.Statement. Definition at line 608 of file org/objectweb/cjdbc/driver/Statement.java. { }

void org.objectweb.cjdbc.driver.Statement.setFetchSize (  int  rows  )  throws SQLException

Set the default fetch size for the produced ResultSet. Parameters: rows  ignored Exceptions: SQLException  not supported Implements java.sql.Statement. Definition at line 618 of file org/objectweb/cjdbc/driver/Statement.java. { fetchSize = rows; }

void org.objectweb.cjdbc.driver.Statement.setMaxFieldSize (  int  max  )  throws SQLException

Sets the maxFieldSize. Parameters: max  the new max column size limit; 0 means unlimited Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 629 of file org/objectweb/cjdbc/driver/Statement.java. { maxFieldSize = max; }

void org.objectweb.cjdbc.driver.Statement.setMaxRows (  int  max  )  throws SQLException

Sets the maximum number of rows. Parameters: max  the new max rows limit; 0 means unlimited Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 640 of file org/objectweb/cjdbc/driver/Statement.java. { maxRows = max; }

void org.objectweb.cjdbc.driver.Statement.setQueryTimeout (  int  seconds  )  throws SQLException

Sets the queryTimeout limit. Parameters: seconds  the new query timeout limit in seconds (0 means no timeout) Exceptions: SQLException  if a database access error occurs Implements java.sql.Statement. Definition at line 651 of file org/objectweb/cjdbc/driver/Statement.java. { timeout = seconds; }

void org.objectweb.cjdbc.driver.Statement.setResultSetConcurrency (  int  value  )  throws SQLException

Parameters: value  an int value Exceptions: SQLException  if an error occurs Definition at line 660 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Connection.createStatement(), org.objectweb.cjdbc.driver.Connection.prepareCall(), and org.objectweb.cjdbc.driver.Connection.prepareStatement(). { switch (value) { case ResultSet.CONCUR_READ_ONLY: case ResultSet.CONCUR_UPDATABLE: resultSetConcurrency = value; break; default: throw new SQLException("Invalid ResultSet " + "concurrency mode: " + value); } }

void org.objectweb.cjdbc.driver.Statement.setResultSetType (  int  value  )  throws SQLException

Parameters: value  an int value Exceptions: SQLException  if an error occurs Definition at line 678 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Connection.createStatement(), org.objectweb.cjdbc.driver.Connection.prepareCall(), and org.objectweb.cjdbc.driver.Connection.prepareStatement(). { switch (value) { case ResultSet.TYPE_FORWARD_ONLY: case ResultSet.TYPE_SCROLL_INSENSITIVE: resultSetType = value; break; case ResultSet.TYPE_SCROLL_SENSITIVE: throw new SQLException( "TYPE_SCROLL_SENSITIVE is not a supported ResultSet type"); default: throw new SQLException("Invalid ResultSet type"); } }

---

Member Data Documentation

Connection org.objectweb.cjdbc.driver.Statement.connection = null [protected]

The connection that created us Definition at line 65 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Statement.close(), org.objectweb.cjdbc.driver.DriverResultSet.close(), org.objectweb.cjdbc.driver.Statement.executeQuery(), org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton(), org.objectweb.cjdbc.driver.DriverResultSet.getBoolean(), org.objectweb.cjdbc.driver.DriverResultSet.getBytes(), org.objectweb.cjdbc.driver.DriverResultSet.getObject(), org.objectweb.cjdbc.driver.DriverResultSet.next(), and org.objectweb.cjdbc.driver.Statement.Statement().

boolean org.objectweb.cjdbc.driver.Statement.escapeProcessing = true [protected]

Should the driver to escape processing before sending to the DB? Definition at line 102 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Statement.executeQuery(), org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton(), and org.objectweb.cjdbc.driver.Statement.setEscapeProcessing().

ResultSet org.objectweb.cjdbc.driver.Statement.generatedKeys = null [protected]

Auto generated keys Definition at line 105 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton().

ResultSet org.objectweb.cjdbc.driver.Statement.result = null [protected]

The current result for a read request Definition at line 74 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Statement.close(), org.objectweb.cjdbc.driver.Statement.execute(), org.objectweb.cjdbc.driver.Statement.executeBatch(), org.objectweb.cjdbc.driver.Statement.executeQuery(), org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton(), and org.objectweb.cjdbc.driver.Statement.getMoreResults().

int org.objectweb.cjdbc.driver.Statement.updateCount = -1 [protected]

The update count for a write request Definition at line 77 of file org/objectweb/cjdbc/driver/Statement.java. Referenced by org.objectweb.cjdbc.driver.Statement.execute(), org.objectweb.cjdbc.driver.Statement.executeQuery(), org.objectweb.cjdbc.driver.Statement.executeUpdateWithSkeleton(), and org.objectweb.cjdbc.driver.Statement.getMoreResults().

---

The documentation for this class was generated from the following file:

• org/objectweb/cjdbc/driver/Statement.java

---