com.foundationdb.sql.jdbc.jdbc3.AbstractJdbc3Statement Maven / Gradle / Ivy
Show all versions of fdb-sql-layer-jdbc Show documentation
/*------------------------------------------------------------------------- * * Copyright (c) 2004-2011, PostgreSQL Global Development Group * * *------------------------------------------------------------------------- */ package com.foundationdb.sql.jdbc.jdbc3; import java.math.BigDecimal; import java.sql.*; import java.util.ArrayList; import java.util.Calendar; import com.foundationdb.sql.jdbc.Driver; import com.foundationdb.sql.jdbc.core.BaseConnection; import com.foundationdb.sql.jdbc.core.Field; import com.foundationdb.sql.jdbc.core.QueryExecutor; import com.foundationdb.sql.jdbc.core.Utils; import com.foundationdb.sql.jdbc.util.GT; import com.foundationdb.sql.jdbc.util.PSQLException; import com.foundationdb.sql.jdbc.util.PSQLState; /** * This class defines methods of the jdbc3 specification. This class extends * jdbc2.AbstractJdbc2Statement which provides the jdbc2 * methods. The real Statement class (for jdbc2) is jdbc3.Jdbc3Statement */ public abstract class AbstractJdbc3Statement extends com.foundationdb.sql.jdbc.jdbc2.AbstractJdbc2Statement { private final int rsHoldability; public AbstractJdbc3Statement (AbstractJdbc3Connection c, int rsType, int rsConcurrency, int rsHoldability) throws SQLException { super(c, rsType, rsConcurrency); this.rsHoldability = rsHoldability; } public AbstractJdbc3Statement(AbstractJdbc3Connection connection, String sql, boolean isCallable, int rsType, int rsConcurrency, int rsHoldability) throws SQLException { super(connection, sql, isCallable, rsType, rsConcurrency); this.rsHoldability = rsHoldability; } /** * Moves to this
statement. * * @param sql an SQLStatement
object's next result, deals with * any currentResultSet
object(s) according to the instructions * specified by the given flag, and returns *true
if the next result is aResultSet
object. * *There are no more results when the following is true: *
** * @param current one of the following(!getMoreResults() && (getUpdateCount() == -1)
*Statement
* constants indicating what should happen to current *ResultSet
objects obtained using the method *getResultSetCLOSE_CURRENT_RESULT
, *KEEP_CURRENT_RESULT
, or *CLOSE_ALL_RESULTS
* @returntrue
if the next result is aResultSet
* object;false
if it is an update count or there are no * more results * @exception SQLException if a database access error occurs * @since 1.4 * @see #execute */ public boolean getMoreResults(int current) throws SQLException { // CLOSE_CURRENT_RESULT if (current == Statement.CLOSE_CURRENT_RESULT && result != null && result.getResultSet() != null) result.getResultSet().close(); // Advance resultset. if (result != null) result = result.getNext(); // CLOSE_ALL_RESULTS if (current == Statement.CLOSE_ALL_RESULTS) { // Close preceding resultsets. while (firstUnclosedResult != result) { if (firstUnclosedResult.getResultSet() != null) firstUnclosedResult.getResultSet().close(); firstUnclosedResult = firstUnclosedResult.getNext(); } } // Done. return (result != null && result.getResultSet() != null); } /** * Retrieves any auto-generated keys created as a result of executing this *Statement
object. If thisStatement
object did * not generate any keys, an emptyResultSet
* object is returned. * * @return aResultSet
object containing the auto-generated key(s) * generated by the execution of thisStatement
object * @exception SQLException if a database access error occurs * @since 1.4 */ public ResultSet getGeneratedKeys() throws SQLException { checkClosed(); if (generatedKeys == null || generatedKeys.getResultSet() == null) return createDriverResultSet(new Field[0], new ArrayList()); return generatedKeys.getResultSet(); } /** * Executes the given SQL statement and signals the driver with the * given flag about whether the * auto-generated keys produced by thisStatement
object * should be made available for retrieval. * * @param sql must be an SQLINSERT
,UPDATE
or *DELETE
statement or an SQL statement that * returns nothing * @param 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
* @return either the row count forINSERT
,UPDATE
* orDELETE
statements, or0
for SQL * statements that return nothing * @exception SQLException if a database access error occurs, the given * SQL statement returns aResultSet
object, or * the given constant is not one of those allowed * @since 1.4 */ public int executeUpdate(String sql, int autoGeneratedKeys) throws SQLException { if (autoGeneratedKeys == Statement.NO_GENERATED_KEYS) return executeUpdate(sql); sql = addReturning(connection, sql, new String[]{"*"}, false); wantsGeneratedKeysOnce = true; return executeUpdate(sql); } static String addReturning(BaseConnection connection, String sql, String columns[], boolean escape) throws SQLException { if (!connection.haveMinimumServerVersion("8.2")) throw new PSQLException(GT.tr("Returning autogenerated keys is only supported for 8.2 and later servers."), PSQLState.NOT_IMPLEMENTED); sql = sql.trim(); if (sql.endsWith(";")) sql = sql.substring(0, sql.length()-1); StringBuffer sb = new StringBuffer(sql); sb.append(" RETURNING "); for (int i=0; iINSERT INSERT
,UPDATE
or *DELETE
statement or an SQL statement that returns nothing, * such as an SQL DDL statement * @param columnIndexes an array of column indexes indicating the columns * that should be returned from the inserted row * @return either the row count forINSERT
,UPDATE
, * orDELETE
statements, or 0 for SQL statements * that return nothing * @exception SQLException if a database access error occurs or the SQL * statement returns aResultSet
object * @since 1.4 */ public int executeUpdate(String sql, int columnIndexes[]) throws SQLException { if (columnIndexes == null || columnIndexes.length == 0) return executeUpdate(sql); throw new PSQLException(GT.tr("Returning autogenerated keys by column index is not supported."), PSQLState.NOT_IMPLEMENTED); } /** * 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 anINSERT
statement. * * @param sql an SQLINSERT
,UPDATE
or *DELETE
statement or an SQL statement that returns nothing * @param columnNames an array of the names of the columns that should be * returned from the inserted row * @return either the row count forINSERT
,UPDATE
, * orDELETE
statements, or 0 for SQL statements * that return nothing * @exception SQLException if a database access error occurs * * @since 1.4 */ public int executeUpdate(String sql, String columnNames[]) throws SQLException { if (columnNames == null || columnNames.length == 0) return executeUpdate(sql); sql = addReturning(connection, sql, columnNames, true); wantsGeneratedKeysOnce = true; return executeUpdate(sql); } /** * 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 anINSERT
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
orgetUpdateCount
* to retrieve the result, andgetMoreResults
to * move to any subsequent result(s). * * @param sql any SQL statement * @param 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
* @returntrue
if the first result is aResultSet
* object;false
if it is an update count or there are * no results * @exception SQLException if a database access error occurs * @see #getResultSet * @see #getUpdateCount * @see #getMoreResults * @see #getGeneratedKeys * * @since 1.4 */ public boolean execute(String sql, int autoGeneratedKeys) throws SQLException { if (autoGeneratedKeys == Statement.NO_GENERATED_KEYS) return execute(sql); sql = addReturning(connection, sql, new String[]{"*"}, false); wantsGeneratedKeysOnce = true; return execute(sql); } /** * 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 anINSERT
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
orgetUpdateCount
* to retrieve the result, andgetMoreResults
to * move to any subsequent result(s). * * @param sql any SQL statement * @param 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 methodgetGeneratedKeys
* @returntrue
if the first result is aResultSet
* object;false
if it is an update count or there * are no results * @exception SQLException if a database access error occurs * @see #getResultSet * @see #getUpdateCount * @see #getMoreResults * * @since 1.4 */ public boolean execute(String sql, int columnIndexes[]) throws SQLException { if (columnIndexes == null || columnIndexes.length == 0) return execute(sql); throw new PSQLException(GT.tr("Returning autogenerated keys by column index is not supported."), PSQLState.NOT_IMPLEMENTED); } /** * 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 anINSERT
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
orgetUpdateCount
* to retrieve the result, andgetMoreResults
to * move to any subsequent result(s). * * @param sql any SQL statement * @param 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 * methodgetGeneratedKeys
* @returntrue
if the next result is aResultSet
* object;false
if it is an update count or there * are no more results * @exception SQLException if a database access error occurs * @see #getResultSet * @see #getUpdateCount * @see #getMoreResults * @see #getGeneratedKeys * * @since 1.4 */ public boolean execute(String sql, String columnNames[]) throws SQLException { if (columnNames == null || columnNames.length == 0) return execute(sql); sql = addReturning(connection, sql, columnNames, true); wantsGeneratedKeysOnce = true; return execute(sql); } /** * Retrieves the result set holdability forResultSet
objects * generated by thisStatement
object. * * @return eitherResultSet.HOLD_CURSORS_OVER_COMMIT
or *ResultSet.CLOSE_CURSORS_AT_COMMIT
* @exception SQLException if a database access error occurs * * @since 1.4 */ public int getResultSetHoldability() throws SQLException { return rsHoldability; } /** * Sets the designated parameter to the givenjava.net.URL
value. * The driver converts this to an SQLDATALINK
value * when it sends it to the database. * * @param parameterIndex the first parameter is 1, the second is 2, ... * @param x thejava.net.URL
object to be set * @exception SQLException if a database access error occurs * @since 1.4 */ public void setURL(int parameterIndex, java.net.URL x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setURL(int,URL)"); } /** * Retrieves the number, types and properties of this *PreparedStatement
object's parameters. * * @return aParameterMetaData
object that contains information * about the number, types and properties of this *PreparedStatement
object's parameters * @exception SQLException if a database access error occurs * @see ParameterMetaData * @since 1.4 */ public ParameterMetaData getParameterMetaData() throws SQLException { int flags = QueryExecutor.QUERY_ONESHOT | QueryExecutor.QUERY_DESCRIBE_ONLY | QueryExecutor.QUERY_SUPPRESS_BEGIN; StatementResultHandler handler = new StatementResultHandler(); connection.getQueryExecutor().execute(preparedQuery, preparedParameters, handler, 0, 0, flags); int oids[] = preparedParameters.getTypeOIDs(); if (oids != null) return createParameterMetaData(connection, oids); return null; } public abstract ParameterMetaData createParameterMetaData(BaseConnection conn, int oids[]) 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 theget
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 bejava.sql.Types.OTHER
. The method * {@link #getObject} retrieves the value. * @param parameterName the name of the parameter * @param sqlType the JDBC type code defined byjava.sql.Types
. * If the parameter is of JDBC typeNUMERIC
* orDECIMAL
, the version of *registerOutParameter
that accepts a scale value * should be used. * @exception SQLException if a database access error occurs * @since 1.4 * @see Types */ public void registerOutParameter(String parameterName, int sqlType) throws SQLException { throw Driver.notImplemented(this.getClass(), "registerOutParameter(String,int)"); } /** * 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 theget
method to read the value of that parameter. ** This version of
registerOutParameter
should be * used when the parameter is of JDBC typeNUMERIC
* orDECIMAL
. * @param parameterName the name of the parameter * @param sqlType SQL type code defined byjava.sql.Types
. * @param scale the desired number of digits to the right of the * decimal point. It must be greater than or equal to zero. * @exception SQLException if a database access error occurs * @since 1.4 * @see Types */ public void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException { throw Driver.notImplemented(this.getClass(), "registerOutParameter(String,int,int)"); } /** * Registers the designated output parameter. This version of * the methodregisterOutParameter
* 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 * callregisterOutParameter
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. * * @param parameterName the name of the parameter * @param sqlType a value from {@link java.sql.Types} * @param typeName the fully-qualified name of an SQL structured type * @exception SQLException if a database access error occurs * @see Types * @since 1.4 */ public void registerOutParameter (String parameterName, int sqlType, String typeName) throws SQLException { throw Driver.notImplemented(this.getClass(), "registerOutParameter(String,int,String)"); } /** * Retrieves the value of the designated JDBCDATALINK
parameter as a *java.net.URL
object. * * @param parameterIndex the first parameter is 1, the second is 2,... * @return ajava.net.URL
object that represents the * JDBCDATALINK
value used as the designated * parameter * @exception SQLException if a database access error occurs, * or if the URL being returned is * not a valid URL on the Java platform * @see #setURL * @since 1.4 */ public java.net.URL getURL(int parameterIndex) throws SQLException { throw Driver.notImplemented(this.getClass(), "getURL(String)"); } /** * Sets the designated parameter to the givenjava.net.URL
object. * The driver converts this to an SQLDATALINK
value when * it sends it to the database. * * @param parameterName the name of the parameter * @param val the parameter value * @exception SQLException if a database access error occurs, * or if a URL is malformed * @see #getURL * @since 1.4 */ public void setURL(String parameterName, java.net.URL val) throws SQLException { throw Driver.notImplemented(this.getClass(), "setURL(String,URL)"); } /** * Sets the designated parameter to SQLNULL
. * *Note: You must specify the parameter's SQL type. * * @param parameterName the name of the parameter * @param sqlType the SQL type code defined in
java.sql.Types
* @exception SQLException if a database access error occurs * @since 1.4 */ public void setNull(String parameterName, int sqlType) throws SQLException { throw Driver.notImplemented(this.getClass(), "setNull(String,int)"); } /** * Sets the designated parameter to the given Javaboolean
value. * The driver converts this * to an SQLBIT
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBoolean * @since 1.4 */ public void setBoolean(String parameterName, boolean x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setBoolean(String,boolean)"); } /** * Sets the designated parameter to the given Javabyte
value. * The driver converts this * to an SQLTINYINT
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getByte * @since 1.4 */ public void setByte(String parameterName, byte x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setByte(String,byte)"); } /** * Sets the designated parameter to the given Javashort
value. * The driver converts this * to an SQLSMALLINT
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getShort * @since 1.4 */ public void setShort(String parameterName, short x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setShort(String,short)"); } /** * Sets the designated parameter to the given Javaint
value. * The driver converts this * to an SQLINTEGER
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getInt * @since 1.4 */ public void setInt(String parameterName, int x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setInt(String,int)"); } /** * Sets the designated parameter to the given Javalong
value. * The driver converts this * to an SQLBIGINT
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getLong * @since 1.4 */ public void setLong(String parameterName, long x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setLong(String,long)"); } /** * Sets the designated parameter to the given Javafloat
value. * The driver converts this * to an SQLFLOAT
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getFloat * @since 1.4 */ public void setFloat(String parameterName, float x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setFloat(String,float)"); } /** * Sets the designated parameter to the given Javadouble
value. * The driver converts this * to an SQLDOUBLE
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getDouble * @since 1.4 */ public void setDouble(String parameterName, double x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setDouble(String,double)"); } /** * Sets the designated parameter to the given *java.math.BigDecimal
value. * The driver converts this to an SQLNUMERIC
value when * it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBigDecimal * @since 1.4 */ public void setBigDecimal(String parameterName, BigDecimal x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setBigDecimal(String,BigDecimal)"); } /** * Sets the designated parameter to the given JavaString
value. * The driver converts this * to an SQLVARCHAR
orLONGVARCHAR
value * (depending on the argument's * size relative to the driver's limits onVARCHAR
values) * when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getString * @since 1.4 */ public void setString(String parameterName, String x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setString(String,String)"); } /** * Sets the designated parameter to the given Java array of bytes. * The driver converts this to an SQLVARBINARY
or *LONGVARBINARY
(depending on the argument's size relative * to the driver's limits onVARBINARY
values) when it sends * it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBytes * @since 1.4 */ public void setBytes(String parameterName, byte x[]) throws SQLException { throw Driver.notImplemented(this.getClass(), "setBytes(String,byte)"); } /** * Sets the designated parameter to the givenjava.sql.Date
value. * The driver converts this * to an SQLDATE
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getDate * @since 1.4 */ public void setDate(String parameterName, java.sql.Date x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setDate(String,Date)"); } /** * Sets the designated parameter to the givenjava.sql.Time
value. * The driver converts this * to an SQLTIME
value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getTime * @since 1.4 */ public void setTime(String parameterName, java.sql.Time x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setTime(String,Time)"); } /** * Sets the designated parameter to the givenjava.sql.Timestamp
value. * The driver * converts this to an SQLTIMESTAMP
value when it sends it to the * database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getTimestamp * @since 1.4 */ public void setTimestamp(String parameterName, java.sql.Timestamp x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setTimestamp(String,Timestamp)"); } /** * 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 aLONGVARCHAR
* 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. * * @param parameterName the name of the parameter * @param x the Java input stream that contains the ASCII parameter value * @param length the number of bytes in the stream * @exception SQLException if a database access error occurs * @since 1.4 */ public void setAsciiStream(String parameterName, java.io.InputStream x, int length) throws SQLException { throw Driver.notImplemented(this.getClass(), "setAsciiStream(String,InputStream,int)"); } /** * 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. * * @param parameterName the name of the parameter * @param x the java input stream which contains the binary parameter value * @param length the number of bytes in the stream * @exception SQLException if a database access error occurs * @since 1.4 */ public void setBinaryStream(String parameterName, java.io.InputStream x, int length) throws SQLException { throw Driver.notImplemented(this.getClass(), "setBinaryStream(String,InputStream,int)"); } /** * 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 methodSQLData.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
, * orArray
, 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. * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @param targetSqlType the SQL type (as defined in java.sql.Types) to be * sent to the database. The scale argument may further qualify this type. * @param 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. * @exception SQLException if a database access error occurs * @see Types * @see #getObject * @since 1.4 */ public void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException { throw Driver.notImplemented(this.getClass(), "setObject(String,Object,int,int)"); } /** * 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. * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @param targetSqlType the SQL type (as defined in java.sql.Types) to be * sent to the database * @exception SQLException if a database access error occurs * @see #getObject * @since 1.4 */ public void setObject(String parameterName, Object x, int targetSqlType) throws SQLException { throw Driver.notImplemented(this.getClass(), "setObject(String,Object,int)"); } /** * Sets the value of the designated parameter with the given object. * The second parameter must be of typeObject
; 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 methodSQLData.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
, * orArray
, 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. * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @exception SQLException if a database access error occurs or if the given *
Object
parameter is ambiguous * @see #getObject * @since 1.4 */ public void setObject(String parameterName, Object x) throws SQLException { throw Driver.notImplemented(this.getClass(), "setObject(String,Object)"); } /** * Sets the designated parameter to the givenReader
* object, which is the given number of characters long. * When a very large UNICODE value is input to aLONGVARCHAR
* 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. * * @param parameterName the name of the parameter * @param reader the
java.io.Reader
object that * contains the UNICODE data used as the designated parameter * @param length the number of characters in the stream * @exception SQLException if a database access error occurs * @since 1.4 */ public void setCharacterStream(String parameterName, java.io.Reader reader, int length) throws SQLException { throw Driver.notImplemented(this.getClass(), "setCharacterStream(String,Reader,int)"); } /** * Sets the designated parameter to the givenjava.sql.Date
value, * using the givenCalendar
object. The driver uses * theCalendar
object to construct an SQLDATE
value, * which the driver then sends to the database. With a * aCalendar
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. * * @param parameterName the name of the parameter * @param x the parameter value * @param cal theCalendar
object the driver will use * to construct the date * @exception SQLException if a database access error occurs * @see #getDate * @since 1.4 */ public void setDate(String parameterName, java.sql.Date x, Calendar cal) throws SQLException { throw Driver.notImplemented(this.getClass(), "setDate(String,Date,Calendar)"); } /** * Sets the designated parameter to the givenjava.sql.Time
value, * using the givenCalendar
object. The driver uses * theCalendar
object to construct an SQLTIME
value, * which the driver then sends to the database. With a * aCalendar
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. * * @param parameterName the name of the parameter * @param x the parameter value * @param cal theCalendar
object the driver will use * to construct the time * @exception SQLException if a database access error occurs * @see #getTime * @since 1.4 */ public void setTime(String parameterName, java.sql.Time x, Calendar cal) throws SQLException { throw Driver.notImplemented(this.getClass(), "setTime(String,Time,Calendar)"); } /** * Sets the designated parameter to the givenjava.sql.Timestamp
value, * using the givenCalendar
object. The driver uses * theCalendar
object to construct an SQLTIMESTAMP
value, * which the driver then sends to the database. With a * aCalendar
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. * * @param parameterName the name of the parameter * @param x the parameter value * @param cal theCalendar
object the driver will use * to construct the timestamp * @exception SQLException if a database access error occurs * @see #getTimestamp * @since 1.4 */ public void setTimestamp(String parameterName, java.sql.Timestamp x, Calendar cal) throws SQLException { throw Driver.notImplemented(this.getClass(), "setTimestamp(String,Timestamp,Calendar)"); } /** * Sets the designated parameter to SQLNULL
. * This version of the methodsetNull
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. * * * @param parameterName the name of the parameter * @param sqlType a value from
java.sql.Types
* @param typeName the fully-qualified name of an SQL user-defined type; * ignored if the parameter is not a user-defined type or * SQLREF
value * @exception SQLException if a database access error occurs * @since 1.4 */ public void setNull (String parameterName, int sqlType, String typeName) throws SQLException { throw Driver.notImplemented(this.getClass(), "setNull(String,int,String)"); } /** * Retrieves the value of a JDBCCHAR
,VARCHAR
, * orLONGVARCHAR
parameter as aString
in * the Java programming language. ** For the fixed-length type JDBC
CHAR
, * theString
object * returned has exactly the same value the JDBC *CHAR
value had in the * database, including any padding added by the database. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * isnull
. * @exception SQLException if a database access error occurs * @see #setString * @since 1.4 */ public String getString(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getString(String)"); } /** * Retrieves the value of a JDBCBIT
parameter as a *boolean
in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * isfalse
. * @exception SQLException if a database access error occurs * @see #setBoolean * @since 1.4 */ public boolean getBoolean(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getBoolean(String)"); } /** * Retrieves the value of a JDBCTINYINT
parameter as abyte
* in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * is0
. * @exception SQLException if a database access error occurs * @see #setByte * @since 1.4 */ public byte getByte(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getByte(String)"); } /** * Retrieves the value of a JDBCSMALLINT
parameter as ashort
* in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * is0
. * @exception SQLException if a database access error occurs * @see #setShort * @since 1.4 */ public short getShort(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getShort(String)"); } /** * Retrieves the value of a JDBCINTEGER
parameter as anint
* in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, * the result is0
. * @exception SQLException if a database access error occurs * @see #setInt * @since 1.4 */ public int getInt(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getInt(String)"); } /** * Retrieves the value of a JDBCBIGINT
parameter as along
* in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, * the result is0
. * @exception SQLException if a database access error occurs * @see #setLong * @since 1.4 */ public long getLong(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getLong(String)"); } /** * Retrieves the value of a JDBCFLOAT
parameter as afloat
* in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, * the result is0
. * @exception SQLException if a database access error occurs * @see #setFloat * @since 1.4 */ public float getFloat(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getFloat(String)"); } /** * Retrieves the value of a JDBCDOUBLE
parameter as adouble
* in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, * the result is0
. * @exception SQLException if a database access error occurs * @see #setDouble * @since 1.4 */ public double getDouble(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getDouble(String)"); } /** * Retrieves the value of a JDBCBINARY
orVARBINARY
* parameter as an array ofbyte
values in the Java * programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result is *null
. * @exception SQLException if a database access error occurs * @see #setBytes * @since 1.4 */ public byte[] getBytes(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getBytes(String)"); } /** * Retrieves the value of a JDBCDATE
parameter as a *java.sql.Date
object. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * isnull
. * @exception SQLException if a database access error occurs * @see #setDate * @since 1.4 */ public java.sql.Date getDate(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getDate(String)"); } /** * Retrieves the value of a JDBCTIME
parameter as a *java.sql.Time
object. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * isnull
. * @exception SQLException if a database access error occurs * @see #setTime * @since 1.4 */ public java.sql.Time getTime(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getTime(String)"); } /** * Retrieves the value of a JDBCTIMESTAMP
parameter as a *java.sql.Timestamp
object. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQLNULL
, the result * isnull
. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since 1.4 */ public java.sql.Timestamp getTimestamp(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getTimestamp(String)"); } /** * Retrieves the value of a parameter as anObject
in the Java * programming language. If the value is an SQLNULL
, the * driver returns a Javanull
. ** 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 asjava.sql.Types.OTHER
, this method can be used * to read database-specific abstract data types. * @param parameterName the name of the parameter * @return Ajava.lang.Object
holding the OUT parameter value. * @exception SQLException if a database access error occurs * @see Types * @see #setObject * @since 1.4 */ public Object getObject(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getObject(String)"); } /** * Retrieves the value of a JDBCNUMERIC
parameter as a *java.math.BigDecimal
object with as many digits to the * right of the decimal point as the value contains. * @param parameterName the name of the parameter * @return the parameter value in full precision. If the value is * SQLNULL
, the result isnull
. * @exception SQLException if a database access error occurs * @see #setBigDecimal * @since 1.4 */ public BigDecimal getBigDecimal(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getBigDecimal(String)"); } /** * Returns an object representing the value of OUT parameter *i
and usesmap
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 asjava.sql.Types.OTHER
, this method can * be used to read database-specific abstract data types. * @param parameterName the name of the parameter * @param map the mapping from SQL type names to Java classes * @return ajava.lang.Object
holding the OUT parameter value * @exception SQLException if a database access error occurs * @see #setObject * @since 1.4 */ public Object getObjectImpl (String parameterName, java.util.Map map) throws SQLException { throw Driver.notImplemented(this.getClass(), "getObject(String,Map)"); } /** * Retrieves the value of a JDBCREF(<structured-type>)
* parameter as a {@link Ref} object in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value as aRef
object in the * Java programming language. If the value was SQLNULL
, * the valuenull
is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ public Ref getRef (String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getRef(String)"); } /** * Retrieves the value of a JDBCBLOB
parameter as a * {@link Blob} object in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value as aBlob
object in the * Java programming language. If the value was SQLNULL
, * the valuenull
is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ public Blob getBlob (String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getBlob(String)"); } /** * Retrieves the value of a JDBCCLOB
parameter as a *Clob
object in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value as aClob
object in the * Java programming language. If the value was SQLNULL
, * the valuenull
is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ public Clob getClob (String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getClob(String)"); } /** * Retrieves the value of a JDBCARRAY
parameter as an * {@link Array} object in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value as anArray
object in * Java programming language. If the value was SQLNULL
, * the valuenull
is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ public Array getArray (String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getArray(String)"); } /** * Retrieves the value of a JDBCDATE
parameter as a *java.sql.Date
object, using * the givenCalendar
object * to construct the date. * With aCalendar
object, the driver * can calculate the date taking into account a custom timezone and locale. * If noCalendar
object is specified, the driver uses the * default timezone and locale. * * @param parameterName the name of the parameter * @param cal theCalendar
object the driver will use * to construct the date * @return the parameter value. If the value is SQLNULL
, * the result isnull
. * @exception SQLException if a database access error occurs * @see #setDate * @since 1.4 */ public java.sql.Date getDate(String parameterName, Calendar cal) throws SQLException { throw Driver.notImplemented(this.getClass(), "getDate(String,Calendar)"); } /** * Retrieves the value of a JDBCTIME
parameter as a *java.sql.Time
object, using * the givenCalendar
object * to construct the time. * With aCalendar
object, the driver * can calculate the time taking into account a custom timezone and locale. * If noCalendar
object is specified, the driver uses the * default timezone and locale. * * @param parameterName the name of the parameter * @param cal theCalendar
object the driver will use * to construct the time * @return the parameter value; if the value is SQLNULL
, the result is *null
. * @exception SQLException if a database access error occurs * @see #setTime * @since 1.4 */ public java.sql.Time getTime(String parameterName, Calendar cal) throws SQLException { throw Driver.notImplemented(this.getClass(), "getTime(String,Calendar)"); } /** * Retrieves the value of a JDBCTIMESTAMP
parameter as a *java.sql.Timestamp
object, using * the givenCalendar
object to construct * theTimestamp
object. * With aCalendar
object, the driver * can calculate the timestamp taking into account a custom timezone and locale. * If noCalendar
object is specified, the driver uses the * default timezone and locale. * * * @param parameterName the name of the parameter * @param cal theCalendar
object the driver will use * to construct the timestamp * @return the parameter value. If the value is SQLNULL
, the result is *null
. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since 1.4 */ public java.sql.Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException { throw Driver.notImplemented(this.getClass(), "getTimestamp(String,Calendar)"); } /** * Retrieves the value of a JDBCDATALINK
parameter as a *java.net.URL
object. * * @param parameterName the name of the parameter * @return the parameter value as ajava.net.URL
object in the * Java programming language. If the value was SQLNULL
, the * valuenull
is returned. * @exception SQLException if a database access error occurs, * or if there is a problem with the URL * @see #setURL * @since 1.4 */ public java.net.URL getURL(String parameterName) throws SQLException { throw Driver.notImplemented(this.getClass(), "getURL(String)"); } public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLException { if (targetSqlType == Types.BOOLEAN) { targetSqlType = Types.BIT; } super.setObject(parameterIndex, x, targetSqlType, scale); } public void setNull(int parameterIndex, int sqlType) throws SQLException { if (sqlType == Types.BOOLEAN) { sqlType = Types.BIT; } super.setNull(parameterIndex, sqlType); } protected boolean wantsHoldableResultSet() { return rsHoldability == ResultSet.HOLD_CURSORS_OVER_COMMIT; } public void registerOutParameter( int parameterIndex, int sqlType ) throws SQLException { // if this isn't 8.1 or we are using protocol version 2 then we don't // register the parameter switch( sqlType ) { case Types.BOOLEAN: sqlType = Types.BIT; break; default: } super.registerOutParameter(parameterIndex, sqlType, !adjustIndex ); } public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException { // ignore scale for now registerOutParameter(parameterIndex, sqlType ); } }