TyrexCallableStatementImpl (Tyrex JavaDoc)

Overview

Package

Class

Tree

Deprecated

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tyrex.resource.jdbc.xa
Class TyrexCallableStatementImpl

java.lang.Object
  tyrex.resource.jdbc.xa.TyrexStatementImpl
      tyrex.resource.jdbc.xa.TyrexPreparedStatementImpl
          tyrex.resource.jdbc.xa.TyrexCallableStatementImpl

All Implemented Interfaces:: java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement

final class TyrexCallableStatementImpl
extends TyrexPreparedStatementImpl
implements java.sql.CallableStatement

This class implements java.sql.CallableStatement so that it returned when prepareCall is called on TyrexConnection object

The reason for this class is for the method java.sql.Statement#getConnection to return the correct connection.

This class is thread safe.

Author:: Riad Mohammed

Field Summary

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary
`(package private)`	`TyrexCallableStatementImpl(java.sql.CallableStatement statement, TyrexConnection connection)` Create the TyrexCallableStatementImpl with the specified arguments.

Method Summary
`void`	`addBatch()` Adds a set of parameters to this `PreparedStatement` object's batch of commands.
`void`	`addBatch(java.lang.String sql)` Adds an SQL command to the current batch of commmands for this `Statement` object.
`void`	`cancel()` Cancels this `Statement` object if both the DBMS and driver support aborting an SQL statement.
`void`	`clearBatch()` Makes the set of commands in the current batch empty.
`void`	`clearParameters()` Clears the current parameter values immediately.
`void`	`clearWarnings()` Clears all the warnings reported on this `Statement` object.
`void`	`close()` Releases this `Statement` object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
`protected void`	`closeResultSet()` Close the existing result set associated with the statement.
`boolean`	`execute()` Executes any kind of SQL statement.
`boolean`	`execute(java.lang.String sql)` Executes an SQL statement that may return multiple results.
`boolean`	`execute(java.lang.String sql, int autoGeneratedKeys)`
`boolean`	`execute(java.lang.String sql, int[] columnIndexes)`
`boolean`	`execute(java.lang.String sql, java.lang.String[] columnNames)`
`int[]`	`executeBatch()` Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
`java.sql.ResultSet`	`executeQuery()` Executes the SQL query in this `PreparedStatement` object and returns the result set generated by the query.
`java.sql.ResultSet`	`executeQuery(java.lang.String sql)` Executes an SQL statement that returns a single `ResultSet` object.
`int`	`executeUpdate()` Executes the SQL INSERT, UPDATE or DELETE statement in this `PreparedStatement` object.
`int`	`executeUpdate(java.lang.String sql)` Executes an SQL `INSERT`, `UPDATE` or `DELETE` statement.
`int`	`executeUpdate(java.lang.String sql, int autoGeneratedKeys)`
`int`	`executeUpdate(java.lang.String sql, int[] columnIndexes)`
`int`	`executeUpdate(java.lang.String sql, java.lang.String[] columnNames)`
`protected void`	`finalize()` Finalize the statement
`java.sql.Array`	`getArray(int i)` Gets the value of a JDBC `ARRAY` parameter as an `Array` object in the Java programming language.
`java.sql.Array`	`getArray(java.lang.String parameterName)`
`java.math.BigDecimal`	`getBigDecimal(int parameterIndex)` Gets the value of a JDBC `NUMERIC` parameter as a `java.math.BigDecimal` object with as many digits to the right of the decimal point as the value contains.
`java.math.BigDecimal`	`getBigDecimal(int parameterIndex, int scale)` Deprecated.
`java.math.BigDecimal`	`getBigDecimal(java.lang.String parameterName)`
`java.sql.Blob`	`getBlob(int i)` Gets the value of a JDBC `BLOB` parameter as a `Blob` object in the Java programming language.
`java.sql.Blob`	`getBlob(java.lang.String parameterName)`
`boolean`	`getBoolean(int parameterIndex)` Gets the value of a JDBC `BIT` parameter as a `boolean` in the Java programming language.
`boolean`	`getBoolean(java.lang.String parameterName)`
`byte`	`getByte(int parameterIndex)` Gets the value of a JDBC `TINYINT` parameter as a `byte` in the Java programming language.
`byte`	`getByte(java.lang.String parameterName)`
`byte[]`	`getBytes(int parameterIndex)` Gets the value of a JDBC `BINARY` or `VARBINARY` parameter as an array of `byte` values in the Java programming language.
`byte[]`	`getBytes(java.lang.String parameterName)`
`protected java.sql.CallableStatement`	`getCallableStatement()` Return the callable statement.
`java.sql.Clob`	`getClob(int i)` Gets the value of a JDBC `CLOB` parameter as a `Clob` object in the Java programming language.
`java.sql.Clob`	`getClob(java.lang.String parameterName)`
`java.sql.Connection`	`getConnection()` Returns the `Connection` object that produced this `Statement` object.
`java.sql.Date`	`getDate(int parameterIndex)` Gets the value of a JDBC `DATE` parameter as a `java.sql.Date` object.
`java.sql.Date`	`getDate(int parameterIndex, java.util.Calendar cal)` Gets the value of a JDBC `DATE` parameter as a `java.sql.Date` object, using the given `Calendar` object to construct the date.
`java.sql.Date`	`getDate(java.lang.String parameterName)`
`java.sql.Date`	`getDate(java.lang.String parameterName, java.util.Calendar cal)`
`double`	`getDouble(int parameterIndex)` Gets the value of a JDBC `DOUBLE` parameter as a `double` in the Java programming language.
`double`	`getDouble(java.lang.String parameterName)`
`int`	`getFetchDirection()` Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this `Statement` object.
`int`	`getFetchSize()` Retrieves the number of result set rows that is the default fetch size for result sets generated from this `Statement` object.
`float`	`getFloat(int parameterIndex)` Gets the value of a JDBC `FLOAT` parameter as a `float` in the Java programming language.
`float`	`getFloat(java.lang.String parameterName)`
`java.sql.ResultSet`	`getGeneratedKeys()`
`int`	`getInt(int parameterIndex)` Gets the value of a JDBC `INTEGER` parameter as an `int` in the Java programming language.
`int`	`getInt(java.lang.String parameterName)`
`long`	`getLong(int parameterIndex)` Gets the value of a JDBC `BIGINT` parameter as a `long` in the Java programming language.
`long`	`getLong(java.lang.String parameterName)`
`int`	`getMaxFieldSize()` Returns the maximum number of bytes allowed for any column value.
`int`	`getMaxRows()` Retrieves the maximum number of rows that a `ResultSet` object can contain.
`java.sql.ResultSetMetaData`	`getMetaData()` Gets the number, types and properties of a `ResultSet` object's columns.
`boolean`	`getMoreResults()` Moves to a `Statement` object's next result.
`boolean`	`getMoreResults(int current)`
`java.lang.Object`	`getObject(int parameterIndex)` Gets the value of a parameter as an `Object` in the Java programming language.
`java.lang.Object`	`getObject(int i, java.util.Map map)` Returns an object representing the value of OUT parameter `i` and uses `map` for the custom mapping of the parameter value.
`java.lang.Object`	`getObject(java.lang.String parameterName)`
`java.lang.Object`	`getObject(java.lang.String parameterName, java.util.Map map)`
`java.sql.ParameterMetaData`	`getParameterMetaData()`
`protected java.sql.PreparedStatement`	`getPreparedStatement()` Return the prepared statement.
`int`	`getQueryTimeout()` Retrieves the number of seconds the driver will wait for a `Statement` object to execute.
`java.sql.Ref`	`getRef(int i)` Gets the value of a JDBC `REF(<structured-type>)` parameter as a `Ref` object in the Java programming language.
`java.sql.Ref`	`getRef(java.lang.String parameterName)`
`java.sql.ResultSet`	`getResultSet()` Returns the current result as a `ResultSet` object.
`int`	`getResultSetConcurrency()` Retrieves the result set concurrency for `ResultSet` objects generated by this `Statement` object.
`int`	`getResultSetHoldability()`
`int`	`getResultSetType()` Retrieves the result set type for `ResultSet` objects generated by this `Statement` object.
`short`	`getShort(int parameterIndex)` Gets the value of a JDBC `SMALLINT` parameter as a `short` in the Java programming language.
`short`	`getShort(java.lang.String parameterName)`
`protected java.sql.Statement`	`getStatement()` Return the statement.
`java.lang.String`	`getString(int parameterIndex)` Retrieves the value of a JDBC `CHAR`, `VARCHAR`, or `LONGVARCHAR` parameter as a `String` in the Java programming language.
`java.lang.String`	`getString(java.lang.String parameterName)`
`java.sql.Time`	`getTime(int parameterIndex)` Get the value of a JDBC `TIME` parameter as a `java.sql.Time` object.
`java.sql.Time`	`getTime(int parameterIndex, java.util.Calendar cal)` Gets the value of a JDBC `TIME` parameter as a `java.sql.Time` object, using the given `Calendar` object to construct the time.
`java.sql.Time`	`getTime(java.lang.String parameterName)`
`java.sql.Time`	`getTime(java.lang.String parameterName, java.util.Calendar cal)`
`java.sql.Timestamp`	`getTimestamp(int parameterIndex)` Gets the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object.
`java.sql.Timestamp`	`getTimestamp(int parameterIndex, java.util.Calendar cal)` Gets the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object, using the given `Calendar` object to construct the `Timestamp` object.
`java.sql.Timestamp`	`getTimestamp(java.lang.String parameterName)`
`java.sql.Timestamp`	`getTimestamp(java.lang.String parameterName, java.util.Calendar cal)`
`int`	`getUpdateCount()` Returns the current result as an update count; if the result is a `ResultSet` object or there are no more results, -1 is returned.
`java.net.URL`	`getURL(int parameterIndex)`
`java.net.URL`	`getURL(java.lang.String parameterName)`
`java.sql.SQLWarning`	`getWarnings()` Retrieves the first warning reported by calls on this `Statement` object.
`void`	`registerOutParameter(int parameterIndex, int sqlType)` Registers the OUT parameter in ordinal position `parameterIndex` to the JDBC type `sqlType`.
`void`	`registerOutParameter(int parameterIndex, int sqlType, int scale)` Registers the parameter in ordinal position `parameterIndex` to be of JDBC type `sqlType`.
`void`	`registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName)` Registers the designated output parameter.
`void`	`registerOutParameter(java.lang.String parameterName, int sqlType)`
`void`	`registerOutParameter(java.lang.String parameterName, int sqlType, int scale)`
`void`	`registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName)`
`(package private) void`	`resultSetIsClosed(TyrexResultSetImpl resultSet)` The specified result set from this statement has been closed
`void`	`setArray(int i, java.sql.Array x)` Sets the designated parameter to the given `Array` object.
`void`	`setAsciiStream(int parameterIndex, java.io.InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`void`	`setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length)`
`void`	`setBigDecimal(int parameterIndex, java.math.BigDecimal x)` Sets the designated parameter to a `java.math.BigDecimal` value.
`void`	`setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)`
`void`	`setBinaryStream(int parameterIndex, java.io.InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`void`	`setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length)`
`void`	`setBlob(int i, java.sql.Blob x)` Sets the designated parameter to the given `Blob` object.
`void`	`setBoolean(int parameterIndex, boolean x)` Sets the designated parameter to a Java `boolean` value.
`void`	`setBoolean(java.lang.String parameterName, boolean x)`
`void`	`setByte(int parameterIndex, byte x)` Sets the designated parameter to a Java `byte` value.
`void`	`setByte(java.lang.String parameterName, byte x)`
`void`	`setBytes(int parameterIndex, byte[] x)` Sets the designated parameter to a Java array of bytes.
`void`	`setBytes(java.lang.String parameterName, byte[] x)`
`void`	`setCharacterStream(int parameterIndex, java.io.Reader reader, int length)` Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
`void`	`setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length)`
`void`	`setClob(int i, java.sql.Clob x)` Sets the designated parameter to the given `Clob` object.
`void`	`setCursorName(java.lang.String name)` Defines the SQL cursor name that will be used by subsequent `Statement` object `execute` methods.
`void`	`setDate(int parameterIndex, java.sql.Date x)` Sets the designated parameter to a value.
`void`	`setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal)` Sets the designated parameter to the given `java.sql.Date` value, using the given `Calendar` object.
`void`	`setDate(java.lang.String parameterName, java.sql.Date x)`
`void`	`setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)`
`void`	`setDouble(int parameterIndex, double x)` Sets the designated parameter to a Java `double` value.
`void`	`setDouble(java.lang.String parameterName, double x)`
`void`	`setEscapeProcessing(boolean enable)` Sets escape processing on or off.
`void`	`setFetchDirection(int direction)` Gives the driver a hint as to the direction in which the rows in a result set will be processed.
`void`	`setFetchSize(int rows)` Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
`void`	`setFloat(int parameterIndex, float x)` Sets the designated parameter to a Java `float` value.
`void`	`setFloat(java.lang.String parameterName, float x)`
`void`	`setInt(int parameterIndex, int x)` Sets the designated parameter to a Java `int` value.
`void`	`setInt(java.lang.String parameterName, int x)`
`void`	`setLong(int parameterIndex, long x)` Sets the designated parameter to a Java `long` value.
`void`	`setLong(java.lang.String parameterName, long x)`
`void`	`setMaxFieldSize(int max)` Sets the limit for the maximum number of bytes in a column to the given number of bytes.
`void`	`setMaxRows(int max)` Sets the limit for the maximum number of rows that any `ResultSet` object can contain to the given number.
`void`	`setNull(int parameterIndex, int sqlType)` Sets the designated parameter to SQL `NULL`.
`void`	`setNull(int paramIndex, int sqlType, java.lang.String typeName)` Sets the designated parameter to SQL `NULL`.
`void`	`setNull(java.lang.String parameterName, int sqlType)`
`void`	`setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)`
`void`	`setObject(int parameterIndex, java.lang.Object x)` Sets the value of the designated parameter using the given object.
`void`	`setObject(int parameterIndex, java.lang.Object x, int targetSqlType)` Sets the value of the designated parameter with the given object.
`void`	`setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale)` Sets the value of the designated parameter with the given object.
`void`	`setObject(java.lang.String parameterName, java.lang.Object x)`
`void`	`setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType)`
`void`	`setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)`
`void`	`setQueryTimeout(int seconds)` Sets the number of seconds the driver will wait for a `Statement` object to execute to the given number of seconds.
`void`	`setRef(int i, java.sql.Ref x)` Sets the designated parameter to the given `REF(<structured-type>)` value.
`protected java.sql.ResultSet`	`setResultSet(java.sql.ResultSet resultSet)` Set the result set as a result of executing a query on this statement.
`void`	`setShort(int parameterIndex, short x)` Sets the designated parameter to a Java `short` value.
`void`	`setShort(java.lang.String parameterName, short x)`
`void`	`setString(int parameterIndex, java.lang.String x)` Sets the designated parameter to a Java `String` value.
`void`	`setString(java.lang.String parameterName, java.lang.String x)`
`void`	`setTime(int parameterIndex, java.sql.Time x)` Sets the designated parameter to a `java.sql.Time` value.
`void`	`setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal)` Sets the designated parameter to the given `java.sql.Time` value, using the given `Calendar` object.
`void`	`setTime(java.lang.String parameterName, java.sql.Time x)`
`void`	`setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal)`
`void`	`setTimestamp(int parameterIndex, java.sql.Timestamp x)` Sets the designated parameter to a `java.sql.Timestamp` value.
`void`	`setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal)` Sets the designated parameter to the given `java.sql.Timestamp` value, using the given `Calendar` object.
`void`	`setTimestamp(java.lang.String parameterName, java.sql.Timestamp x)`
`void`	`setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal)`
`void`	`setUnicodeStream(int parameterIndex, java.io.InputStream x, int length)` Deprecated.
`void`	`setURL(int parameterIndex, java.net.URL x)`
`void`	`setURL(java.lang.String parameterName, java.net.URL val)`
`boolean`	`wasNull()` Indicates whether or not the last OUT parameter read had the value of SQL `NULL`.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Constructor Detail

TyrexCallableStatementImpl

TyrexCallableStatementImpl(java.sql.CallableStatement statement,
                           TyrexConnection connection)
                     throws java.sql.SQLException

Create the TyrexCallableStatementImpl with the specified arguments.
Parameters:: statement - the underlying statement; connection - the connection that created the statement.
Throws:: java.sql.SQLException - if there is a problem creating the statement

Method Detail

registerOutParameter

public final void registerOutParameter(int parameterIndex,
                                       int sqlType)
                                throws java.sql.SQLException

Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method getObject(int) retrieves the value.

Specified by:: registerOutParameter in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; sqlType - the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version of registerOutParameter that accepts a scale value should be used.
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: Types

registerOutParameter

public final void registerOutParameter(int parameterIndex,
                                       int sqlType,
                                       int scale)
                                throws java.sql.SQLException

Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Specified by:: registerOutParameter in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; sqlType - SQL type code defined by java.sql.Types.; scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: Types

wasNull

public final boolean wasNull()
                      throws java.sql.SQLException

Indicates whether or not the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getXXX method; otherwise, there is no value to use in determining whether it is null or not.

Specified by:: wasNull in interface java.sql.CallableStatement

Returns:: true if the last parameter read was SQL NULL; false otherwise
Throws:: java.sql.SQLException - if a database access error occurs

getString

public final java.lang.String getString(int parameterIndex)
                                 throws java.sql.SQLException

Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC CHAR, the String object returned has exactly the same value the JDBC CHAR value had in the database, including any padding added by the database.

Specified by:: getString in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getBoolean

public final boolean getBoolean(int parameterIndex)
                         throws java.sql.SQLException

Gets the value of a JDBC BIT parameter as a boolean in the Java programming language.

Specified by:: getBoolean in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is false.
Throws:: java.sql.SQLException - if a database access error occurs

getByte

public final byte getByte(int parameterIndex)
                   throws java.sql.SQLException

Gets the value of a JDBC TINYINT parameter as a byte in the Java programming language.

Specified by:: getByte in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: java.sql.SQLException - if a database access error occurs

getShort

public final short getShort(int parameterIndex)
                     throws java.sql.SQLException

Gets the value of a JDBC SMALLINT parameter as a short in the Java programming language.

Specified by:: getShort in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: java.sql.SQLException - if a database access error occurs

getInt

public final int getInt(int parameterIndex)
                 throws java.sql.SQLException

Gets the value of a JDBC INTEGER parameter as an int in the Java programming language.

Specified by:: getInt in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: java.sql.SQLException - if a database access error occurs

getLong

public final long getLong(int parameterIndex)
                   throws java.sql.SQLException

Gets the value of a JDBC BIGINT parameter as a long in the Java programming language.

Specified by:: getLong in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: java.sql.SQLException - if a database access error occurs

getFloat

public final float getFloat(int parameterIndex)
                     throws java.sql.SQLException

Gets the value of a JDBC FLOAT parameter as a float in the Java programming language.

Specified by:: getFloat in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: java.sql.SQLException - if a database access error occurs

getDouble

public final double getDouble(int parameterIndex)
                       throws java.sql.SQLException

Gets the value of a JDBC DOUBLE parameter as a double in the Java programming language.

Specified by:: getDouble in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: java.sql.SQLException - if a database access error occurs

getBigDecimal

public final java.math.BigDecimal getBigDecimal(int parameterIndex,
                                                int scale)
                                         throws java.sql.SQLException

Deprecated.

Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

Specified by:: getBigDecimal in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; scale - the number of digits to the right of the decimal point
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getBytes

public final byte[] getBytes(int parameterIndex)
                      throws java.sql.SQLException

Gets the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Specified by:: getBytes in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getDate

public final java.sql.Date getDate(int parameterIndex)
                            throws java.sql.SQLException

Gets the value of a JDBC DATE parameter as a java.sql.Date object.

Specified by:: getDate in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getTime

public final java.sql.Time getTime(int parameterIndex)
                            throws java.sql.SQLException

Get the value of a JDBC TIME parameter as a java.sql.Time object.

Specified by:: getTime in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getTimestamp

public final java.sql.Timestamp getTimestamp(int parameterIndex)
                                      throws java.sql.SQLException

Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Specified by:: getTimestamp in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getObject

public final java.lang.Object getObject(int parameterIndex)
                                 throws java.sql.SQLException

Gets the value of a parameter as an Object in the Java programming language.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

Specified by:: getObject in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: A java.lang.Object holding the OUT parameter value.
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: Types

getBigDecimal

public final java.math.BigDecimal getBigDecimal(int parameterIndex)
                                         throws java.sql.SQLException

Gets the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

Specified by:: getBigDecimal in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value in full precision. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getObject

public final java.lang.Object getObject(int i,
                                        java.util.Map map)
                                 throws java.sql.SQLException

Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

Specified by:: getObject in interface java.sql.CallableStatement

Parameters:: i - the first parameter is 1, the second is 2, and so on; map - the mapping from SQL type names to Java classes
Returns:: a java.lang.Object holding the OUT parameter value
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getRef

public final java.sql.Ref getRef(int i)
                          throws java.sql.SQLException

Gets the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.

Specified by:: getRef in interface java.sql.CallableStatement

Parameters:: i - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getBlob

public final java.sql.Blob getBlob(int i)
                            throws java.sql.SQLException

Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.

Specified by:: getBlob in interface java.sql.CallableStatement

Parameters:: i - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getClob

public final java.sql.Clob getClob(int i)
                            throws java.sql.SQLException

Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.

Specified by:: getClob in interface java.sql.CallableStatement

Parameters:: i - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getArray

public final java.sql.Array getArray(int i)
                              throws java.sql.SQLException

Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.

Specified by:: getArray in interface java.sql.CallableStatement

Parameters:: i - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getDate

public final java.sql.Date getDate(int parameterIndex,
                                   java.util.Calendar cal)
                            throws java.sql.SQLException

Gets the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Specified by:: getDate in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; cal - the Calendar object the driver will use to construct the date
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getTime

public final java.sql.Time getTime(int parameterIndex,
                                   java.util.Calendar cal)
                            throws java.sql.SQLException

Gets the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Specified by:: getTime in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; cal - the Calendar object the driver will use to construct the time
Returns:: the parameter value; if the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

getTimestamp

public final java.sql.Timestamp getTimestamp(int parameterIndex,
                                             java.util.Calendar cal)
                                      throws java.sql.SQLException

Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object. With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Specified by:: getTimestamp in interface java.sql.CallableStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; cal - the Calendar object the driver will use to construct the timestamp
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: java.sql.SQLException - if a database access error occurs

registerOutParameter

public final void registerOutParameter(int paramIndex,
                                       int sqlType,
                                       java.lang.String typeName)
                                throws java.sql.SQLException

Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types. Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getXXX method whose Java type XXX corresponds to the parameter's registered SQL type.

Specified by:: registerOutParameter in interface java.sql.CallableStatement

Parameters:: sqlType - a value from Types; typeName - the fully-qualified name of an SQL structured type
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: Types, What Is in the JDBC 2.0 API

getCallableStatement

protected final java.sql.CallableStatement getCallableStatement()
                                                         throws java.sql.SQLException

Return the callable statement.

Returns:: the callable statement.
Throws:: java.sql.SQLException - if the statement is closed.

getArray

public java.sql.Array getArray(java.lang.String parameterName)
                        throws java.sql.SQLException

Specified by:: getArray in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
                                   throws java.sql.SQLException

Specified by:: getBigDecimal in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getBlob

public java.sql.Blob getBlob(java.lang.String parameterName)
                      throws java.sql.SQLException

Specified by:: getBlob in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getBoolean

public boolean getBoolean(java.lang.String parameterName)
                   throws java.sql.SQLException

Specified by:: getBoolean in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getByte

public byte getByte(java.lang.String parameterName)
             throws java.sql.SQLException

Specified by:: getByte in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getBytes

public byte[] getBytes(java.lang.String parameterName)
                throws java.sql.SQLException

Specified by:: getBytes in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getClob

public java.sql.Clob getClob(java.lang.String parameterName)
                      throws java.sql.SQLException

Specified by:: getClob in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getDate

public java.sql.Date getDate(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.SQLException

Specified by:: getDate in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getDate

public java.sql.Date getDate(java.lang.String parameterName)
                      throws java.sql.SQLException

Specified by:: getDate in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getDouble

public double getDouble(java.lang.String parameterName)
                 throws java.sql.SQLException

Specified by:: getDouble in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getFloat

public float getFloat(java.lang.String parameterName)
               throws java.sql.SQLException

Specified by:: getFloat in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getInt

public int getInt(java.lang.String parameterName)
           throws java.sql.SQLException

Specified by:: getInt in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getLong

public long getLong(java.lang.String parameterName)
             throws java.sql.SQLException

Specified by:: getLong in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getObject

public java.lang.Object getObject(java.lang.String parameterName,
                                  java.util.Map map)
                           throws java.sql.SQLException

Specified by:: getObject in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getObject

public java.lang.Object getObject(java.lang.String parameterName)
                           throws java.sql.SQLException

Specified by:: getObject in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getRef

public java.sql.Ref getRef(java.lang.String parameterName)
                    throws java.sql.SQLException

Specified by:: getRef in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getShort

public short getShort(java.lang.String parameterName)
               throws java.sql.SQLException

Specified by:: getShort in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getString

public java.lang.String getString(java.lang.String parameterName)
                           throws java.sql.SQLException

Specified by:: getString in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getTime

public java.sql.Time getTime(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.SQLException

Specified by:: getTime in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getTime

public java.sql.Time getTime(java.lang.String parameterName)
                      throws java.sql.SQLException

Specified by:: getTime in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName,
                                       java.util.Calendar cal)
                                throws java.sql.SQLException

Specified by:: getTimestamp in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName)
                                throws java.sql.SQLException

Specified by:: getTimestamp in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getURL

public java.net.URL getURL(int parameterIndex)
                    throws java.sql.SQLException

Specified by:: getURL in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

getURL

public java.net.URL getURL(java.lang.String parameterName)
                    throws java.sql.SQLException

Specified by:: getURL in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 int scale)
                          throws java.sql.SQLException

Specified by:: registerOutParameter in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 java.lang.String typeName)
                          throws java.sql.SQLException

Specified by:: registerOutParameter in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType)
                          throws java.sql.SQLException

Specified by:: registerOutParameter in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException

Specified by:: setAsciiStream in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setBigDecimal

public void setBigDecimal(java.lang.String parameterName,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException

Specified by:: setBigDecimal in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException

Specified by:: setBinaryStream in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setBoolean

public void setBoolean(java.lang.String parameterName,
                       boolean x)
                throws java.sql.SQLException

Specified by:: setBoolean in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setByte

public void setByte(java.lang.String parameterName,
                    byte x)
             throws java.sql.SQLException

Specified by:: setByte in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setBytes

public void setBytes(java.lang.String parameterName,
                     byte[] x)
              throws java.sql.SQLException

Specified by:: setBytes in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setCharacterStream

public void setCharacterStream(java.lang.String parameterName,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException

Specified by:: setCharacterStream in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

Specified by:: setDate in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x)
             throws java.sql.SQLException

Specified by:: setDate in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setDouble

public void setDouble(java.lang.String parameterName,
                      double x)
               throws java.sql.SQLException

Specified by:: setDouble in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setFloat

public void setFloat(java.lang.String parameterName,
                     float x)
              throws java.sql.SQLException

Specified by:: setFloat in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setInt

public void setInt(java.lang.String parameterName,
                   int x)
            throws java.sql.SQLException

Specified by:: setInt in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setLong

public void setLong(java.lang.String parameterName,
                    long x)
             throws java.sql.SQLException

Specified by:: setLong in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.SQLException

Specified by:: setNull in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType)
             throws java.sql.SQLException

Specified by:: setNull in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException

Specified by:: setObject in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException

Specified by:: setObject in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x)
               throws java.sql.SQLException

Specified by:: setObject in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setShort

public void setShort(java.lang.String parameterName,
                     short x)
              throws java.sql.SQLException

Specified by:: setShort in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setString

public void setString(java.lang.String parameterName,
                      java.lang.String x)
               throws java.sql.SQLException

Specified by:: setString in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

Specified by:: setTime in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x)
             throws java.sql.SQLException

Specified by:: setTime in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException

Specified by:: setTimestamp in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x)
                  throws java.sql.SQLException

Specified by:: setTimestamp in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

setURL

public void setURL(java.lang.String parameterName,
                   java.net.URL val)
            throws java.sql.SQLException

Specified by:: setURL in interface java.sql.CallableStatement

Throws:: java.sql.SQLException

executeQuery

public final java.sql.ResultSet executeQuery()
                                      throws java.sql.SQLException

Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.

Specified by:: executeQuery in interface java.sql.PreparedStatement

Returns:: a ResultSet object that contains the data produced by the query; never null
Throws:: java.sql.SQLException - if a database access error occurs

executeUpdate

public final int executeUpdate()
                        throws java.sql.SQLException

Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.

Specified by:: executeUpdate in interface java.sql.PreparedStatement

Returns:: either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing
Throws:: java.sql.SQLException - if a database access error occurs

setNull

public final void setNull(int parameterIndex,
                          int sqlType)
                   throws java.sql.SQLException

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Specified by:: setNull in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; sqlType - the SQL type code defined in java.sql.Types
Throws:: java.sql.SQLException - if a database access error occurs

setBoolean

public final void setBoolean(int parameterIndex,
                             boolean x)
                      throws java.sql.SQLException

Sets the designated parameter to a Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

Specified by:: setBoolean in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setByte

public final void setByte(int parameterIndex,
                          byte x)
                   throws java.sql.SQLException

Sets the designated parameter to a Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Specified by:: setByte in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setShort

public final void setShort(int parameterIndex,
                           short x)
                    throws java.sql.SQLException

Sets the designated parameter to a Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Specified by:: setShort in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setInt

public final void setInt(int parameterIndex,
                         int x)
                  throws java.sql.SQLException

Sets the designated parameter to a Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Specified by:: setInt in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setLong

public final void setLong(int parameterIndex,
                          long x)
                   throws java.sql.SQLException

Sets the designated parameter to a Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Specified by:: setLong in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setFloat

public final void setFloat(int parameterIndex,
                           float x)
                    throws java.sql.SQLException

Sets the designated parameter to a Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Specified by:: setFloat in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setDouble

public final void setDouble(int parameterIndex,
                            double x)
                     throws java.sql.SQLException

Sets the designated parameter to a Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Specified by:: setDouble in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setBigDecimal

public final void setBigDecimal(int parameterIndex,
                                java.math.BigDecimal x)
                         throws java.sql.SQLException

Sets the designated parameter to a java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Specified by:: setBigDecimal in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setString

public final void setString(int parameterIndex,
                            java.lang.String x)
                     throws java.sql.SQLException

Sets the designated parameter to a Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Specified by:: setString in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setBytes

public final void setBytes(int parameterIndex,
                           byte[] x)
                    throws java.sql.SQLException

Sets the designated parameter to a Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Specified by:: setBytes in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setDate

public final void setDate(int parameterIndex,
                          java.sql.Date x)
                   throws java.sql.SQLException

Sets the designated parameter to a value. The driver converts this to an SQL DATE value when it sends it to the database.

Specified by:: setDate in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setTime

public final void setTime(int parameterIndex,
                          java.sql.Time x)
                   throws java.sql.SQLException

Sets the designated parameter to a java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Specified by:: setTime in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setTimestamp

public final void setTimestamp(int parameterIndex,
                               java.sql.Timestamp x)
                        throws java.sql.SQLException

Sets the designated parameter to a java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Specified by:: setTimestamp in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value
Throws:: java.sql.SQLException - if a database access error occurs

setAsciiStream

public final void setAsciiStream(int parameterIndex,
                                 java.io.InputStream x,
                                 int length)
                          throws java.sql.SQLException

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:: setAsciiStream in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the Java input stream that contains the ASCII parameter value; length - the number of bytes in the stream
Throws:: java.sql.SQLException - if a database access error occurs

setUnicodeStream

public final void setUnicodeStream(int parameterIndex,
                                   java.io.InputStream x,
                                   int length)
                            throws java.sql.SQLException

Deprecated.

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format. The byte format of the Unicode stream must be Java UTF-8, as defined in the Java Virtual Machine Specification.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:: setUnicodeStream in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the java input stream which contains the UNICODE parameter value; length - the number of bytes in the stream
Throws:: java.sql.SQLException - if a database access error occurs

setBinaryStream

public final void setBinaryStream(int parameterIndex,
                                  java.io.InputStream x,
                                  int length)
                           throws java.sql.SQLException

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:: setBinaryStream in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the java input stream which contains the binary parameter value; length - the number of bytes in the stream
Throws:: java.sql.SQLException - if a database access error occurs

clearParameters

public final void clearParameters()
                           throws java.sql.SQLException

Clears the current parameter values immediately.

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.

Specified by:: clearParameters in interface java.sql.PreparedStatement

Throws:: java.sql.SQLException - if a database access error occurs

setObject

public final void setObject(int parameterIndex,
                            java.lang.Object x,
                            int targetSqlType,
                            int scale)
                     throws java.sql.SQLException

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 datatabase- specific abstract data types.

Specified by:: setObject in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the object containing the input parameter value; targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.; scale - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: Types

setObject

public final void setObject(int parameterIndex,
                            java.lang.Object x,
                            int targetSqlType)
                     throws java.sql.SQLException

Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.

Specified by:: setObject in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the object containing the input parameter value; targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database
Throws:: java.sql.SQLException - if a database access error occurs

setObject

public final void setObject(int parameterIndex,
                            java.lang.Object x)
                     throws java.sql.SQLException

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, then 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.

Specified by:: setObject in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the object containing the input parameter value
Throws:: java.sql.SQLException - if a database access error occurs

execute

public final boolean execute()
                      throws java.sql.SQLException

Executes any kind of SQL statement. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery and executeUpdate.

Specified by:: execute in interface java.sql.PreparedStatement

Throws:: java.sql.SQLException - if a database access error occurs
See Also:: Statement.execute(java.lang.String)

addBatch

public final void addBatch()
                    throws java.sql.SQLException

Adds a set of parameters to this PreparedStatement object's batch of commands.

Specified by:: addBatch in interface java.sql.PreparedStatement

Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: Statement.addBatch(java.lang.String), What Is in the JDBC 2.0 API

setCharacterStream

public final void setCharacterStream(int parameterIndex,
                                     java.io.Reader reader,
                                     int length)
                              throws java.sql.SQLException

Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:: setCharacterStream in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; length - the number of characters in the stream
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setRef

public final void setRef(int i,
                         java.sql.Ref x)
                  throws java.sql.SQLException

Sets the designated parameter to the given REF(<structured-type>) value.

Specified by:: setRef in interface java.sql.PreparedStatement

Parameters:: i - the first parameter is 1, the second is 2, ...; x - an SQL REF value
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setBlob

public final void setBlob(int i,
                          java.sql.Blob x)
                   throws java.sql.SQLException

Sets the designated parameter to the given Blob object.

Specified by:: setBlob in interface java.sql.PreparedStatement

Parameters:: i - the first parameter is 1, the second is 2, ...; x - a Blob object that maps an SQL BLOB value
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setClob

public final void setClob(int i,
                          java.sql.Clob x)
                   throws java.sql.SQLException

Sets the designated parameter to the given Clob object.

Specified by:: setClob in interface java.sql.PreparedStatement

Parameters:: i - the first parameter is 1, the second is 2, ...; x - a Clob object that maps an SQL CLOB value
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setArray

public final void setArray(int i,
                           java.sql.Array x)
                    throws java.sql.SQLException

Sets the designated parameter to the given Array object. Sets an Array parameter.

Specified by:: setArray in interface java.sql.PreparedStatement

Parameters:: i - the first parameter is 1, the second is 2, ...; x - an Array object that maps an SQL ARRAY value
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getMetaData

public final java.sql.ResultSetMetaData getMetaData()
                                             throws java.sql.SQLException

Gets the number, types and properties of a ResultSet object's columns.

Specified by:: getMetaData in interface java.sql.PreparedStatement

Returns:: the description of a ResultSet object's columns
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setDate

public final void setDate(int parameterIndex,
                          java.sql.Date x,
                          java.util.Calendar cal)
                   throws java.sql.SQLException

Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:: setDate in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value; cal - the Calendar object the driver will use to construct the date
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setTime

public final void setTime(int parameterIndex,
                          java.sql.Time x,
                          java.util.Calendar cal)
                   throws java.sql.SQLException

Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:: setTime in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value; cal - the Calendar object the driver will use to construct the time
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setTimestamp

public final void setTimestamp(int parameterIndex,
                               java.sql.Timestamp x,
                               java.util.Calendar cal)
                        throws java.sql.SQLException

Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:: setTimestamp in interface java.sql.PreparedStatement

Parameters:: parameterIndex - the first parameter is 1, the second is 2, ...; x - the parameter value; cal - the Calendar object the driver will use to construct the timestamp
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setNull

public final void setNull(int paramIndex,
                          int sqlType,
                          java.lang.String typeName)
                   throws java.sql.SQLException

Sets the designated parameter to SQL NULL. This version of the method setNull should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

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.

Specified by:: setNull in interface java.sql.PreparedStatement

Parameters:: sqlType - a value from java.sql.Types; typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getPreparedStatement

protected final java.sql.PreparedStatement getPreparedStatement()
                                                         throws java.sql.SQLException

Return the prepared statement.

Returns:: the prepared statement.
Throws:: java.sql.SQLException - if the prepared statement is closed

getParameterMetaData

public final java.sql.ParameterMetaData getParameterMetaData()
                                                      throws java.sql.SQLException

Specified by:: getParameterMetaData in interface java.sql.PreparedStatement

Throws:: java.sql.SQLException

setURL

public final void setURL(int parameterIndex,
                         java.net.URL x)
                  throws java.sql.SQLException

Specified by:: setURL in interface java.sql.PreparedStatement

Throws:: java.sql.SQLException

executeQuery

public final java.sql.ResultSet executeQuery(java.lang.String sql)
                                      throws java.sql.SQLException

Executes an SQL statement that returns a single ResultSet object.

Specified by:: executeQuery in interface java.sql.Statement

Parameters:: sql - typically this is a static SQL SELECT statement
Returns:: a ResultSet object that contains the data produced by the given query; never null
Throws:: java.sql.SQLException - if a database access error occurs

setResultSet

protected java.sql.ResultSet setResultSet(java.sql.ResultSet resultSet)

Set the result set as a result of executing a query on this statement.

This method assumes that the existing result is closed.

If the specified result set is of type TyrexResultSetImpl then the result set of the statement is set to the specified result set. Else the specified result set is wrapped in a TyrexResultSetImpl which is then set as the result set of the statement.

Parameters:: resultSet - the underlying result set of the underlying statement. Can be null.
Returns:: the result set to be returned as the result of a query.
See Also:: TyrexStatementImpl.closeResultSet()

closeResultSet

protected void closeResultSet()

Close the existing result set associated with the statement. If there is no existing result set nothing is done.

This method assumes that the calling method synchronizes on this instance.

Any exceptions caused by closing the result set are ignored.

executeUpdate

public final int executeUpdate(java.lang.String sql)
                        throws java.sql.SQLException

Executes an SQL INSERT, UPDATE or DELETE statement. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.

Specified by:: executeUpdate in interface java.sql.Statement

Parameters:: sql - an SQL INSERT, UPDATE or DELETE statement or an SQL statement that returns nothing
Returns:: either the row count for INSERT, UPDATE or DELETE statements, or 0 for SQL statements that return nothing
Throws:: java.sql.SQLException - if a database access error occurs

close

public final void close()
                 throws java.sql.SQLException

Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.

Note: A 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.

Specified by:: close in interface java.sql.Statement

Throws:: java.sql.SQLException - if a database access error occurs

getMaxFieldSize

public final int getMaxFieldSize()
                          throws java.sql.SQLException

Returns the maximum number of bytes allowed for any column value. This limit is the maximum number of bytes that can be returned for any column value. The limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.

Specified by:: getMaxFieldSize in interface java.sql.Statement

Returns:: the current max column size limit; zero means unlimited
Throws:: java.sql.SQLException - if a database access error occurs

setMaxFieldSize

public final void setMaxFieldSize(int max)
                           throws java.sql.SQLException

Sets the limit for the maximum number of bytes in a column to the given number of bytes. This is the maximum number of bytes that can be returned for any column value. This limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.

Specified by:: setMaxFieldSize in interface java.sql.Statement

Parameters:: max - the new max column size limit; zero means unlimited
Throws:: java.sql.SQLException - if a database access error occurs

getMaxRows

public final int getMaxRows()
                     throws java.sql.SQLException

Retrieves the maximum number of rows that a ResultSet object can contain. If the limit is exceeded, the excess rows are silently dropped.

Specified by:: getMaxRows in interface java.sql.Statement

Returns:: the current max row limit; zero means unlimited
Throws:: java.sql.SQLException - if a database access error occurs

setMaxRows

public final void setMaxRows(int max)
                      throws java.sql.SQLException

Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.

Specified by:: setMaxRows in interface java.sql.Statement

Parameters:: max - the new max rows limit; zero means unlimited
Throws:: java.sql.SQLException - if a database access error occurs

setEscapeProcessing

public final void setEscapeProcessing(boolean enable)
                               throws java.sql.SQLException

Sets escape processing on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database. Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing for prepared statements will have no effect.

Specified by:: setEscapeProcessing in interface java.sql.Statement

Parameters:: enable - true to enable; false to disable
Throws:: java.sql.SQLException - if a database access error occurs

getQueryTimeout

public final int getQueryTimeout()
                          throws java.sql.SQLException

Retrieves the number of seconds the driver will wait for a Statement object to execute. If the limit is exceeded, a SQLException is thrown.

Specified by:: getQueryTimeout in interface java.sql.Statement

Returns:: the current query timeout limit in seconds; zero means unlimited
Throws:: java.sql.SQLException - if a database access error occurs

setQueryTimeout

public final void setQueryTimeout(int seconds)
                           throws java.sql.SQLException

Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. If the limit is exceeded, an SQLException is thrown.

Specified by:: setQueryTimeout in interface java.sql.Statement

Parameters:: seconds - the new query timeout limit in seconds; zero means unlimited
Throws:: java.sql.SQLException - if a database access error occurs

cancel

public final void cancel()
                  throws java.sql.SQLException

Cancels this Statement object if both the DBMS and driver support aborting an SQL statement. This method can be used by one thread to cancel a statement that is being executed by another thread.

Specified by:: cancel in interface java.sql.Statement

Throws:: java.sql.SQLException - if a database access error occurs

getWarnings

public final java.sql.SQLWarning getWarnings()
                                      throws java.sql.SQLException

Retrieves the first warning reported by calls on this Statement object. Subsequent Statement object warnings will be chained to this SQLWarning object.

The warning chain is automatically cleared each time a statement is (re)executed.

Note: If you are processing a ResultSet object, any warnings associated with reads on that ResultSet object will be chained on it.

Specified by:: getWarnings in interface java.sql.Statement

Returns:: the first SQLWarning object or null
Throws:: java.sql.SQLException - if a database access error occurs

clearWarnings

public final void clearWarnings()
                         throws java.sql.SQLException

Clears all the warnings reported on this Statement object. After a call to this method, the method getWarnings will return null until a new warning is reported for this Statement object.

Specified by:: clearWarnings in interface java.sql.Statement

Throws:: java.sql.SQLException - if a database access error occurs

setCursorName

public final void setCursorName(java.lang.String name)
                         throws java.sql.SQLException

Defines the SQL cursor name that will be used by subsequent Statement object execute methods. This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet object generated by this statement. If the database doesn't support positioned update/delete, this method is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail.

Note: By definition, positioned update/delete execution must be done by a different Statement object than the one which generated the ResultSet object being used for positioning. Also, cursor names must be unique within a connection.

Specified by:: setCursorName in interface java.sql.Statement

Parameters:: name - the new cursor name, which must be unique within a connection
Throws:: java.sql.SQLException - if a database access error occurs

execute

public final boolean execute(java.lang.String sql)
                      throws java.sql.SQLException

Executes an SQL statement that may return multiple results. 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 methods execute, getMoreResults, getResultSet, and getUpdateCount let you navigate through multiple results. The execute method executes an SQL statement and indicates the form of the first result. You can then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).

Specified by:: execute in interface java.sql.Statement

Parameters:: sql - any SQL statement
Returns:: true if the next result is a ResultSet object; false if it is an update count or there are no more results
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: TyrexStatementImpl.getResultSet(), TyrexStatementImpl.getUpdateCount(), TyrexStatementImpl.getMoreResults()

getResultSet

public final java.sql.ResultSet getResultSet()
                                      throws java.sql.SQLException

Returns the current result as a ResultSet object. This method should be called only once per result.

Specified by:: getResultSet in interface java.sql.Statement

Returns:: the current result as a ResultSet object; null if the result is an update count or there are no more results
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: TyrexStatementImpl.execute(java.lang.String)

getUpdateCount

public final int getUpdateCount()
                         throws java.sql.SQLException

Returns the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned. This method should be called only once per result.

Specified by:: getUpdateCount in interface java.sql.Statement

Returns:: the current result as an update count; -1 if the current result is a ResultSet object or there are no more results
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: TyrexStatementImpl.execute(java.lang.String)

getMoreResults

public final boolean getMoreResults()
                             throws java.sql.SQLException

Moves to a Statement object's next result. It returns true if this result is a ResultSet object. This method also implicitly closes any current ResultSet object obtained with the method getResultSet.

There are no more results when the following is true:

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

Specified by:: getMoreResults in interface java.sql.Statement

Returns:: true if the next result is a ResultSet object; false if it is an update count or there are no more results
Throws:: java.sql.SQLException - if a database access error occurs
See Also:: TyrexStatementImpl.execute(java.lang.String)

setFetchDirection

public final void setFetchDirection(int direction)
                             throws java.sql.SQLException

Gives the driver a hint as to the direction in which the rows in a result set will be processed. The hint applies only to result sets created using this Statement object. The default value is ResultSet.FETCH_FORWARD.

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.

Specified by:: setFetchDirection in interface java.sql.Statement

Parameters:: direction - the initial direction for processing rows
Throws:: java.sql.SQLException - if a database access error occurs or the given direction is not one of ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getFetchDirection

public final int getFetchDirection()
                            throws java.sql.SQLException

Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object. If this Statement object has not set a fetch direction by calling the method setFetchDirection, the return value is implementation-specific.

Specified by:: getFetchDirection in interface java.sql.Statement

Returns:: the default fetch direction for result sets generated from this Statement object
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

setFetchSize

public final void setFetchSize(int rows)
                        throws java.sql.SQLException

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified affects only result sets created using this statement. If the value specified is zero, then the hint is ignored. The default value is zero.

Specified by:: setFetchSize in interface java.sql.Statement

Parameters:: rows - the number of rows to fetch
Throws:: java.sql.SQLException - if a database access error occurs, or the condition 0 <= rows <= this.getMaxRows() is not satisfied.
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getFetchSize

public final int getFetchSize()
                       throws java.sql.SQLException

Retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object. If this Statement object has not set a fetch size by calling the method setFetchSize, the return value is implementation-specific.

Specified by:: getFetchSize in interface java.sql.Statement

Returns:: the default fetch size for result sets generated from this Statement object
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getResultSetConcurrency

public final int getResultSetConcurrency()
                                  throws java.sql.SQLException

Retrieves the result set concurrency for ResultSet objects generated by this Statement object.

Specified by:: getResultSetConcurrency in interface java.sql.Statement

Returns:: either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Throws:: java.sql.SQLException
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

getResultSetType

public final int getResultSetType()
                           throws java.sql.SQLException

Retrieves the result set type for ResultSet objects generated by this Statement object.

Specified by:: getResultSetType in interface java.sql.Statement

Returns:: one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Throws:: java.sql.SQLException
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

addBatch

public final void addBatch(java.lang.String sql)
                    throws java.sql.SQLException

Adds an SQL command to the current batch of commmands for this Statement object. This method is optional.

Specified by:: addBatch in interface java.sql.Statement

Parameters:: sql - typically this is a static SQL INSERT or UPDATE statement
Throws:: java.sql.SQLException - if a database access error occurs, or the driver does not support batch statements
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

clearBatch

public final void clearBatch()
                      throws java.sql.SQLException

Makes the set of commands in the current batch empty. This method is optional.

Specified by:: clearBatch in interface java.sql.Statement

Throws:: java.sql.SQLException - if a database access error occurs or the driver does not support batch statements
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

executeBatch

public final int[] executeBatch()
                         throws java.sql.SQLException

Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. The int elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the method executeBatch may be one of the following:

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
A value of -2 -- indicates that the command was processed successfully but that the number of rows affected is unknown
If one of the commands in a batch update fails to execute properly, this method throws a BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts will contain as many elements as there are commands in the batch, and at least one of the elements will be the following:
A value of -3 -- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails

A driver is not required to implement this method. The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess commands in a batch update after a BatchUpdateException obejct has been thrown.

Specified by:: executeBatch in interface java.sql.Statement

Returns:: an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.
Throws:: java.sql.SQLException - if a database access error occurs or the driver does not support batch statements. Throws BatchUpdateException (a subclass of SQLException) if one of the commands sent to the database fails to execute properly or attempts to return a result set.
Since:: 1.3
See Also:: What Is in the JDBC 2.0 API

getConnection

public final java.sql.Connection getConnection()
                                        throws java.sql.SQLException

Returns the Connection object that produced this Statement object.

Specified by:: getConnection in interface java.sql.Statement

Returns:: the connection that produced this statement
Throws:: java.sql.SQLException - if a database access error occurs
Since:: 1.2
See Also:: What Is in the JDBC 2.0 API

finalize

protected void finalize()
                 throws java.lang.Throwable

Finalize the statement

Throws:: java.lang.Throwable

getStatement

protected final java.sql.Statement getStatement()
                                         throws java.sql.SQLException

Return the statement.

This method assumes that the calling method synchronizes on this instance.

Returns:: the statement.
Throws:: java.sql.SQLException - if either the statement or connection has been closed.

resultSetIsClosed

final void resultSetIsClosed(TyrexResultSetImpl resultSet)

The specified result set from this statement has been closed

Parameters:: resultSet - the result set

executeUpdate

public final int executeUpdate(java.lang.String sql,
                               int[] columnIndexes)
                        throws java.sql.SQLException

Specified by:: executeUpdate in interface java.sql.Statement

Throws:: java.sql.SQLException

executeUpdate

public final int executeUpdate(java.lang.String sql,
                               java.lang.String[] columnNames)
                        throws java.sql.SQLException

Specified by:: executeUpdate in interface java.sql.Statement

Throws:: java.sql.SQLException

execute

public final boolean execute(java.lang.String sql,
                             int autoGeneratedKeys)
                      throws java.sql.SQLException

Specified by:: execute in interface java.sql.Statement

Throws:: java.sql.SQLException

execute

public final boolean execute(java.lang.String sql,
                             int[] columnIndexes)
                      throws java.sql.SQLException

Specified by:: execute in interface java.sql.Statement

Throws:: java.sql.SQLException

execute

public final boolean execute(java.lang.String sql,
                             java.lang.String[] columnNames)
                      throws java.sql.SQLException

Specified by:: execute in interface java.sql.Statement

Throws:: java.sql.SQLException

executeUpdate

public final int executeUpdate(java.lang.String sql,
                               int autoGeneratedKeys)
                        throws java.sql.SQLException

Specified by:: executeUpdate in interface java.sql.Statement

Throws:: java.sql.SQLException

getGeneratedKeys

public final java.sql.ResultSet getGeneratedKeys()
                                          throws java.sql.SQLException

Specified by:: getGeneratedKeys in interface java.sql.Statement

Throws:: java.sql.SQLException

getMoreResults

public final boolean getMoreResults(int current)
                             throws java.sql.SQLException

Specified by:: getMoreResults in interface java.sql.Statement

Throws:: java.sql.SQLException

getResultSetHoldability

public final int getResultSetHoldability()
                                  throws java.sql.SQLException

Specified by:: getResultSetHoldability in interface java.sql.Statement

Throws:: java.sql.SQLException

Overview

Package

Class

Tree

Deprecated

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tyrex.resource.jdbc.xa Class TyrexCallableStatementImpl

TyrexCallableStatementImpl

registerOutParameter

registerOutParameter

wasNull

getString

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getBigDecimal

getBytes

getDate

getTime

getTimestamp

getObject

getBigDecimal

getObject

getRef

getBlob

getClob

getArray

getDate

getTime

getTimestamp

registerOutParameter

getCallableStatement

getArray

getBigDecimal

getBlob

getBoolean

getByte

getBytes

getClob

getDate

getDate

getDouble

getFloat

getInt

getLong

getObject

getObject

getRef

getShort

getString

getTime

getTime

getTimestamp

getTimestamp

getURL

getURL

registerOutParameter

registerOutParameter

registerOutParameter

setAsciiStream

setBigDecimal

setBinaryStream

setBoolean

setByte

setBytes

setCharacterStream

setDate

setDate

setDouble

setFloat

setInt

setLong

setNull

setNull

setObject

setObject

setObject

setShort

setString

setTime

setTime

setTimestamp

tyrex.resource.jdbc.xa
Class TyrexCallableStatementImpl