com.ibm.as400.access
Class AS400JDBCPreparedStatement

java.lang.Object
  extended bycom.ibm.as400.access.AS400JDBCStatement
      extended bycom.ibm.as400.access.AS400JDBCPreparedStatement
All Implemented Interfaces:
PreparedStatement, Statement
Direct Known Subclasses:
AS400JDBCCallableStatement

public class AS400JDBCPreparedStatement
extends AS400JDBCStatement
implements PreparedStatement

The AS400JDBCPreparedStatement class precompiles and stores an SQL statement. This provides the ability to efficiently run the statement multiple times. In addition, the statement may contain parameters. Use Connection.prepareStatement() to create new PreparedStatement objects.

When setting input parameter values, the caller must specify types that are compatible with the defined SQL type of the input parameter. For example, if the input parameter has SQL type INTEGER, then the caller must call setInt() to set the IN parameter value. If arbitrary type conversions are required, then use setObject() with a target SQL type.


Field Summary
 
Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
 
Method Summary
 void addBatch()
          Adds the set of parameters to the current batch.
 void addBatch(String sql)
          Adds an SQL statement to the current batch of SQL statements.
 void clearParameters()
          Releases the resources used by the current input parameter values.
 void close()
          Releases the prepared statement's resources immediately instead of waiting for them to be automatically released.
 boolean execute()
          Runs an SQL statement that may return multiple result sets.
 boolean execute(String sql)
          Runs an SQL statement that may return multiple result sets.
 boolean execute(String sql, int autoGeneratedKeys)
          Runs an SQL statement that may return multiple result sets and makes any auto-generated keys available for retrieval using Statement.getGeneratedKeys().
 int[] executeBatch()
          Runs the batch of SQL statements.
 ResultSet executeQuery()
          Runs the SQL statement that returns a single result set.
 ResultSet executeQuery(String sql)
          Runs an SQL statement that returns a single result set.
 int executeUpdate()
          Runs an SQL INSERT, UPDATE, or DELETE statement, or any SQL statement that does not return a result set.
 int executeUpdate(String sql)
          Runs an SQL INSERT, UPDATE, or DELETE statement, or any SQL statement that does not return a result set.
 int executeUpdate(String sql, int autoGeneratedKeys)
          Runs an SQL INSERT, UPDATE, or DELETE statement, or any SQL statement that does not return a result set and makes any auto-generated keys available for retrieval using Statement.getGeneratedKeys().
 ResultSetMetaData getMetaData()
          Returns the ResultSetMetaData object that describes the result set's columns.
 ParameterMetaData getParameterMetaData()
          Returns the number, types, and properties of a PreparedStatement object's parameters.
 void setArray(int parameterIndex, Array parameterValue)
          Sets an input parameter to an Array value.
 void setAsciiStream(int parameterIndex, InputStream parameterValue, int length)
          Sets an input parameter to an ASCII stream value.
 void setBigDecimal(int parameterIndex, BigDecimal parameterValue)
          Sets an input parameter to a BigDecimal value.
 void setBinaryStream(int parameterIndex, InputStream parameterValue, int length)
          Sets an input parameter to a binary stream value.
 void setBlob(int parameterIndex, Blob parameterValue)
          Sets an input parameter to a Blob value.
 void setBoolean(int parameterIndex, boolean parameterValue)
          Sets an input parameter to a Java boolean value.
 void setByte(int parameterIndex, byte parameterValue)
          Sets an input parameter to a Java byte value.
 void setBytes(int parameterIndex, byte[] parameterValue)
          Sets an input parameter to a Java byte array value.
 void setCharacterStream(int parameterIndex, Reader parameterValue, int length)
          Sets an input parameter to a character stream value.
 void setClob(int parameterIndex, Clob parameterValue)
          Sets an input parameter to a Clob value.
 void setDate(int parameterIndex, Date parameterValue)
          Sets an input parameter to a java.sql.Date value using the default calendar.
 void setDate(int parameterIndex, Date parameterValue, Calendar calendar)
          Sets an input parameter to a java.sql.Date value using a calendar other than the default.
 void setDB2Default(int parameterIndex)
          Sets an input parameter to the default value
 void setDB2Unassigned(int parameterIndex)
          Sets an input parameter to unassigned
 void setDouble(int parameterIndex, double parameterValue)
          Sets an input parameter to a Java double value.
 void setFloat(int parameterIndex, float parameterValue)
          Sets an input parameter to a Java float value.
 void setInt(int parameterIndex, int parameterValue)
          Sets an input parameter to a Java int value.
 void setLong(int parameterIndex, long parameterValue)
          Sets an input parameter to a Java long value.
 void setNull(int parameterIndex, int sqlType)
          Sets an input parameter to SQL NULL.
 void setNull(int parameterIndex, int sqlType, String typeName)
          Sets an input parameter to SQL NULL.
 void setObject(int parameterIndex, Object parameterValue)
          Sets an input parameter to an Object value.
 void setObject(int parameterIndex, Object parameterValue, int sqlType)
          Sets an input parameter to an Object value.
 void setObject(int parameterIndex, Object parameterValue, int sqlType, int scale)
          Sets an input parameter to an Object value.
 void setRef(int parameterIndex, Ref parameterValue)
          Sets an input parameter to a Ref value.
 void setShort(int parameterIndex, short parameterValue)
          Sets an input parameter to a Java short value.
 void setString(int parameterIndex, String parameterValue)
          Sets an input parameter to a String value.
 void setTime(int parameterIndex, Time parameterValue)
          Sets an input parameter to a java.sql.Time value using the default calendar.
 void setTime(int parameterIndex, Time parameterValue, Calendar calendar)
          Sets an input parameter to a java.sql.Time value using a calendar other than the default.
 void setTimestamp(int parameterIndex, Timestamp parameterValue)
          Sets an input parameter to a java.sql.Timestamp value using the default calendar.
 void setTimestamp(int parameterIndex, Timestamp parameterValue, Calendar calendar)
          Sets an input parameter to a java.sql.Timestamp value using a calendar other than the default.
 void setUnicodeStream(int parameterIndex, InputStream parameterValue, int length)
          Deprecated. Use setCharacterStream(int, Reader, int) instead.
 void setURL(int parameterIndex, URL parameterValue)
          Sets an input parameter to a URL value.
 
Methods inherited from class com.ibm.as400.access.AS400JDBCStatement
cancel, clearBatch, clearWarnings, execute, execute, executeUpdate, executeUpdate, finalize, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getPositionOfSyntaxError, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout, toString
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.sql.Statement
cancel, clearBatch, clearWarnings, execute, execute, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

Method Detail

addBatch

public void addBatch()
              throws SQLException
Adds the set of parameters to the current batch.

Specified by:
addBatch in interface PreparedStatement
Throws:
SQLException - If the statement is not open or an input parameter has not been set.

addBatch

public void addBatch(String sql)
              throws SQLException
Adds an SQL statement to the current batch of SQL statements.

Do not use this form of addBatch() on a prepared statement.

Specified by:
addBatch in interface Statement
Overrides:
addBatch in class AS400JDBCStatement
Parameters:
sql - The SQL statement to be added to the current batch. This can be any SQL statement that does not return a result set.
Throws:
SQLException - This exception is always thrown.

clearParameters

public void clearParameters()
                     throws SQLException
Releases the resources used by the current input parameter values. In general, input parameter values remain in effect for repeated executions of the prepared statement. Setting an input parameter value to a new value automatically clears its previous value.

Specified by:
clearParameters in interface PreparedStatement
Throws:
SQLException - If the statement is not open.

close

public void close()
           throws SQLException
Releases the prepared statement's resources immediately instead of waiting for them to be automatically released. This closes the current result set.

Specified by:
close in interface Statement
Overrides:
close in class AS400JDBCStatement
Throws:
SQLException - If an error occurs.

execute

public boolean execute()
                throws SQLException
Runs an SQL statement that may return multiple result sets. This closes the current result set and clears warnings before executing the SQL statement again.

Under some situations, a single SQL statement may return multiple result sets, an update count, or both. This might occur either when executing a stored procedure that returns multiple result sets or when dynamically executing an unknown SQL string.

Use Statement.getMoreResults(), Statement.getResultSet(), and Statement.getUpdateCount() to navigate through multiple result sets, an update count, or both.

Specified by:
execute in interface PreparedStatement
Returns:
true if a result set was returned; false if an update count was returned or nothing was returned.
Throws:
SQLException - If the statement is not open, the query timeout limit is exceeded, or an error occurs.

execute

public boolean execute(String sql)
                throws SQLException
Runs an SQL statement that may return multiple result sets. This closes the current result set and clears warnings before executing a new SQL statement.

Do not use this form of execute() on a prepared statement.

Specified by:
execute in interface Statement
Overrides:
execute in class AS400JDBCStatement
Parameters:
sql - The SQL statement.
Returns:
true if a result set was returned, false if an update count was returned or nothing was returned.
Throws:
SQLException - This exception is always thrown.

execute

public boolean execute(String sql,
                       int autoGeneratedKeys)
                throws SQLException
Runs an SQL statement that may return multiple result sets and makes any auto-generated keys available for retrieval using Statement.getGeneratedKeys(). This closes the current result set and clears warnings before executing the new SQL statement.

Do not use this form of execute() on a prepared statement.

Specified by:
execute in interface Statement
Overrides:
execute in class AS400JDBCStatement
Parameters:
sql - The SQL statement.
autoGeneratedKeys - Indicates whether auto-generated keys should be made available for retrieval. Valid values are Statement.RETURN_GENERATED_KEYS and Statement.NO_GENERATED_KEYS.
Returns:
true if a result set was returned, false if an update count was returned or nothing was returned.
Throws:
SQLException - This exception is always thrown.
Since:
Modification 5

executeBatch

public int[] executeBatch()
                   throws SQLException
Runs the batch of SQL statements. Batch updates can be used to submit a set of SQL statements together as a single unit. The SQL statements are run in the order in which they were added to the batch. The batch is cleared after the SQL statements are run. In addition, this closes the current result set and clears warnings before executing the new SQL statement.

When batch updates are run, autocommit should usually be turned off. This allows the caller to decide whether or not to commit the transaction in the event that an error occurs and some of the SQL statements in a batch fail to run.

Specified by:
executeBatch in interface Statement
Overrides:
executeBatch in class AS400JDBCStatement
Returns:
An array of row counts for the SQL statements that are run. The array contains one element for each statement in the batch of SQL statements. The array is ordered according to the order in which the SQL statements were added to the batch.
Throws:
SQLException - If the statement is not open, an SQL statement contains a syntax error, the query timeout limit is exceeded, an SQL statement returns a result set, or an error occurs.

executeQuery

public ResultSet executeQuery()
                       throws SQLException
Runs the SQL statement that returns a single result set. This closes the current result set and clears warnings before executing the SQL statement again.

Specified by:
executeQuery in interface PreparedStatement
Returns:
The result set that contains the data produced by the query.
Throws:
SQLException - If the statement is not open, no result set is returned by the database, the query timeout limit is exceeded, an input parameter has not been set, or an error occurs.

executeQuery

public ResultSet executeQuery(String sql)
                       throws SQLException
Runs an SQL statement that returns a single result set. This closes the current result set and clears warnings before executing a new SQL statement.

Do not use this form of executeQuery() on a prepared statement.

Specified by:
executeQuery in interface Statement
Overrides:
executeQuery in class AS400JDBCStatement
Parameters:
sql - The SQL statement.
Returns:
The result set that contains the data produced by the query.
Throws:
SQLException - This exception is always thrown.

executeUpdate

public int executeUpdate()
                  throws SQLException
Runs an SQL INSERT, UPDATE, or DELETE statement, or any SQL statement that does not return a result set. This closes the current result set and clears warnings before executing the SQL statement again.

Specified by:
executeUpdate in interface PreparedStatement
Returns:
Either the row count for INSERT, UPDATE, or DELETE, or 0 for SQL statements that return nothing.
Throws:
SQLException - If the statement is not open, the query timeout limit is exceeded, the statement returns a result set, an input parameter has not been set, or an error occurs.

executeUpdate

public int executeUpdate(String sql)
                  throws SQLException
Runs an SQL INSERT, UPDATE, or DELETE statement, or any SQL statement that does not return a result set. This closes the current result set and clears warnings before executing a new SQL statement.

Do not use this form of executeUpdate() on a prepared statement.

Specified by:
executeUpdate in interface Statement
Overrides:
executeUpdate in class AS400JDBCStatement
Parameters:
sql - The SQL statement.
Returns:
Either the row count for INSERT, UPDATE, or DELETE, or 0 for SQL statements that return nothing.
Throws:
SQLException - This exception is always thrown.

executeUpdate

public int executeUpdate(String sql,
                         int autoGeneratedKeys)
                  throws SQLException
Runs an SQL INSERT, UPDATE, or DELETE statement, or any SQL statement that does not return a result set and makes any auto-generated keys available for retrieval using Statement.getGeneratedKeys(). This closes the current result set and clears warnings before executing the new SQL statement.

Do not use this form of executeUpdate() on a prepared statement.

Specified by:
executeUpdate in interface Statement
Overrides:
executeUpdate in class AS400JDBCStatement
Parameters:
sql - The SQL statement.
Returns:
Either the row count for INSERT, UPDATE, or DELETE, or 0 for SQL statements that return nothing.
Throws:
SQLException - This exception is always thrown.
Since:
Modification 5

getMetaData

public ResultSetMetaData getMetaData()
                              throws SQLException
Returns the ResultSetMetaData object that describes the result set's columns. Null is returned if the statement does not return a result set. In the following example rsmd is null since the statement does not return a result set.
 
    PreparedStatement ps   = connection.prepareStatement("INSERT INTO COLLECTION.TABLE VALUES(?)");
    ResultSetMetaData rsmd = ps.getMetaData();
    

Specified by:
getMetaData in interface PreparedStatement
Returns:
The metadata object, or null if the statement does not return a result set.
Throws:
SQLException - If the statement is not open.

getParameterMetaData

public ParameterMetaData getParameterMetaData()
                                       throws SQLException
Returns the number, types, and properties of a PreparedStatement object's parameters.

Specified by:
getParameterMetaData in interface PreparedStatement
Returns:
The ParameterMetaData object that describes this prepared statement object.
Throws:
SQLException - If the statement is not open.
Since:
Modification 5

setArray

public void setArray(int parameterIndex,
                     Array parameterValue)
              throws SQLException
Sets an input parameter to an Array value. DB2 for i5/OS does not support arrays.

Specified by:
setArray in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - Always thrown because DB2 for i5/OS does not support arrays.

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           InputStream parameterValue,
                           int length)
                    throws SQLException
Sets an input parameter to an ASCII stream value. The driver reads the data from the stream as needed until no more bytes are available. The driver converts this to an SQL VARCHAR value.

Specified by:
setAsciiStream in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
length - The number of bytes in the stream.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the length is not valid, the input stream does not contain all ASCII characters, or an error occurs while reading the input stream.

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          BigDecimal parameterValue)
                   throws SQLException
Sets an input parameter to a BigDecimal value. The driver converts this to an SQL NUMERIC value.

Specified by:
setBigDecimal in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            InputStream parameterValue,
                            int length)
                     throws SQLException
Sets an input parameter to a binary stream value. The driver reads the data from the stream as needed until no more bytes are available. The driver converts this to an SQL VARBINARY value.

Specified by:
setBinaryStream in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
length - The number of bytes in the stream.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the length is not valid, or an error occurs while reading the input stream.

setBlob

public void setBlob(int parameterIndex,
                    Blob parameterValue)
             throws SQLException
Sets an input parameter to a Blob value. The driver converts this to an SQL BLOB value.
If proxy support is in use, the Blob must be serializable.

Specified by:
setBlob in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the parameter is not serializable (when proxy support is in use).

setBoolean

public void setBoolean(int parameterIndex,
                       boolean parameterValue)
                throws SQLException
Sets an input parameter to a Java boolean value. The driver converts this to an SQL SMALLINT value.

Specified by:
setBoolean in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setByte

public void setByte(int parameterIndex,
                    byte parameterValue)
             throws SQLException
Sets an input parameter to a Java byte value. The driver converts this to an SQL SMALLINT value.

Specified by:
setByte in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setBytes

public void setBytes(int parameterIndex,
                     byte[] parameterValue)
              throws SQLException
Sets an input parameter to a Java byte array value. The driver converts this to an SQL VARBINARY value.

Specified by:
setBytes in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               Reader parameterValue,
                               int length)
                        throws SQLException
Sets an input parameter to a character stream value. The driver reads the data from the character stream as needed until no more characters are available. The driver converts this to an SQL VARCHAR value.

Specified by:
setCharacterStream in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
length - The number of characters to read from the reader.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the length is not valid, or an error occurs while reading the character stream

setClob

public void setClob(int parameterIndex,
                    Clob parameterValue)
             throws SQLException
Sets an input parameter to a Clob value. The driver converts this to an SQL CLOB value.
If proxy support is in use, the Clob must be serializable.

Specified by:
setClob in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the parameter is not serializable (when proxy support is in use).

setDate

public void setDate(int parameterIndex,
                    Date parameterValue)
             throws SQLException
Sets an input parameter to a java.sql.Date value using the default calendar. The driver converts this to an SQL DATE value.

Specified by:
setDate in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setDate

public void setDate(int parameterIndex,
                    Date parameterValue,
                    Calendar calendar)
             throws SQLException
Sets an input parameter to a java.sql.Date value using a calendar other than the default. The driver converts this to an SQL DATE value.

Specified by:
setDate in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
calendar - The calendar.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the calendar is null.

setDB2Default

public void setDB2Default(int parameterIndex)
                   throws SQLException
Sets an input parameter to the default value

Parameters:
parameterIndex - The parameter index (1-based).
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter.

setDB2Unassigned

public void setDB2Unassigned(int parameterIndex)
                      throws SQLException
Sets an input parameter to unassigned

Parameters:
parameterIndex - The parameter index (1-based).
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter.

setDouble

public void setDouble(int parameterIndex,
                      double parameterValue)
               throws SQLException
Sets an input parameter to a Java double value. The driver converts this to an SQL DOUBLE value.

Specified by:
setDouble in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid or the parameter is not an input parameter.

setFloat

public void setFloat(int parameterIndex,
                     float parameterValue)
              throws SQLException
Sets an input parameter to a Java float value. The driver converts this to an SQL REAL value.

Specified by:
setFloat in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setInt

public void setInt(int parameterIndex,
                   int parameterValue)
            throws SQLException
Sets an input parameter to a Java int value. The driver converts this to an SQL INTEGER value.

Specified by:
setInt in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid or the parameter is not an input parameter.

setLong

public void setLong(int parameterIndex,
                    long parameterValue)
             throws SQLException
Sets an input parameter to a Java long value. If the connected system supports SQL BIGINT data, the driver converts this to an SQL BIGINT value. Otherwise, the driver converts this to an SQL INTEGER value. SQL BIGINT data is supported on V4R5 and later.

Specified by:
setLong in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws SQLException
Sets an input parameter to SQL NULL.

Specified by:
setNull in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
sqlType - The SQL type code defined in java.sql.Types.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the SQL type is not valid.

setNull

public void setNull(int parameterIndex,
                    int sqlType,
                    String typeName)
             throws SQLException
Sets an input parameter to SQL NULL.

Specified by:
setNull in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
sqlType - The SQL type code defined in java.sql.Types.
typeName - The fully-qualified name of an SQL structured type. This value will be ignored.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the SQL type is not valid.

setObject

public void setObject(int parameterIndex,
                      Object parameterValue)
               throws SQLException
Sets an input parameter to an Object value. The driver converts this to a value of an SQL type, depending on the type of the specified value. The JDBC specification defines a standard mapping from Java types to SQL types. In the cases where a SQL type is not supported by DB2 for i5/OS, the next closest matching type is used.
If proxy support is in use, the Object must be serializable.

Specified by:
setObject in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the type of value is not supported, or the parameter is not serializable (when proxy support is in use).

setObject

public void setObject(int parameterIndex,
                      Object parameterValue,
                      int sqlType)
               throws SQLException
Sets an input parameter to an Object value. The driver converts this to a value with the specified SQL type.
If proxy support is in use, the Object must be serializable.

Specified by:
setObject in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
sqlType - The SQL type code defined in java.sql.Types.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the SQL type is not valid, or the parameter is not serializable (when proxy support is in use).

setObject

public void setObject(int parameterIndex,
                      Object parameterValue,
                      int sqlType,
                      int scale)
               throws SQLException
Sets an input parameter to an Object value. The driver converts this to a value with the specified SQL type.
If proxy support is in use, the Object must be serializable.

Specified by:
setObject in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
sqlType - The SQL type code defined in java.sql.Types.
scale - The number of digits after the decimal if sqlType is DECIMAL or NUMERIC.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the SQL type is not valid, the scale is not valid, or the parameter is not serializable (when proxy support is in use).

setRef

public void setRef(int parameterIndex,
                   Ref parameterValue)
            throws SQLException
Sets an input parameter to a Ref value. DB2 for i5/OS does not support structured types.

Specified by:
setRef in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - Always thrown because DB2 for i5/OS does not support structured types.

setShort

public void setShort(int parameterIndex,
                     short parameterValue)
              throws SQLException
Sets an input parameter to a Java short value. The driver converts this to an SQL SMALLINT value.

Specified by:
setShort in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value.
Throws:
SQLException - If the statement is not open, the index is not valid or the parameter is not an input parameter.

setString

public void setString(int parameterIndex,
                      String parameterValue)
               throws SQLException
Sets an input parameter to a String value. The driver converts this to an SQL VARCHAR value.

Specified by:
setString in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setTime

public void setTime(int parameterIndex,
                    Time parameterValue)
             throws SQLException
Sets an input parameter to a java.sql.Time value using the default calendar. The driver converts this to an SQL TIME value.

Specified by:
setTime in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setTime

public void setTime(int parameterIndex,
                    Time parameterValue,
                    Calendar calendar)
             throws SQLException
Sets an input parameter to a java.sql.Time value using a calendar other than the default. The driver converts this to an SQL TIME value.

Specified by:
setTime in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
calendar - The calendar.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the calendar is null.

setTimestamp

public void setTimestamp(int parameterIndex,
                         Timestamp parameterValue)
                  throws SQLException
Sets an input parameter to a java.sql.Timestamp value using the default calendar. The driver converts this to an SQL TIMESTAMP value.

Specified by:
setTimestamp in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.

setTimestamp

public void setTimestamp(int parameterIndex,
                         Timestamp parameterValue,
                         Calendar calendar)
                  throws SQLException
Sets an input parameter to a java.sql.Timestamp value using a calendar other than the default. The driver converts this to an SQL TIMESTAMP value.

Specified by:
setTimestamp in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
calendar - The calendar.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, or the calendar is null.

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             InputStream parameterValue,
                             int length)
                      throws SQLException
Deprecated. Use setCharacterStream(int, Reader, int) instead.

Sets an input parameter to a Unicode stream value. The driver reads the data from the stream as needed until no more bytes are available. The driver converts this to an SQL VARCHAR value.

Note that the number of bytes in a Unicode stream can be computed as 2 multiplied by the number of characters plus 2 bytes for the byte-order mark. If an uneven number of bytes is specified, then Java will convert this to an empty String.

Specified by:
setUnicodeStream in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
length - The number of bytes in the stream.
Throws:
SQLException - If the statement is not open, the index is not valid, the parameter is not an input parameter, the length is not valid, the input stream does not contain all Unicode characters, or an error occurs while reading the input stream
See Also:
setCharacterStream(int, java.io.Reader, int)

setURL

public void setURL(int parameterIndex,
                   URL parameterValue)
            throws SQLException
Sets an input parameter to a URL value. The driver converts this to an SQL DATALINK value.

Specified by:
setURL in interface PreparedStatement
Parameters:
parameterIndex - The parameter index (1-based).
parameterValue - The parameter value or null to set the value to SQL NULL.
Throws:
SQLException - If the statement is not open, the index is not valid, or the parameter is not an input parameter.
Since:
Modification 5