/* * @(#)ResultSet.java 1.49 04/06/28 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.sql; import java.math.BigDecimal; import java.util.Calendar; /** * A table of data representing a database result set, which * is usually generated by executing a statement that queries the database. * *
A ResultSet
object maintains a cursor pointing
* to its current row of data. Initially the cursor is positioned
* before the first row. The next
method moves the
* cursor to the next row, and because it returns false
* when there are no more rows in the ResultSet
object,
* it can be used in a while
loop to iterate through
* the result set.
*
* A default ResultSet
object is not updatable and
* has a cursor that moves forward only. Thus, you can
* iterate through it only once and only from the first row to the
* last row. It is possible to
* produce ResultSet
objects that are scrollable and/or
* updatable. The following code fragment, in which con
* is a valid Connection
object, illustrates how to make
* a result set that is scrollable and insensitive to updates by others, and
* that is updatable. See ResultSet
fields for other
* options.
*
* * Statement stmt = con.createStatement( * ResultSet.TYPE_SCROLL_INSENSITIVE, * ResultSet.CONCUR_UPDATABLE); * ResultSet rs = stmt.executeQuery("SELECT a, b FROM TABLE2"); * // rs will be scrollable, will not show changes made by others, * // and will be updatable * ** The
ResultSet
interface provides
* getter methods (getBoolean
, getLong
, and so on)
* for retrieving column values from the current row.
* Values can be retrieved using either the index number of the
* column or the name of the column. In general, using the
* column index will be more efficient. Columns are numbered from 1.
* For maximum portability, result set columns within each row should be
* read in left-to-right order, and each column should be read only once.
*
* For the getter methods, a JDBC driver attempts
* to convert the underlying data to the Java type specified in the
* getter method and returns a suitable Java value. The JDBC specification
* has a table showing the allowable mappings from SQL types to Java types
* that can be used by the ResultSet
getter methods.
*
*
Column names used as input to getter methods are case * insensitive. When a getter method is called with * a column name and several columns have the same name, * the value of the first matching column will be returned. * The column name option is * designed to be used when column names are used in the SQL * query that generated the result set. * For columns that are NOT explicitly named in the query, it * is best to use column numbers. If column names are used, there is * no way for the programmer to guarantee that they actually refer to * the intended columns. *
* A set of updater methods were added to this interface * in the JDBC 2.0 API (JDK 1.2). * The comments regarding parameters * to the getter methods also apply to parameters to the * updater methods. *
* The updater methods may be used in two ways: *
ResultSet
object, the cursor can be moved backwards
* and forwards, to an absolute position, or to a position
* relative to the current row.
* The following code fragment updates the NAME
column
* in the fifth row of the ResultSet
object
* rs
and then uses the method updateRow
* to update the data source table from which rs
was derived.
* * * rs.absolute(5); // moves the cursor to the fifth row of rs * rs.updateString("NAME", "AINSWORTH"); // updates the * //*NAME
column of row 5 to beAINSWORTH
* rs.updateRow(); // updates the row in the data source * *
ResultSet
object has a special row associated with
* it that serves as a staging area for building a row to be inserted.
* The following code fragment moves the cursor to the insert row, builds
* a three-column row, and inserts it into rs
and into
* the data source table using the method insertRow
.
* * * rs.moveToInsertRow(); // moves cursor to the insert row * rs.updateString(1, "AINSWORTH"); // updates the * // first column of the insert row to be*AINSWORTH
* rs.updateInt(2,35); // updates the second column to be35
* rs.updateBoolean(3, true); // updates the third column totrue
* rs.insertRow(); * rs.moveToCurrentRow(); * *
A ResultSet
object is automatically closed when the
* Statement
object that
* generated it is closed, re-executed, or used
* to retrieve the next result from a sequence of multiple results.
*
*
The number, types and properties of a ResultSet
* object's columns are provided by the ResulSetMetaData
* object returned by the ResultSet.getMetaData
method.
*
* @see Statement#executeQuery
* @see Statement#getResultSet
* @see ResultSetMetaData
*/
public interface ResultSet {
/**
* Moves the cursor down one row from its current position.
* A ResultSet
cursor is initially positioned
* before the first row; the first call to the method
* next
makes the first row the current row; the
* second call makes the second row the current row, and so on.
*
*
If an input stream is open for the current row, a call
* to the method next
will
* implicitly close it. A ResultSet
object's
* warning chain is cleared when a new row is read.
*
* @return true
if the new current row is valid;
* false
if there are no more rows
* @exception SQLException if a database access error occurs
*/
boolean next() throws SQLException;
/**
* Releases this ResultSet
object's database and
* JDBC resources immediately instead of waiting for
* this to happen when it is automatically closed.
*
*
Note: A ResultSet
object
* is automatically closed by the
* Statement
object that generated it when
* that Statement
object is closed,
* re-executed, or is used to retrieve the next result from a
* sequence of multiple results. A ResultSet
object
* is also automatically closed when it is garbage collected.
*
* @exception SQLException if a database access error occurs
*/
void close() throws SQLException;
/**
* Reports whether
* the last column read had a value of SQL NULL
.
* Note that you must first call one of the getter methods
* on a column to try to read its value and then call
* the method wasNull
to see if the value read was
* SQL NULL
.
*
* @return true
if the last column value read was SQL
* NULL
and false
otherwise
* @exception SQLException if a database access error occurs
*/
boolean wasNull() throws SQLException;
//======================================================================
// Methods for accessing results by column index
//======================================================================
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a String
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
String getString(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a boolean
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is false
* @exception SQLException if a database access error occurs
*/
boolean getBoolean(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a byte
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
byte getByte(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a short
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
short getShort(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* an int
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
int getInt(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a long
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
long getLong(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a float
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
float getFloat(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a double
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
double getDouble(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.BigDecimal
in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param scale the number of digits to the right of the decimal point
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
* @deprecated
*/
@Deprecated
BigDecimal getBigDecimal(int columnIndex, int scale) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a byte
array in the Java programming language.
* The bytes represent the raw values returned by the driver.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
byte[] getBytes(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.Date
object in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
java.sql.Date getDate(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.Time
object in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
java.sql.Time getTime(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.Timestamp
object in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
java.sql.Timestamp getTimestamp(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a stream of ASCII characters. The value can then be read in chunks from the
* stream. This method is particularly
* suitable for retrieving large
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
* call to a getter method implicitly closes the stream. Also, a
* stream may return 0
when the method
* InputStream.available
* is called whether there is data available or not.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return a Java input stream that delivers the database column value
* as a stream of one-byte ASCII characters;
* if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
java.io.InputStream getAsciiStream(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* as a stream of two-byte Unicode characters. The first byte is
* the high byte; the second byte is the low byte.
*
* The value can then be read in chunks from the
* stream. This method is particularly
* suitable for retrieving large LONGVARCHAR
values. The
* JDBC driver will do any necessary conversion from the database
* format into Unicode.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
* call to a getter method implicitly closes the stream.
* Also, a stream may return 0
when the method
* InputStream.available
* is called, whether there is data available or not.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return a Java input stream that delivers the database column value
* as a stream of two-byte Unicode characters;
* if the value is SQL NULL
, the value returned is
* null
*
* @exception SQLException if a database access error occurs
* @deprecated use getCharacterStream
in place of
* getUnicodeStream
*/
@Deprecated
java.io.InputStream getUnicodeStream(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a binary stream of
* uninterpreted bytes. The value can then be read in chunks from the
* stream. This method is particularly
* suitable for retrieving large LONGVARBINARY
values.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
* call to a getter method implicitly closes the stream. Also, a
* stream may return 0
when the method
* InputStream.available
* is called whether there is data available or not.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return a Java input stream that delivers the database column value
* as a stream of uninterpreted bytes;
* if the value is SQL NULL
, the value returned is
* null
* @exception SQLException if a database access error occurs
*/
java.io.InputStream getBinaryStream(int columnIndex)
throws SQLException;
//======================================================================
// Methods for accessing results by column name
//======================================================================
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a String
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
String getString(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a boolean
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is false
* @exception SQLException if a database access error occurs
*/
boolean getBoolean(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a byte
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
byte getByte(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a short
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
short getShort(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* an int
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
int getInt(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a long
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
long getLong(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a float
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
float getFloat(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a double
in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is 0
* @exception SQLException if a database access error occurs
*/
double getDouble(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.math.BigDecimal
in the Java programming language.
*
* @param columnName the SQL name of the column
* @param scale the number of digits to the right of the decimal point
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
* @deprecated
*/
@Deprecated
BigDecimal getBigDecimal(String columnName, int scale) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a byte
array in the Java programming language.
* The bytes represent the raw values returned by the driver.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
byte[] getBytes(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.Date
object in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
java.sql.Date getDate(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.Time
object in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value;
* if the value is SQL NULL
,
* the value returned is null
* @exception SQLException if a database access error occurs
*/
java.sql.Time getTime(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as
* a java.sql.Timestamp
object.
*
* @param columnName the SQL name of the column
* @return the column value; if the value is SQL NULL
, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
java.sql.Timestamp getTimestamp(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a stream of
* ASCII characters. The value can then be read in chunks from the
* stream. This method is particularly
* suitable for retrieving large LONGVARCHAR
values.
* The JDBC driver will
* do any necessary conversion from the database format into ASCII.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
* call to a getter method implicitly closes the stream. Also, a
* stream may return 0
when the method available
* is called whether there is data available or not.
*
* @param columnName the SQL name of the column
* @return a Java input stream that delivers the database column value
* as a stream of one-byte ASCII characters.
* If the value is SQL NULL
,
* the value returned is null
.
* @exception SQLException if a database access error occurs
*/
java.io.InputStream getAsciiStream(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a stream of two-byte
* Unicode characters. The first byte is the high byte; the second
* byte is the low byte.
*
* The value can then be read in chunks from the
* stream. This method is particularly
* suitable for retrieving large LONGVARCHAR
values.
* The JDBC technology-enabled driver will
* do any necessary conversion from the database format into Unicode.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
* call to a getter method implicitly closes the stream.
* Also, a stream may return 0
when the method
* InputStream.available
is called, whether there
* is data available or not.
*
* @param columnName the SQL name of the column
* @return a Java input stream that delivers the database column value
* as a stream of two-byte Unicode characters.
* If the value is SQL NULL
, the value returned
* is null
.
* @exception SQLException if a database access error occurs
* @deprecated use getCharacterStream
instead
*/
@Deprecated
java.io.InputStream getUnicodeStream(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a stream of uninterpreted
* byte
s.
* The value can then be read in chunks from the
* stream. This method is particularly
* suitable for retrieving large LONGVARBINARY
* values.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
* call to a getter method implicitly closes the stream. Also, a
* stream may return 0
when the method available
* is called whether there is data available or not.
*
* @param columnName the SQL name of the column
* @return a Java input stream that delivers the database column value
* as a stream of uninterpreted bytes;
* if the value is SQL NULL
, the result is null
* @exception SQLException if a database access error occurs
*/
java.io.InputStream getBinaryStream(String columnName)
throws SQLException;
//=====================================================================
// Advanced features:
//=====================================================================
/**
* Retrieves the first warning reported by calls on this
* ResultSet
object.
* Subsequent warnings on this ResultSet
object
* will be chained to the SQLWarning
object that
* this method returns.
*
*
The warning chain is automatically cleared each time a new
* row is read. This method may not be called on a ResultSet
* object that has been closed; doing so will cause an
* SQLException
to be thrown.
*
* Note: This warning chain only covers warnings caused
* by ResultSet
methods. Any warning caused by
* Statement
methods
* (such as reading OUT parameters) will be chained on the
* Statement
object.
*
* @return the first SQLWarning
object reported or
* null
if there are none
* @exception SQLException if a database access error occurs or this method is
* called on a closed result set
*/
SQLWarning getWarnings() throws SQLException;
/**
* Clears all warnings reported on this ResultSet
object.
* After this method is called, the method getWarnings
* returns null
until a new warning is
* reported for this ResultSet
object.
*
* @exception SQLException if a database access error occurs
*/
void clearWarnings() throws SQLException;
/**
* Retrieves the name of the SQL cursor used by this ResultSet
* object.
*
*
In SQL, a result table is retrieved through a cursor that is
* named. The current row of a result set can be updated or deleted
* using a positioned update/delete statement that references the
* cursor name. To insure that the cursor has the proper isolation
* level to support update, the cursor's SELECT
statement
* should be of the form SELECT FOR UPDATE
. If
* FOR UPDATE
is omitted, the positioned updates may fail.
*
*
The JDBC API supports this SQL feature by providing the name of the
* SQL cursor used by a ResultSet
object.
* The current row of a ResultSet
object
* is also the current row of this SQL cursor.
*
*
Note: If positioned update is not supported, a
* SQLException
is thrown.
*
* @return the SQL name for this ResultSet
object's cursor
* @exception SQLException if a database access error occurs
*/
String getCursorName() throws SQLException;
/**
* Retrieves the number, types and properties of
* this ResultSet
object's columns.
*
* @return the description of this ResultSet
object's columns
* @exception SQLException if a database access error occurs
*/
ResultSetMetaData getMetaData() throws SQLException;
/**
*
Gets the value of the designated column in the current row
* of this ResultSet
object as
* an Object
in the Java programming language.
*
*
This method will return the value of the given column as a
* Java object. The type of the Java object will be the default
* Java object type corresponding to the column's SQL type,
* following the mapping for built-in types specified in the JDBC
* specification. If the value is an SQL NULL
,
* the driver returns a Java null
.
*
*
This method may also be used to read database-specific
* abstract data types.
*
* In the JDBC 2.0 API, the behavior of method
* getObject
is extended to materialize
* data of SQL user-defined types. When a column contains
* a structured or distinct value, the behavior of this method is as
* if it were a call to: getObject(columnIndex,
* this.getStatement().getConnection().getTypeMap())
.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return a java.lang.Object
holding the column value
* @exception SQLException if a database access error occurs
*/
Object getObject(int columnIndex) throws SQLException;
/**
*
Gets the value of the designated column in the current row
* of this ResultSet
object as
* an Object
in the Java programming language.
*
*
This method will return the value of the given column as a
* Java object. The type of the Java object will be the default
* Java object type corresponding to the column's SQL type,
* following the mapping for built-in types specified in the JDBC
* specification. If the value is an SQL NULL
,
* the driver returns a Java null
.
*
* This method may also be used to read database-specific * abstract data types. *
* In the JDBC 2.0 API, the behavior of the method
* getObject
is extended to materialize
* data of SQL user-defined types. When a column contains
* a structured or distinct value, the behavior of this method is as
* if it were a call to: getObject(columnIndex,
* this.getStatement().getConnection().getTypeMap())
.
*
* @param columnName the SQL name of the column
* @return a java.lang.Object
holding the column value
* @exception SQLException if a database access error occurs
*/
Object getObject(String columnName) throws SQLException;
//----------------------------------------------------------------
/**
* Maps the given ResultSet
column name to its
* ResultSet
column index.
*
* @param columnName the name of the column
* @return the column index of the given column name
* @exception SQLException if the ResultSet
object
* does not contain columnName
or a database access error occurs
*/
int findColumn(String columnName) throws SQLException;
//--------------------------JDBC 2.0-----------------------------------
//---------------------------------------------------------------------
// Getters and Setters
//---------------------------------------------------------------------
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a
* java.io.Reader
object.
* @return a java.io.Reader
object that contains the column
* value; if the value is SQL NULL
, the value returned is
* null
in the Java programming language.
* @param columnIndex the first column is 1, the second is 2, ...
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.io.Reader getCharacterStream(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a
* java.io.Reader
object.
*
* @param columnName the name of the column
* @return a java.io.Reader
object that contains the column
* value; if the value is SQL NULL
, the value returned is
* null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.io.Reader getCharacterStream(String columnName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a
* java.math.BigDecimal
with full precision.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @return the column value (full precision);
* if the value is SQL NULL
, the value returned is
* null
in the Java programming language.
* @exception SQLException if a database access error occurs
* @since 1.2
*/
BigDecimal getBigDecimal(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a
* java.math.BigDecimal
with full precision.
*
* @param columnName the column name
* @return the column value (full precision);
* if the value is SQL NULL
, the value returned is
* null
in the Java programming language.
* @exception SQLException if a database access error occurs
* @since 1.2
*
*/
BigDecimal getBigDecimal(String columnName) throws SQLException;
//---------------------------------------------------------------------
// Traversal/Positioning
//---------------------------------------------------------------------
/**
* Retrieves whether the cursor is before the first row in
* this ResultSet
object.
*
* @return true
if the cursor is before the first row;
* false
if the cursor is at any other position or the
* result set contains no rows
* @exception SQLException if a database access error occurs
* @since 1.2
*/
boolean isBeforeFirst() throws SQLException;
/**
* Retrieves whether the cursor is after the last row in
* this ResultSet
object.
*
* @return true
if the cursor is after the last row;
* false
if the cursor is at any other position or the
* result set contains no rows
* @exception SQLException if a database access error occurs
* @since 1.2
*/
boolean isAfterLast() throws SQLException;
/**
* Retrieves whether the cursor is on the first row of
* this ResultSet
object.
*
* @return true
if the cursor is on the first row;
* false
otherwise
* @exception SQLException if a database access error occurs
* @since 1.2
*/
boolean isFirst() throws SQLException;
/**
* Retrieves whether the cursor is on the last row of
* this ResultSet
object.
* Note: Calling the method isLast
may be expensive
* because the JDBC driver
* might need to fetch ahead one row in order to determine
* whether the current row is the last row in the result set.
*
* @return true
if the cursor is on the last row;
* false
otherwise
* @exception SQLException if a database access error occurs
* @since 1.2
*/
boolean isLast() throws SQLException;
/**
* Moves the cursor to the front of
* this ResultSet
object, just before the
* first row. This method has no effect if the result set contains no rows.
*
* @exception SQLException if a database access error
* occurs or the result set type is TYPE_FORWARD_ONLY
* @since 1.2
*/
void beforeFirst() throws SQLException;
/**
* Moves the cursor to the end of
* this ResultSet
object, just after the
* last row. This method has no effect if the result set contains no rows.
* @exception SQLException if a database access error
* occurs or the result set type is TYPE_FORWARD_ONLY
* @since 1.2
*/
void afterLast() throws SQLException;
/**
* Moves the cursor to the first row in
* this ResultSet
object.
*
* @return true
if the cursor is on a valid row;
* false
if there are no rows in the result set
* @exception SQLException if a database access error
* occurs or the result set type is TYPE_FORWARD_ONLY
* @since 1.2
*/
boolean first() throws SQLException;
/**
* Moves the cursor to the last row in
* this ResultSet
object.
*
* @return true
if the cursor is on a valid row;
* false
if there are no rows in the result set
* @exception SQLException if a database access error
* occurs or the result set type is TYPE_FORWARD_ONLY
* @since 1.2
*/
boolean last() throws SQLException;
/**
* Retrieves the current row number. The first row is number 1, the
* second number 2, and so on.
*
* @return the current row number; 0
if there is no current row
* @exception SQLException if a database access error occurs
* @since 1.2
*/
int getRow() throws SQLException;
/**
* Moves the cursor to the given row number in
* this ResultSet
object.
*
*
If the row number is positive, the cursor moves to * the given row number with respect to the * beginning of the result set. The first row is row 1, the second * is row 2, and so on. * *
If the given row number is negative, the cursor moves to
* an absolute row position with respect to
* the end of the result set. For example, calling the method
* absolute(-1)
positions the
* cursor on the last row; calling the method absolute(-2)
* moves the cursor to the next-to-last row, and so on.
*
*
An attempt to position the cursor beyond the first/last row in * the result set leaves the cursor before the first row or after * the last row. * *
Note: Calling absolute(1)
is the same
* as calling first()
. Calling absolute(-1)
* is the same as calling last()
.
*
* @param row the number of the row to which the cursor should move.
* A positive number indicates the row number counting from the
* beginning of the result set; a negative number indicates the
* row number counting from the end of the result set
* @return true
if the cursor is on the result set;
* false
otherwise
* @exception SQLException if a database access error
* occurs, or the result set type is TYPE_FORWARD_ONLY
* @since 1.2
*/
boolean absolute( int row ) throws SQLException;
/**
* Moves the cursor a relative number of rows, either positive or negative.
* Attempting to move beyond the first/last row in the
* result set positions the cursor before/after the
* the first/last row. Calling relative(0)
is valid, but does
* not change the cursor position.
*
*
Note: Calling the method relative(1)
* is identical to calling the method next()
and
* calling the method relative(-1)
is identical
* to calling the method previous()
.
*
* @param rows an int
specifying the number of rows to
* move from the current row; a positive number moves the cursor
* forward; a negative number moves the cursor backward
* @return true
if the cursor is on a row;
* false
otherwise
* @exception SQLException if a database access error occurs,
* there is no current row, or the result set type is
* TYPE_FORWARD_ONLY
* @since 1.2
*/
boolean relative( int rows ) throws SQLException;
/**
* Moves the cursor to the previous row in this
* ResultSet
object.
*
* @return true
if the cursor is on a valid row;
* false
if it is off the result set
* @exception SQLException if a database access error
* occurs or the result set type is TYPE_FORWARD_ONLY
* @since 1.2
*/
boolean previous() throws SQLException;
//---------------------------------------------------------------------
// Properties
//---------------------------------------------------------------------
/**
* The constant indicating that the rows in a result set will be
* processed in a forward direction; first-to-last.
* This constant is used by the method setFetchDirection
* as a hint to the driver, which the driver may ignore.
* @since 1.2
*/
int FETCH_FORWARD = 1000;
/**
* The constant indicating that the rows in a result set will be
* processed in a reverse direction; last-to-first.
* This constant is used by the method setFetchDirection
* as a hint to the driver, which the driver may ignore.
* @since 1.2
*/
int FETCH_REVERSE = 1001;
/**
* The constant indicating that the order in which rows in a
* result set will be processed is unknown.
* This constant is used by the method setFetchDirection
* as a hint to the driver, which the driver may ignore.
*/
int FETCH_UNKNOWN = 1002;
/**
* Gives a hint as to the direction in which the rows in this
* ResultSet
object will be processed.
* The initial value is determined by the
* Statement
object
* that produced this ResultSet
object.
* The fetch direction may be changed at any time.
*
* @param direction an int
specifying the suggested
* fetch direction; one of ResultSet.FETCH_FORWARD
,
* ResultSet.FETCH_REVERSE
, or
* ResultSet.FETCH_UNKNOWN
* @exception SQLException if a database access error occurs or
* the result set type is TYPE_FORWARD_ONLY
and the fetch
* direction is not FETCH_FORWARD
* @since 1.2
* @see Statement#setFetchDirection
* @see #getFetchDirection
*/
void setFetchDirection(int direction) throws SQLException;
/**
* Retrieves the fetch direction for this
* ResultSet
object.
*
* @return the current fetch direction for this ResultSet
object
* @exception SQLException if a database access error occurs
* @since 1.2
* @see #setFetchDirection
*/
int getFetchDirection() throws SQLException;
/**
* Gives the JDBC driver a hint as to the number of rows that should
* be fetched from the database when more rows are needed for this
* ResultSet
object.
* If the fetch size specified is zero, the JDBC driver
* ignores the value and is free to make its own best guess as to what
* the fetch size should be. The default value is set by the
* Statement
object
* that created the result set. The fetch size may be changed at any time.
*
* @param rows the number of rows to fetch
* @exception SQLException if a database access error occurs or the
* condition 0 <= rows <= Statement.getMaxRows()
is not satisfied
* @since 1.2
* @see #getFetchSize
*/
void setFetchSize(int rows) throws SQLException;
/**
* Retrieves the fetch size for this
* ResultSet
object.
*
* @return the current fetch size for this ResultSet
object
* @exception SQLException if a database access error occurs
* @since 1.2
* @see #setFetchSize
*/
int getFetchSize() throws SQLException;
/**
* The constant indicating the type for a ResultSet
object
* whose cursor may move only forward.
* @since 1.2
*/
int TYPE_FORWARD_ONLY = 1003;
/**
* The constant indicating the type for a ResultSet
object
* that is scrollable but generally not sensitive to changes made by others.
* @since 1.2
*/
int TYPE_SCROLL_INSENSITIVE = 1004;
/**
* The constant indicating the type for a ResultSet
object
* that is scrollable and generally sensitive to changes made by others.
* @since 1.2
*/
int TYPE_SCROLL_SENSITIVE = 1005;
/**
* Retrieves the type of this ResultSet
object.
* The type is determined by the Statement
object
* that created the result set.
*
* @return ResultSet.TYPE_FORWARD_ONLY
,
* ResultSet.TYPE_SCROLL_INSENSITIVE
,
* or ResultSet.TYPE_SCROLL_SENSITIVE
* @exception SQLException if a database access error occurs
* @since 1.2
*/
int getType() throws SQLException;
/**
* The constant indicating the concurrency mode for a
* ResultSet
object that may NOT be updated.
* @since 1.2
*/
int CONCUR_READ_ONLY = 1007;
/**
* The constant indicating the concurrency mode for a
* ResultSet
object that may be updated.
* @since 1.2
*/
int CONCUR_UPDATABLE = 1008;
/**
* Retrieves the concurrency mode of this ResultSet
object.
* The concurrency used is determined by the
* Statement
object that created the result set.
*
* @return the concurrency type, either
* ResultSet.CONCUR_READ_ONLY
* or ResultSet.CONCUR_UPDATABLE
* @exception SQLException if a database access error occurs
* @since 1.2
*/
int getConcurrency() throws SQLException;
//---------------------------------------------------------------------
// Updates
//---------------------------------------------------------------------
/**
* Retrieves whether the current row has been updated. The value returned
* depends on whether or not the result set can detect updates.
*
* @return true
if both (1) the row has been visibly updated
* by the owner or another and (2) updates are detected
* @exception SQLException if a database access error occurs
* @see DatabaseMetaData#updatesAreDetected
* @since 1.2
*/
boolean rowUpdated() throws SQLException;
/**
* Retrieves whether the current row has had an insertion.
* The value returned depends on whether or not this
* ResultSet
object can detect visible inserts.
*
* @return true
if a row has had an insertion
* and insertions are detected; false
otherwise
* @exception SQLException if a database access error occurs
*
* @see DatabaseMetaData#insertsAreDetected
* @since 1.2
*/
boolean rowInserted() throws SQLException;
/**
* Retrieves whether a row has been deleted. A deleted row may leave
* a visible "hole" in a result set. This method can be used to
* detect holes in a result set. The value returned depends on whether
* or not this ResultSet
object can detect deletions.
*
* @return true
if a row was deleted and deletions are detected;
* false
otherwise
* @exception SQLException if a database access error occurs
*
* @see DatabaseMetaData#deletesAreDetected
* @since 1.2
*/
boolean rowDeleted() throws SQLException;
/**
* Gives a nullable column a null value.
*
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
* or insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateNull(int columnIndex) throws SQLException;
/**
* Updates the designated column with a boolean
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBoolean(int columnIndex, boolean x) throws SQLException;
/**
* Updates the designated column with a byte
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateByte(int columnIndex, byte x) throws SQLException;
/**
* Updates the designated column with a short
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateShort(int columnIndex, short x) throws SQLException;
/**
* Updates the designated column with an int
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateInt(int columnIndex, int x) throws SQLException;
/**
* Updates the designated column with a long
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateLong(int columnIndex, long x) throws SQLException;
/**
* Updates the designated column with a float
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateFloat(int columnIndex, float x) throws SQLException;
/**
* Updates the designated column with a double
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateDouble(int columnIndex, double x) throws SQLException;
/**
* Updates the designated column with a java.math.BigDecimal
* value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBigDecimal(int columnIndex, BigDecimal x) throws SQLException;
/**
* Updates the designated column with a String
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateString(int columnIndex, String x) throws SQLException;
/**
* Updates the designated column with a byte
array value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBytes(int columnIndex, byte x[]) throws SQLException;
/**
* Updates the designated column with a java.sql.Date
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateDate(int columnIndex, java.sql.Date x) throws SQLException;
/**
* Updates the designated column with a java.sql.Time
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateTime(int columnIndex, java.sql.Time x) throws SQLException;
/**
* Updates the designated column with a java.sql.Timestamp
* value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateTimestamp(int columnIndex, java.sql.Timestamp x)
throws SQLException;
/**
* Updates the designated column with an ascii stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateAsciiStream(int columnIndex,
java.io.InputStream x,
int length) throws SQLException;
/**
* Updates the designated column with a binary stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBinaryStream(int columnIndex,
java.io.InputStream x,
int length) throws SQLException;
/**
* Updates the designated column with a character stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateCharacterStream(int columnIndex,
java.io.Reader x,
int length) throws SQLException;
/**
* Updates the designated column with an Object
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param scale for java.sql.Types.DECIMA
* 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
* @since 1.2
*/
void updateObject(int columnIndex, Object x, int scale)
throws SQLException;
/**
* Updates the designated column with an Object
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateObject(int columnIndex, Object x) throws SQLException;
/**
* Updates the designated column with a null
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateNull(String columnName) throws SQLException;
/**
* Updates the designated column with a boolean
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBoolean(String columnName, boolean x) throws SQLException;
/**
* Updates the designated column with a byte
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateByte(String columnName, byte x) throws SQLException;
/**
* Updates the designated column with a short
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateShort(String columnName, short x) throws SQLException;
/**
* Updates the designated column with an int
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateInt(String columnName, int x) throws SQLException;
/**
* Updates the designated column with a long
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateLong(String columnName, long x) throws SQLException;
/**
* Updates the designated column with a float
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateFloat(String columnName, float x) throws SQLException;
/**
* Updates the designated column with a double
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateDouble(String columnName, double x) throws SQLException;
/**
* Updates the designated column with a java.sql.BigDecimal
* value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBigDecimal(String columnName, BigDecimal x) throws SQLException;
/**
* Updates the designated column with a String
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateString(String columnName, String x) throws SQLException;
/**
* Updates the designated column with a byte array value.
*
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
* or insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBytes(String columnName, byte x[]) throws SQLException;
/**
* Updates the designated column with a java.sql.Date
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateDate(String columnName, java.sql.Date x) throws SQLException;
/**
* Updates the designated column with a java.sql.Time
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateTime(String columnName, java.sql.Time x) throws SQLException;
/**
* Updates the designated column with a java.sql.Timestamp
* value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateTimestamp(String columnName, java.sql.Timestamp x)
throws SQLException;
/**
* Updates the designated column with an ascii stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateAsciiStream(String columnName,
java.io.InputStream x,
int length) throws SQLException;
/**
* Updates the designated column with a binary stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateBinaryStream(String columnName,
java.io.InputStream x,
int length) throws SQLException;
/**
* Updates the designated column with a character stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param reader the java.io.Reader
object containing
* the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateCharacterStream(String columnName,
java.io.Reader reader,
int length) throws SQLException;
/**
* Updates the designated column with an Object
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @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
* @since 1.2
*/
void updateObject(String columnName, Object x, int scale)
throws SQLException;
/**
* Updates the designated column with an Object
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
void updateObject(String columnName, Object x) throws SQLException;
/**
* Inserts the contents of the insert row into this
* ResultSet
object and into the database.
* The cursor must be on the insert row when this method is called.
*
* @exception SQLException if a database access error occurs,
* if this method is called when the cursor is not on the insert row,
* or if not all of non-nullable columns in
* the insert row have been given a value
* @since 1.2
*/
void insertRow() throws SQLException;
/**
* Updates the underlying database with the new contents of the
* current row of this ResultSet
object.
* This method cannot be called when the cursor is on the insert row.
*
* @exception SQLException if a database access error occurs or
* if this method is called when the cursor is on the insert row
* @since 1.2
*/
void updateRow() throws SQLException;
/**
* Deletes the current row from this ResultSet
object
* and from the underlying database. This method cannot be called when
* the cursor is on the insert row.
*
* @exception SQLException if a database access error occurs
* or if this method is called when the cursor is on the insert row
* @since 1.2
*/
void deleteRow() throws SQLException;
/**
* Refreshes the current row with its most recent value in
* the database. This method cannot be called when
* the cursor is on the insert row.
*
*
The refreshRow
method provides a way for an
* application to
* explicitly tell the JDBC driver to refetch a row(s) from the
* database. An application may want to call refreshRow
when
* caching or prefetching is being done by the JDBC driver to
* fetch the latest value of a row from the database. The JDBC driver
* may actually refresh multiple rows at once if the fetch size is
* greater than one.
*
*
All values are refetched subject to the transaction isolation
* level and cursor sensitivity. If refreshRow
is called after
* calling an updater method, but before calling
* the method updateRow
, then the
* updates made to the row are lost. Calling the method
* refreshRow
frequently will likely slow performance.
*
* @exception SQLException if a database access error
* occurs or if this method is called when the cursor is on the insert row
* @since 1.2
*/
void refreshRow() throws SQLException;
/**
* Cancels the updates made to the current row in this
* ResultSet
object.
* This method may be called after calling an
* updater method(s) and before calling
* the method updateRow
to roll back
* the updates made to a row. If no updates have been made or
* updateRow
has already been called, this method has no
* effect.
*
* @exception SQLException if a database access error
* occurs or if this method is called when the cursor is
* on the insert row
* @since 1.2
*/
void cancelRowUpdates() throws SQLException;
/**
* Moves the cursor to the insert row. The current cursor position is
* remembered while the cursor is positioned on the insert row.
*
* The insert row is a special row associated with an updatable
* result set. It is essentially a buffer where a new row may
* be constructed by calling the updater methods prior to
* inserting the row into the result set.
*
* Only the updater, getter,
* and insertRow
methods may be
* called when the cursor is on the insert row. All of the columns in
* a result set must be given a value each time this method is
* called before calling insertRow
.
* An updater method must be called before a
* getter method can be called on a column value.
*
* @exception SQLException if a database access error occurs
* or the result set is not updatable
* @since 1.2
*/
void moveToInsertRow() throws SQLException;
/**
* Moves the cursor to the remembered cursor position, usually the
* current row. This method has no effect if the cursor is not on
* the insert row.
*
* @exception SQLException if a database access error occurs
* or the result set is not updatable
* @since 1.2
*/
void moveToCurrentRow() throws SQLException;
/**
* Retrieves the Statement
object that produced this
* ResultSet
object.
* If the result set was generated some other way, such as by a
* DatabaseMetaData
method, this method returns
* null
.
*
* @return the Statment
object that produced
* this ResultSet
object or null
* if the result set was produced some other way
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Statement getStatement() throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as an Object
* in the Java programming language.
* If the value is an SQL NULL
,
* the driver returns a Java null
.
* This method uses the given Map
object
* for the custom mapping of the
* SQL structured or distinct type that is being retrieved.
*
* @param i the first column is 1, the second is 2, ...
* @param map a java.util.Map
object that contains the mapping
* from SQL type names to classes in the Java programming language
* @return an Object
in the Java programming language
* representing the SQL value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Object getObject(int i, java.util.MapResultSet
object as a Ref
object
* in the Java programming language.
*
* @param i the first column is 1, the second is 2, ...
* @return a Ref
object representing an SQL REF
* value
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Ref getRef(int i) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a Blob
object
* in the Java programming language.
*
* @param i the first column is 1, the second is 2, ...
* @return a Blob
object representing the SQL
* BLOB
value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Blob getBlob(int i) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a Clob
object
* in the Java programming language.
*
* @param i the first column is 1, the second is 2, ...
* @return a Clob
object representing the SQL
* CLOB
value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Clob getClob(int i) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as an Array
object
* in the Java programming language.
*
* @param i the first column is 1, the second is 2, ...
* @return an Array
object representing the SQL
* ARRAY
value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Array getArray(int i) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as an Object
* in the Java programming language.
* If the value is an SQL NULL
,
* the driver returns a Java null
.
* This method uses the specified Map
object for
* custom mapping if appropriate.
*
* @param colName the name of the column from which to retrieve the value
* @param map a java.util.Map
object that contains the mapping
* from SQL type names to classes in the Java programming language
* @return an Object
representing the SQL value in the
* specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Object getObject(String colName, java.util.MapResultSet
object as a Ref
object
* in the Java programming language.
*
* @param colName the column name
* @return a Ref
object representing the SQL REF
* value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Ref getRef(String colName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a Blob
object
* in the Java programming language.
*
* @param colName the name of the column from which to retrieve the value
* @return a Blob
object representing the SQL BLOB
* value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Blob getBlob(String colName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a Clob
object
* in the Java programming language.
*
* @param colName the name of the column from which to retrieve the value
* @return a Clob
object representing the SQL CLOB
* value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Clob getClob(String colName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as an Array
object
* in the Java programming language.
*
* @param colName the name of the column from which to retrieve the value
* @return an Array
object representing the SQL ARRAY
value in
* the specified column
* @exception SQLException if a database access error occurs
* @since 1.2
*/
Array getArray(String colName) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.sql.Date
object
* in the Java programming language.
* This method uses the given calendar to construct an appropriate millisecond
* value for the date if the underlying database does not store
* timezone information.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param cal the java.util.Calendar
object
* to use in constructing the date
* @return the column value as a java.sql.Date
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.sql.Date getDate(int columnIndex, Calendar cal) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.sql.Date
object
* in the Java programming language.
* This method uses the given calendar to construct an appropriate millisecond
* value for the date if the underlying database does not store
* timezone information.
*
* @param columnName the SQL name of the column from which to retrieve the value
* @param cal the java.util.Calendar
object
* to use in constructing the date
* @return the column value as a java.sql.Date
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.sql.Date getDate(String columnName, Calendar cal) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.sql.Time
object
* in the Java programming language.
* This method uses the given calendar to construct an appropriate millisecond
* value for the time if the underlying database does not store
* timezone information.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param cal the java.util.Calendar
object
* to use in constructing the time
* @return the column value as a java.sql.Time
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.sql.Time getTime(int columnIndex, Calendar cal) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.sql.Time
object
* in the Java programming language.
* This method uses the given calendar to construct an appropriate millisecond
* value for the time if the underlying database does not store
* timezone information.
*
* @param columnName the SQL name of the column
* @param cal the java.util.Calendar
object
* to use in constructing the time
* @return the column value as a java.sql.Time
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.sql.Time getTime(String columnName, Calendar cal) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.sql.Timestamp
object
* in the Java programming language.
* This method uses the given calendar to construct an appropriate millisecond
* value for the timestamp if the underlying database does not store
* timezone information.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param cal the java.util.Calendar
object
* to use in constructing the timestamp
* @return the column value as a java.sql.Timestamp
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.sql.Timestamp getTimestamp(int columnIndex, Calendar cal)
throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.sql.Timestamp
object
* in the Java programming language.
* This method uses the given calendar to construct an appropriate millisecond
* value for the timestamp if the underlying database does not store
* timezone information.
*
* @param columnName the SQL name of the column
* @param cal the java.util.Calendar
object
* to use in constructing the date
* @return the column value as a java.sql.Timestamp
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.2
*/
java.sql.Timestamp getTimestamp(String columnName, Calendar cal)
throws SQLException;
//-------------------------- JDBC 3.0 ----------------------------------------
/**
* The constant indicating that ResultSet
objects should not
* be closed when the method Connection.commit
is called.
*
* @since 1.4
*/
int HOLD_CURSORS_OVER_COMMIT = 1;
/**
* The constant indicating that ResultSet
objects should be
* closed when the method Connection.commit
is called.
*
* @since 1.4
*/
int CLOSE_CURSORS_AT_COMMIT = 2;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.net.URL
* object in the Java programming language.
*
* @param columnIndex the index of the column 1 is the first, 2 is the second,...
* @return the column value as a java.net.URL
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs,
* or if a URL is malformed
* @since 1.4
*/
java.net.URL getURL(int columnIndex) throws SQLException;
/**
* Retrieves the value of the designated column in the current row
* of this ResultSet
object as a java.net.URL
* object in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value as a java.net.URL
object;
* if the value is SQL NULL
,
* the value returned is null
in the Java programming language
* @exception SQLException if a database access error occurs
* or if a URL is malformed
* @since 1.4
*/
java.net.URL getURL(String columnName) throws SQLException;
/**
* Updates the designated column with a java.sql.Ref
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateRef(int columnIndex, java.sql.Ref x) throws SQLException;
/**
* Updates the designated column with a java.sql.Ref
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateRef(String columnName, java.sql.Ref x) throws SQLException;
/**
* Updates the designated column with a java.sql.Blob
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateBlob(int columnIndex, java.sql.Blob x) throws SQLException;
/**
* Updates the designated column with a java.sql.Blob
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateBlob(String columnName, java.sql.Blob x) throws SQLException;
/**
* Updates the designated column with a java.sql.Clob
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateClob(int columnIndex, java.sql.Clob x) throws SQLException;
/**
* Updates the designated column with a java.sql.Clob
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateClob(String columnName, java.sql.Clob x) throws SQLException;
/**
* Updates the designated column with a java.sql.Array
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateArray(int columnIndex, java.sql.Array x) throws SQLException;
/**
* Updates the designated column with a java.sql.Array
value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
* update the underlying database; instead the updateRow
or
* insertRow
methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs
* @since 1.4
*/
void updateArray(String columnName, java.sql.Array x) throws SQLException;
}