org.postgresql.jdbc3
Class AbstractJdbc3Statement

java.lang.Object
  org.postgresql.jdbc2.AbstractJdbc2Statement
      org.postgresql.jdbc3.AbstractJdbc3Statement

All Implemented Interfaces:

Statement, Wrapper, BaseStatement, PGStatement

Direct Known Subclasses:

AbstractJdbc3gStatement

public abstract class AbstractJdbc3Statement
extends AbstractJdbc2Statement

This class defines methods of the jdbc3 specification. This class extends org.postgresql.jdbc2.AbstractJdbc2Statement which provides the jdbc2 methods. The real Statement class (for jdbc2) is org.postgresql.jdbc3.Jdbc3Statement

Nested Class Summary

Nested classes/interfaces inherited from class org.postgresql.jdbc2.AbstractJdbc2Statement

AbstractJdbc2Statement.StatementResultHandler

Field Summary

Fields inherited from class org.postgresql.jdbc2.AbstractJdbc2Statement

adjustIndex, batchParameters, batchStatements, callResult, concurrency, connection, fetchdirection, fetchSize, firstUnclosedResult, generatedKeys, isClosed, lastSimpleQuery, lastWarning, m_prepareThreshold, m_useCount, maxfieldSize, maxrows, outParmBeforeFunc, preparedParameters, preparedQuery, replaceProcessingEnabled, result, resultsettype, timeout, wantsGeneratedKeysAlways, wantsGeneratedKeysOnce, warnings

Fields inherited from interface org.postgresql.PGStatement

DATE_NEGATIVE_INFINITY, DATE_POSITIVE_INFINITY

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

AbstractJdbc3Statement(AbstractJdbc3Connection c, int rsType, int rsConcurrency, int rsHoldability)

AbstractJdbc3Statement(AbstractJdbc3Connection connection, String sql, boolean isCallable, int rsType, int rsConcurrency, int rsHoldability)

Method Summary

abstract ParameterMetaData	createParameterMetaData(BaseConnection conn, int[] oids)
boolean	execute(String sql, int autoGeneratedKeys) Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval.
boolean	execute(String sql, int[] columnIndexes) Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
boolean	execute(String sql, String[] columnNames) Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
int	executeUpdate(String sql, int autoGeneratedKeys) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.
int	executeUpdate(String sql, int[] columnIndexes) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
int	executeUpdate(String sql, String[] columnNames) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
Array	getArray(String parameterName) Retrieves the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
BigDecimal	getBigDecimal(String parameterName) Retrieves 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.
Blob	getBlob(String parameterName) Retrieves the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
boolean	getBoolean(String parameterName) Retrieves the value of a JDBC BIT parameter as a boolean in the Java programming language.
byte	getByte(String parameterName) Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
byte[]	getBytes(String parameterName) Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
Clob	getClob(String parameterName) Retrieves the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
Date	getDate(String parameterName) Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.
Date	getDate(String parameterName, Calendar cal) Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
double	getDouble(String parameterName) Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
float	getFloat(String parameterName) Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
ResultSet	getGeneratedKeys() Retrieves any auto-generated keys created as a result of executing this Statement object.
int	getInt(String parameterName) Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
long	getLong(String parameterName) Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
boolean	getMoreResults(int current) Moves to this Statement object's next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.
Object	getObject(String parameterName) Retrieves the value of a parameter as an Object in the Java programming language.
Object	getObjectImpl(String parameterName, Map map) Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters.
Ref	getRef(String parameterName) Retrieves the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
int	getResultSetHoldability() Retrieves the result set holdability for ResultSet objects generated by this Statement object.
short	getShort(String parameterName) Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.
String	getString(String parameterName) Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
Time	getTime(String parameterName) Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.
Time	getTime(String parameterName, Calendar cal) Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
Timestamp	getTimestamp(String parameterName) Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
Timestamp	getTimestamp(String parameterName, Calendar cal) Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
URL	getURL(int parameterIndex) Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.
URL	getURL(String parameterName) Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.
void	registerOutParameter(int parameterIndex, int sqlType)
void	registerOutParameter(int parameterIndex, int sqlType, int scale)
void	registerOutParameter(String parameterName, int sqlType) Registers the OUT parameter named parameterName to the JDBC type sqlType.
void	registerOutParameter(String parameterName, int sqlType, int scale) Registers the parameter named parameterName to be of JDBC type sqlType.
void	registerOutParameter(String parameterName, int sqlType, String typeName) Registers the designated output parameter.
void	setAsciiStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(String parameterName, BigDecimal x) Sets the designated parameter to the given java.math.BigDecimal value.
void	setBinaryStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBoolean(String parameterName, boolean x) Sets the designated parameter to the given Java boolean value.
void	setByte(String parameterName, byte x) Sets the designated parameter to the given Java byte value.
void	setBytes(String parameterName, byte[] x) Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(String parameterName, Reader reader, int length) Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setDate(String parameterName, Date x) Sets the designated parameter to the given java.sql.Date value.
void	setDate(String parameterName, Date x, Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	setDouble(String parameterName, double x) Sets the designated parameter to the given Java double value.
void	setFloat(String parameterName, float x) Sets the designated parameter to the given Java float value.
void	setInt(String parameterName, int x) Sets the designated parameter to the given Java int value.
void	setLong(String parameterName, long x) Sets the designated parameter to the given Java long value.
void	setNull(int parameterIndex, int sqlType)
void	setNull(String parameterName, int sqlType) Sets the designated parameter to SQL NULL.
void	setNull(String parameterName, int sqlType, String typeName) Sets the designated parameter to SQL NULL.
void	setObject(int parameterIndex, Object x, int targetSqlType, int scale)
void	setObject(String parameterName, Object x) Sets the value of the designated parameter with the given object.
void	setObject(String parameterName, Object x, int targetSqlType) Sets the value of the designated parameter with the given object.
void	setObject(String parameterName, Object x, int targetSqlType, int scale) Sets the value of the designated parameter with the given object.
void	setShort(String parameterName, short x) Sets the designated parameter to the given Java short value.
void	setString(String parameterName, String x) Sets the designated parameter to the given Java String value.
void	setTime(String parameterName, Time x) Sets the designated parameter to the given java.sql.Time value.
void	setTime(String parameterName, Time x, Calendar cal) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
void	setTimestamp(String parameterName, Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value.
void	setTimestamp(String parameterName, Timestamp x, Calendar cal) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
void	setURL(int parameterIndex, URL x) Sets the designated parameter to the given java.net.URL value.
void	setURL(String parameterName, URL val) Sets the designated parameter to the given java.net.URL object.
protected boolean	wantsHoldableResultSet()

Methods inherited from class org.postgresql.jdbc2.AbstractJdbc2Statement

addBatch, addBatch, addWarning, bindLiteral, cancel, checkClosed, checkIndex, checkIndex, clearBatch, clearParameters, clearWarnings, close, closeForNextExecution, createDriverResultSet, createResultSet, escapeFunction, execute, execute, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, executeWithFlags, executeWithFlags, finalize, getArray, getBigDecimal, getBigDecimal, getBlob, getBoolean, getByte, getBytes, getClob, getConnection, getDate, getDate, getDouble, getFetchDirection, getFetchingCursorName, getFetchSize, getFloat, getInsertedOID, getInt, getLastOID, getLong, getMaxFieldSize, getMaxRows, getMetaData, getMoreResults, getObject, getObjectImpl, getPGConnection, getPrepareThreshold, getQueryTimeout, getRef, getResultSet, getResultSetConcurrency, getResultSetType, getShort, getString, getTime, getTime, getTimestamp, getTimestamp, getUpdateCount, getWarnings, isUseServerPrepare, parseSql, registerOutParameter, registerOutParameter, registerOutParameter, replaceProcessing, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setCursorName, setDate, setDate, setDouble, setEscapeProcessing, setFetchDirection, setFetchSize, setFloat, setInt, setLong, setMaxFieldSize, setMaxRows, setNull, setObject, setObject, setPrepareThreshold, setQueryTimeout, setRef, setShort, setString, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setUseServerPrepare, toString, wantsScrollableResultSet, wasNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Statement

isClosed, isPoolable, setPoolable

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

AbstractJdbc3Statement

public AbstractJdbc3Statement(AbstractJdbc3Connection c,
                              int rsType,
                              int rsConcurrency,
                              int rsHoldability)
                       throws SQLException

Throws:

SQLException

AbstractJdbc3Statement

public AbstractJdbc3Statement(AbstractJdbc3Connection connection,
                              String sql,
                              boolean isCallable,
                              int rsType,
                              int rsConcurrency,
                              int rsHoldability)
                       throws SQLException

Throws:

SQLException

Method Detail

getMoreResults

public boolean getMoreResults(int current)
                       throws SQLException

Moves to this Statement object's next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.

There are no more results when the following is true:

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

Parameters:

current - one of the following Statement constants indicating what should happen to current ResultSet objects obtained using the method getResultSetCLOSE_CURRENT_RESULT, KEEP_CURRENT_RESULT, or CLOSE_ALL_RESULTS

Returns:

true if the next result is a ResultSet object; false if it is an update count or there are no more results

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

execute(java.lang.String, int)

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException

Retrieves any auto-generated keys created as a result of executing this Statement object. If this Statement object did not generate any keys, an empty ResultSet object is returned.

Returns:

a ResultSet object containing the auto-generated key(s) generated by the execution of this Statement object

Throws:

SQLException - if a database access error occurs

Since:

1.4

executeUpdate

public int executeUpdate(String sql,
                         int autoGeneratedKeys)
                  throws SQLException

Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.

Parameters:

sql - must be an SQL INSERT, UPDATE or DELETE statement or an SQL statement that returns nothing

autoGeneratedKeys - a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants: Statement.RETURN_GENERATED_KEYS Statement.NO_GENERATED_KEYS

Returns:

either the row count for INSERT, UPDATE or DELETE statements, or 0 for SQL statements that return nothing

Throws:

SQLException - if a database access error occurs, the given SQL statement returns a ResultSet object, or the given constant is not one of those allowed

Since:

1.4

executeUpdate

public int executeUpdate(String sql,
                         int[] columnIndexes)
                  throws SQLException

Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not an INSERT statement.

Parameters:

sql - an SQL INSERT, UPDATE or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement

columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row

Returns:

either the row count for INSERT, UPDATE, or DELETE statements, or 0 for SQL statements that return nothing

Throws:

SQLException - if a database access error occurs or the SQL statement returns a ResultSet object

Since:

1.4

executeUpdate

public int executeUpdate(String sql,
                         String[] columnNames)
                  throws SQLException

Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not an INSERT statement.

Parameters:

sql - an SQL INSERT, UPDATE or DELETE statement or an SQL statement that returns nothing

columnNames - an array of the names of the columns that should be returned from the inserted row

Returns:

either the row count for INSERT, UPDATE, or DELETE statements, or 0 for SQL statements that return nothing

Throws:

SQLException - if a database access error occurs

Since:

1.4

execute

public boolean execute(String sql,
                       int autoGeneratedKeys)
                throws SQLException

Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. The driver will ignore this signal if the SQL statement is not an INSERT statement.

In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.

The execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).

Parameters:

sql - any SQL statement

autoGeneratedKeys - a constant indicating whether auto-generated keys should be made available for retrieval using the method getGeneratedKeys; one of the following constants: Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Returns:

true if the first result is a ResultSet object; false if it is an update count or there are no results

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

AbstractJdbc2Statement.getResultSet(), AbstractJdbc2Statement.getUpdateCount(), getMoreResults(int), getGeneratedKeys()

execute

public boolean execute(String sql,
                       int[] columnIndexes)
                throws SQLException

Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the given SQL statement is not an INSERT statement.

Under some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.

The execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).

Parameters:

sql - any SQL statement

columnIndexes - an array of the indexes of the columns in the inserted row that should be made available for retrieval by a call to the method getGeneratedKeys

Returns:

true if the first result is a ResultSet object; false if it is an update count or there are no results

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

AbstractJdbc2Statement.getResultSet(), AbstractJdbc2Statement.getUpdateCount(), getMoreResults(int)

execute

public boolean execute(String sql,
                       String[] columnNames)
                throws SQLException

Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the given SQL statement is not an INSERT statement.

In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.

The execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).

Parameters:

sql - any SQL statement

columnNames - an array of the names of the columns in the inserted row that should be made available for retrieval by a call to the method getGeneratedKeys

Returns:

true if the next result is a ResultSet object; false if it is an update count or there are no more results

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

AbstractJdbc2Statement.getResultSet(), AbstractJdbc2Statement.getUpdateCount(), getMoreResults(int), getGeneratedKeys()

getResultSetHoldability

public int getResultSetHoldability()
                            throws SQLException

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

Returns:

either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Throws:

SQLException - if a database access error occurs

Since:

1.4

setURL

public void setURL(int parameterIndex,
                   URL x)
            throws SQLException

Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the java.net.URL object to be set

Throws:

SQLException - if a database access error occurs

Since:

1.4

getParameterMetaData

public ParameterMetaData getParameterMetaData()
                                       throws SQLException

Retrieves the number, types and properties of this PreparedStatement object's parameters.

Returns:

a ParameterMetaData object that contains information about the number, types and properties of this PreparedStatement object's parameters

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

ParameterMetaData

createParameterMetaData

public abstract ParameterMetaData createParameterMetaData(BaseConnection conn,
                                                          int[] oids)
                                                   throws SQLException

Throws:

SQLException

registerOutParameter

public void registerOutParameter(String parameterName,
                                 int sqlType)
                          throws SQLException

Registers the OUT parameter named parameterName 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(java.lang.String) retrieves the value.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

Types

registerOutParameter

public void registerOutParameter(String parameterName,
                                 int sqlType,
                                 int scale)
                          throws SQLException

Registers the parameter named parameterName 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.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

Types

registerOutParameter

public void registerOutParameter(String parameterName,
                                 int sqlType,
                                 String typeName)
                          throws 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.

Parameters:

parameterName - the name of the parameter

sqlType - a value from Types

typeName - the fully-qualified name of an SQL structured type

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

Types

getURL

public URL getURL(int parameterIndex)
           throws SQLException

Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.

Parameters:

parameterIndex - the first parameter is 1, the second is 2,...

Returns:

a java.net.URL object that represents the JDBC DATALINK value used as the designated parameter

Throws:

SQLException - if a database access error occurs, or if the URL being returned is not a valid URL on the Java platform

Since:

1.4

See Also:

setURL(int, java.net.URL)

setURL

public void setURL(String parameterName,
                   URL val)
            throws SQLException

Sets the designated parameter to the given java.net.URL object. The driver converts this to an SQL DATALINK value when it sends it to the database.

Parameters:

parameterName - the name of the parameter

val - the parameter value

Throws:

SQLException - if a database access error occurs, or if a URL is malformed

Since:

1.4

See Also:

getURL(int)

setNull

public void setNull(String parameterName,
                    int sqlType)
             throws SQLException

Sets the designated parameter to SQL NULL.

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

Parameters:

parameterName - the name of the parameter

sqlType - the SQL type code defined in java.sql.Types

Throws:

SQLException - if a database access error occurs

Since:

1.4

setBoolean

public void setBoolean(String parameterName,
                       boolean x)
                throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getBoolean(java.lang.String)

setByte

public void setByte(String parameterName,
                    byte x)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getByte(java.lang.String)

setShort

public void setShort(String parameterName,
                     short x)
              throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getShort(java.lang.String)

setInt

public void setInt(String parameterName,
                   int x)
            throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getInt(java.lang.String)

setLong

public void setLong(String parameterName,
                    long x)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getLong(java.lang.String)

setFloat

public void setFloat(String parameterName,
                     float x)
              throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getFloat(java.lang.String)

setDouble

public void setDouble(String parameterName,
                      double x)
               throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getDouble(java.lang.String)

setBigDecimal

public void setBigDecimal(String parameterName,
                          BigDecimal x)
                   throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getBigDecimal(java.lang.String)

setString

public void setString(String parameterName,
                      String x)
               throws SQLException

Sets the designated parameter to the given 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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getString(java.lang.String)

setBytes

public void setBytes(String parameterName,
                     byte[] x)
              throws SQLException

Sets the designated parameter to the given 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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getBytes(java.lang.String)

setDate

public void setDate(String parameterName,
                    Date x)
             throws SQLException

Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getDate(java.lang.String)

setTime

public void setTime(String parameterName,
                    Time x)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getTime(java.lang.String)

setTimestamp

public void setTimestamp(String parameterName,
                         Timestamp x)
                  throws SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getTimestamp(java.lang.String)

setAsciiStream

public void setAsciiStream(String parameterName,
                           InputStream x,
                           int length)
                    throws 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.

Parameters:

parameterName - the name of the parameter

x - the Java input stream that contains the ASCII parameter value

length - the number of bytes in the stream

Throws:

SQLException - if a database access error occurs

Since:

1.4

setBinaryStream

public void setBinaryStream(String parameterName,
                            InputStream x,
                            int length)
                     throws 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.

Parameters:

parameterName - the name of the parameter

x - the java input stream which contains the binary parameter value

length - the number of bytes in the stream

Throws:

SQLException - if a database access error occurs

Since:

1.4

setObject

public void setObject(String parameterName,
                      Object x,
                      int targetSqlType,
                      int scale)
               throws 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.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

Types, getObject(java.lang.String)

setObject

public void setObject(String parameterName,
                      Object x,
                      int targetSqlType)
               throws 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.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getObject(java.lang.String)

setObject

public void setObject(String parameterName,
                      Object x)
               throws SQLException

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

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

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

This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

Throws:

SQLException - if a database access error occurs or if the given Object parameter is ambiguous

Since:

1.4

See Also:

getObject(java.lang.String)

setCharacterStream

public void setCharacterStream(String parameterName,
                               Reader reader,
                               int length)
                        throws 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.

Parameters:

parameterName - the name of the parameter

reader - the java.io.Reader object that contains the UNICODE data used as the designated parameter

length - the number of characters in the stream

Throws:

SQLException - if a database access error occurs

Since:

1.4

setDate

public void setDate(String parameterName,
                    Date x,
                    Calendar cal)
             throws 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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the date

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getDate(java.lang.String)

setTime

public void setTime(String parameterName,
                    Time x,
                    Calendar cal)
             throws 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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the time

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getTime(java.lang.String)

setTimestamp

public void setTimestamp(String parameterName,
                         Timestamp x,
                         Calendar cal)
                  throws 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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the timestamp

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getTimestamp(java.lang.String)

setNull

public void setNull(String parameterName,
                    int sqlType,
                    String typeName)
             throws 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.

Parameters:

parameterName - the name of the parameter

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 SQL REF value

Throws:

SQLException - if a database access error occurs

Since:

1.4

getString

public String getString(String parameterName)
                 throws 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.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setString(java.lang.String, java.lang.String)

getBoolean

public boolean getBoolean(String parameterName)
                   throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is false.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setBoolean(java.lang.String, boolean)

getByte

public byte getByte(String parameterName)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setByte(java.lang.String, byte)

getShort

public short getShort(String parameterName)
               throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setShort(java.lang.String, short)

getInt

public int getInt(String parameterName)
           throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setInt(java.lang.String, int)

getLong

public long getLong(String parameterName)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setLong(java.lang.String, long)

getFloat

public float getFloat(String parameterName)
               throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setFloat(java.lang.String, float)

getDouble

public double getDouble(String parameterName)
                 throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setDouble(java.lang.String, double)

getBytes

public byte[] getBytes(String parameterName)
                throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setBytes(java.lang.String, byte[])

getDate

public Date getDate(String parameterName)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setDate(java.lang.String, java.sql.Date)

getTime

public Time getTime(String parameterName)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setTime(java.lang.String, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(String parameterName)
                       throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

public Object getObject(String parameterName)
                 throws SQLException

Retrieves the value of a parameter as an Object in the Java programming language. If the value is an SQL NULL, the driver returns a Java null.

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.

Parameters:

parameterName - the name of the parameter

Returns:

A java.lang.Object holding the OUT parameter value.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

public BigDecimal getBigDecimal(String parameterName)
                         throws SQLException

Retrieves 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.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value in full precision. If the value is SQL NULL, the result is null.

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setBigDecimal(java.lang.String, java.math.BigDecimal)

getObjectImpl

public Object getObjectImpl(String parameterName,
                            Map map)
                     throws SQLException

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

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.

Parameters:

parameterName - the name of the parameter

map - the mapping from SQL type names to Java classes

Returns:

a java.lang.Object holding the OUT parameter value

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setObject(java.lang.String, java.lang.Object, int, int)

getRef

public Ref getRef(String parameterName)
           throws SQLException

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

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

getBlob

public Blob getBlob(String parameterName)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

getClob

public Clob getClob(String parameterName)
             throws SQLException

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

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

getArray

public Array getArray(String parameterName)
               throws SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value as an Array object in Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

SQLException - if a database access error occurs

Since:

1.4

getDate

public Date getDate(String parameterName,
                    Calendar cal)
             throws SQLException

Retrieves 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.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setDate(java.lang.String, java.sql.Date)

getTime

public Time getTime(String parameterName,
                    Calendar cal)
             throws SQLException

Retrieves 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.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setTime(java.lang.String, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(String parameterName,
                              Calendar cal)
                       throws SQLException

Retrieves 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.

Parameters:

parameterName - the name of the parameter

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:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setTimestamp(java.lang.String, java.sql.Timestamp)

getURL

public URL getURL(String parameterName)
           throws SQLException

Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value as a java.net.URL object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

SQLException - if a database access error occurs, or if there is a problem with the URL

Since:

1.4

See Also:

setURL(int, java.net.URL)

setObject

public void setObject(int parameterIndex,
                      Object x,
                      int targetSqlType,
                      int scale)
               throws SQLException

Overrides:

setObject in class AbstractJdbc2Statement

Throws:

SQLException

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws SQLException

Overrides:

setNull in class AbstractJdbc2Statement

Throws:

SQLException

wantsHoldableResultSet

protected boolean wantsHoldableResultSet()

Overrides:

wantsHoldableResultSet in class AbstractJdbc2Statement

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType)
                          throws SQLException

Throws:

SQLException

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType,
                                 int scale)
                          throws SQLException

Throws:

SQLException