Java Doc for PreparedStatementWrapper.java in  » J2EE » JOnAS-4.8.6 » org » objectweb » jonas » resource » Java Source Code / Java DocumentationJava Source Code and Java Documentation

In general, parameter values remain in force for repeated use of a statement.

Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it.

Sets the value of the designated parameter using the given object.

Sets the value of the designated parameter with the given object.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.
Parameters:
  user - the user used for accessing the connection
Parameters:
  sql - a String object that is the SQL statement to besent to the database; may contain one or more ? IN parameters
Parameters:
  resultSetType - one of the following ResultSetconstants: ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE
Parameters:
  resultSetConcurrency - one of the following ResultSetconstants: ResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE
Parameters:
  resultSetHoldability - one of the following ResultSetconstants: ResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
Parameters:
  trace - the logger to use for logging purpose
Parameters:
  isDebugLogging - if true, log the debug event in the logger
since:
   JDK 1.4

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.
Parameters:
  user - the user used for accessing the connection
Parameters:
  sql - an SQL statement that may contain one or more '?' IN parameterplaceholders
Parameters:
  columnIndexes - an array of column indexes indicating the columnsthat should be returned from the inserted row or rows
Parameters:
  trace - the logger to use for logging purpose
Parameters:
  isDebugLogging - if true, log the debug event in the logger
since:
   JDK 1.4

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.
Parameters:
  user - the user used for accessing the connection
Parameters:
  sql - an SQL statement that may contain one or more '?' IN parameterplaceholders
Parameters:
  columnNames - an array of column names indicating the columns thatshould be returned from the inserted row or rows
Parameters:
  trace - the logger to use for logging purpose
Parameters:
  isDebugLogging - if true, log the debug event in the logger
since:
   JDK 1.4

NOTE: This method is optional.
Parameters:
  s - typically this is a static SQL INSERT orUPDATE statement
exception:
  SQLException - if a database access error occurs, or the driverdoes not support batch updates
See Also:   PreparedStatementWrapper.executeBatch
since:
   1.2

NOTE: This method is optional.
exception:
  SQLException - if a database access error occurs or the driverdoes not support batch updates
See Also:   PreparedStatementWrapper.addBatch
since:
   1.2

In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters.
exception:
  SQLException - if a database access error occurs

Calling the method close on a Statement object that is already closed has no effect.

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

The execute method returns a boolean to indicate the form of the first result. You must call either the method getResultSet or getUpdateCount to retrieve the result; you must call getMoreResults to move to any subsequent result(s). true if the first result is aResultSet object; false if thefirst result is an update count or there is no result
exception:
  SQLException - if a database access error occurs or an argumentis supplied to this method
See Also:   Statement.execute
See Also:   Statement.getResultSet
See Also:   Statement.getUpdateCount
See Also:   Statement.getMoreResults

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
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; false if it is anupdate count or there are no results
exception:
  SQLException - if a database access error occurs or the secondparameter supplied to this method is notStatement.RETURN_GENERATED_KEYS orStatement.NO_GENERATED_KEYS.
See Also:   PreparedStatementWrapper.getResultSet
See Also:   PreparedStatementWrapper.getUpdateCount
See Also:   PreparedStatementWrapper.getMoreResults
See Also:   PreparedStatementWrapper.getGeneratedKeys
since:
   1.4

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
Parameters:
  columnIndexes - an array of the indexes of the columns in theinserted row that should be made available for retrieval by a callto the method getGeneratedKeys true if the first result is aResultSet object; false if it is anupdate count or there are no results
exception:
  SQLException - if a database access error occurs or the elementsin the int array passed to this method are notvalid column indexes
See Also:   PreparedStatementWrapper.getResultSet
See Also:   PreparedStatementWrapper.getUpdateCount
See Also:   PreparedStatementWrapper.getMoreResults
since:
   1.4

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
Parameters:
  columnNames - an array of the names of the columns in the insertedrow that should be made available for retrieval by a call to themethod getGeneratedKeys true if the next result is aResultSet object; false if it is anupdate count or there are no more results
exception:
  SQLException - if a database access error occurs or the elementsof the String array passed to this method arenot valid column names
See Also:   PreparedStatementWrapper.getResultSet
See Also:   PreparedStatementWrapper.getUpdateCount
See Also:   PreparedStatementWrapper.getMoreResults
See Also:   PreparedStatementWrapper.getGeneratedKeys
since:
   1.4

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:
  s - any SQL statement true if the first result is aResultSet object; false if it is anupdate count or there are no results
exception:
  SQLException - if a database access error occurs
See Also:   PreparedStatementWrapper.getResultSet
See Also:   PreparedStatementWrapper.getUpdateCount
See Also:   PreparedStatementWrapper.getMoreResults

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. 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. an array of update counts containing one element for each commandin the batch. The elements of the array are ordered according tothe order in which commands were added to the batch.
exception:
  SQLException - if a database access error occurs or the driverdoes not support batch statements. ThrowsBatchUpdateException (a subclass ofSQLException) if one of the commands sent tothe database fails to execute properly or attempts to return aresult set.
since:
   1.3

Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData on a PreparedStatement object rather than waiting to execute it and then invoking the ResultSet.getMetaData method on the ResultSet object that is returned.

NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support. the description of a ResultSet object's columns ornull if the driver cannot return aResultSetMetaData object
exception:
  SQLException - if a database access error occurs
since:
   1.2

There are no more results when the following is true:

 // stmt is a Statement object ((stmt.getMoreResults() == false) &&
 (stmt.getUpdateCount() == -1))
 

There are no more results when the following is true:

 // stmt is a Statement object ((stmt.getMoreResults() == false) &&
 (stmt.getUpdateCount() == -1))
 

The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed Statement object; doing so will cause an SQLException to be thrown.

Note: If you are processing a ResultSet object, any warnings associated with reads on that ResultSet object will be chained on it rather than on the Statement object that produced it. the first SQLWarning object or nullif there are no warnings
exception:
  SQLException - if a database access error occurs or this methodis called on a closed statement

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  x - the Java input stream that contains the ASCII parameter value
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if a database access error occurs

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  x - the java input stream which contains the binary parameter value
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if a database access error occurs

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  reader - the java.io.Reader object that contains theUnicode data
Parameters:
  length - the number of characters in the stream
exception:
  SQLException - if a database access error occurs
since:
   1.2

Note: By definition, the execution of positioned updates and deletes must be done by a different Statement object than the one that generated the ResultSet object being used for positioning. Also, cursor names must be unique within a connection.
Parameters:
  name - the new cursor name, which must be unique within a connection
exception:
  SQLException - if a database access error occurs

Note that this method sets the default fetch direction for result sets generated by this Statement object. Each result set has its own methods for getting and setting its own fetch direction.
Parameters:
  direction - the initial direction for processing rows
exception:
  SQLException - if a database access error occurs or the givendirection is not one of ResultSet.FETCH_FORWARD,ResultSet.FETCH_REVERSE, orResultSet.FETCH_UNKNOWN
since:
   1.2
See Also:   PreparedStatementWrapper.getFetchDirection

Note: You must specify the parameter's SQL type.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  sqlType - the SQL type code defined in java.sql.Types
exception:
  SQLException - if a database access error occurs

Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
Parameters:
  paramIndex - the first parameter is 1, the second is 2, ...
Parameters:
  sqlType - a value from java.sql.Types
Parameters:
  typeName - the fully-qualified name of an SQL user-defined type;ignored if the parameter is not a user-defined type or REF
exception:
  SQLException - if a database access error occurs
since:
   1.2

Sets the value of the designated parameter using the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types.

The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface SQLData, the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  x - the object containing the input parameter value
exception:
  SQLException - if a database access error occurs or the type ofthe given object is ambiguous

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used.

The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass database-specific abstract data types.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  x - the object containing the input parameter value
Parameters:
  targetSqlType - the SQL type (as defined in java.sql.Types) to besent to the database. The scale argument may further qualify thistype.
Parameters:
  scale - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types,this is the number of digits after the decimal point. For allother types, this value will be ignored.
exception:
  SQLException - if a database access error occurs
See Also:   Types

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
Parameters:
  x - a java.io.InputStream object that contains theUnicode parameter value as two-byte Unicode characters
Parameters:
  length - the number of bytes in the stream
exception:
  SQLException - if a database access error occurs