- /*
- * @(#)ResultSet.java 1.20 01/11/29
- *
- * Copyright 2002 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;
-
- /**
- * <P>A ResultSet provides access to a table of data. A ResultSet
- * object is usually generated by executing a Statement.
- *
- * <P>A ResultSet 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.
- *
- * <P>The getXXX methods retrieve column values for the current
- * row. You can retrieve values 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.
- *
- * <P>For maximum portability, ResultSet columns within each row should be
- * read in left-to-right order and each column should be read only once.
- *
- * <P>For the getXXX methods, the JDBC driver attempts to convert the
- * underlying data to the specified Java type and returns a suitable
- * Java value. See the JDBC specification for allowable mappings
- * from SQL types to Java types with the ResultSet.getXXX methods.
- *
- * <P>Column names used as input to getXXX methods are case
- * insensitive. When performing a getXXX using a column name, if
- * several columns have the same name, then 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. 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.
- *
- * <P>A ResultSet is automatically closed by the Statement that
- * generated it when that Statement is closed, re-executed, or used
- * to retrieve the next result from a sequence of multiple results.
- *
- * <P>The number, types and properties of a ResultSet's columns are
- * provided by the ResulSetMetaData object returned by the 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 next makes the first row the current row; the
- * second call makes the second row the current row, and so on.
- *
- * <P>If an input stream is open for the current row, a call
- * to the method <code>next</code> will
- * implicitly close it. The ResultSet'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 <code>ResultSet</code> object's database and
- * JDBC resources immediately instead of waiting for
- * this to happen when it is automatically closed.
- *
- * <P><B>Note:</B> A ResultSet is automatically closed by the
- * Statement that generated it when that Statement is closed,
- * re-executed, or is used to retrieve the next result from a
- * sequence of multiple results. A ResultSet 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 getXXX on a column to try to read
- * its value and then call wasNull() to see if the value read was
- * SQL NULL.
- *
- * @return true if last column 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
- //======================================================================
-
- /**
- * Gets the value of a column in the current row as a Java String.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- String getString(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java boolean.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is false
- * @exception SQLException if a database access error occurs
- */
- boolean getBoolean(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java byte.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- byte getByte(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java short.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- short getShort(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java int.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- int getInt(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java long.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- long getLong(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java float.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- float getFloat(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java double.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- double getDouble(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.math.BigDecimal object.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @param scale the number of digits to the right of the decimal
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- * @deprecated
- */
- BigDecimal getBigDecimal(int columnIndex, int scale) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java byte array.
- * 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 result is null
- * @exception SQLException if a database access error occurs
- */
- byte[] getBytes(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Date object.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Date getDate(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Time object.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Time getTime(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Timestamp object.
- *
- * @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Timestamp getTimestamp(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row 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.
- *
- * <P><B>Note:</B> All the data in the returned stream must be
- * read prior to getting the value of any other column. The next
- * call to a get method implicitly closes the stream. Also, a
- * stream may return 0 when the method <code>available</code>
- * 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
- * then the result is null.
- * @exception SQLException if a database access error occurs
- */
- java.io.InputStream getAsciiStream(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a stream of
- * Unicode 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 Unicode.
- * The byte format of the Unicode stream must Java UTF-8,
- * as specified in the Java Virtual Machine Specification.
- *
- * <P><B>Note:</B> All the data in the returned stream must be
- * read prior to getting the value of any other column. The next
- * call to a get method implicitly closes the stream. Also, a
- * stream may return 0 when the method <code>available</code>
- * 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
- * then the result is null.
- * @exception SQLException if a database access error occurs
- * @deprecated
- */
- java.io.InputStream getUnicodeStream(int columnIndex) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a 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.
- *
- * <P><B>Note:</B> All the data in the returned stream must be
- * read prior to getting the value of any other column. The next
- * call to a get method implicitly closes the stream. Also, a
- * stream may return 0 when the method <code>available</code>
- * 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
- * then the result 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
- //======================================================================
-
- /**
- * Gets the value of a column in the current row as a Java String.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- String getString(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java boolean.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is false
- * @exception SQLException if a database access error occurs
- */
- boolean getBoolean(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java byte.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- byte getByte(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java short.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- short getShort(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java int.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- int getInt(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java long.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- long getLong(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java float.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- float getFloat(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java double.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is 0
- * @exception SQLException if a database access error occurs
- */
- double getDouble(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.math.BigDecimal
- * object.
- *
- * @param columnName the SQL name of the column
- * @param scale the number of digits to the right of the decimal
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- * @deprecated
- */
- BigDecimal getBigDecimal(String columnName, int scale) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a Java byte array.
- * 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 result is null
- * @exception SQLException if a database access error occurs
- */
- byte[] getBytes(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Date object.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Date getDate(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Time object.
- *
- * @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Time getTime(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row 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 result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Timestamp getTimestamp(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row 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.
- *
- * <P><B>Note:</B> All the data in the returned stream must be
- * read prior to getting the value of any other column. The next
- * call to a get method implicitly closes the stream. Also, a
- * stream may return 0 when the method <code>available</code>
- * 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
- * then the result is null.
- * @exception SQLException if a database access error occurs
- */
- java.io.InputStream getAsciiStream(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a stream of
- * Unicode 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 Unicode.
- * The byte format of the Unicode stream must be Java UTF-8,
- * as defined in the Java Virtual Machine Specification.
- *
- * <P><B>Note:</B> All the data in the returned stream must be
- * read prior to getting the value of any other column. The next
- * call to a get method implicitly closes the stream. Also, a
- * stream may return 0 when the method <code>available</code>
- * 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
- * then the result is null.
- * @exception SQLException if a database access error occurs
- * @deprecated
- */
- java.io.InputStream getUnicodeStream(String columnName) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a 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. The JDBC driver will
- * do any necessary conversion from the database format into uninterpreted
- * bytes.
- *
- * <P><B>Note:</B> All the data in the returned stream must be
- * read prior to getting the value of any other column. The next
- * call to a get method implicitly closes the stream. Also, a
- * stream may return 0 when the method <code>available</code>
- * 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
- * then the result is null.
- * @exception SQLException if a database access error occurs
- */
- java.io.InputStream getBinaryStream(String columnName)
- throws SQLException;
-
-
- //=====================================================================
- // Advanced features:
- //=====================================================================
-
- /**
- * <p>The first warning reported by calls on this ResultSet is
- * returned. Subsequent ResultSet warnings will be chained to this
- * SQLWarning.
- *
- * <P>The warning chain is automatically cleared each time a new
- * row is read.
- *
- * <P><B>Note:</B> 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 or null
- * @exception SQLException if a database access error occurs
- */
- SQLWarning getWarnings() throws SQLException;
-
- /**
- * After this call getWarnings returns null until a new warning is
- * reported for this ResultSet.
- *
- * @exception SQLException if a database access error occurs
- */
- void clearWarnings() throws SQLException;
-
- /**
- * Gets the name of the SQL cursor used by this ResultSet.
- *
- * <P>In SQL, a result table is retrieved through a cursor that is
- * named. The current row of a result 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 the 'for update' clause is
- * omitted the positioned updates may fail.
- *
- * <P>JDBC supports this SQL feature by providing the name of the
- * SQL cursor used by a ResultSet. The current row of a ResultSet
- * is also the current row of this SQL cursor.
- *
- * <P><B>Note:</B> If positioned update is not supported a
- * SQLException is thrown
- *
- * @return the ResultSet's SQL cursor name
- * @exception SQLException if a database access error occurs
- */
- String getCursorName() throws SQLException;
-
- /**
- * Retrieves the number, types and properties of a ResultSet's columns.
- *
- * @return the description of a ResultSet's columns
- * @exception SQLException if a database access error occurs
- */
- ResultSetMetaData getMetaData() throws SQLException;
-
- /**
- * <p>Gets the value of a column in the current row as a Java object.
- *
- * <p>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
- * spec.
- *
- * <p>This method may also be used to read datatabase-specific
- * abstract data types.
- *
- * JDBC 2.0
- *
- *
- * In the JDBC 2.0 API, the behavior of method
- * <code>getObject</code> is extended to materialize
- * data of SQL user-defined types. When the 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;
-
- /**
- * <p>Gets the value of a column in the current row as a Java object.
- *
- * <p>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
- * spec.
- *
- * <p>This method may also be used to read datatabase-specific
- * abstract data types.
- *
- * JDBC 2.0
- *
- * In the JDBC 2.0 API, the behavior of method
- * <code>getObject</code> is extended to materialize
- * data of SQL user-defined types. When the 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
- * @exception SQLException if a database access error occurs
- */
- int findColumn(String columnName) throws SQLException;
-
-
- //--------------------------JDBC 2.0-----------------------------------
-
- //---------------------------------------------------------------------
- // Getter's and Setter's
- //---------------------------------------------------------------------
-
- /**
- * JDBC 2.0
- *
- * <p>Gets the value of a column in the current row as a java.io.Reader.
- * @param columnIndex the first column is 1, the second is 2, ...
- */
- java.io.Reader getCharacterStream(int columnIndex) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Gets the value of a column in the current row as a java.io.Reader.
- * @param columnName the name of the column
- * @return the value in the specified column as a <code>java.io.Reader</code>
- */
- java.io.Reader getCharacterStream(String columnName) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets the value of a column in the current row as a java.math.BigDecimal
- * object 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 result is null
- * @exception SQLException if a database access error occurs
- */
- BigDecimal getBigDecimal(int columnIndex) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets the value of a column in the current row as a java.math.BigDecimal
- * object with full precision.
- * @param columnName the column name
- * @return the column value (full precision); if the value is SQL NULL,
- * the result is null
- * @exception SQLException if a database access error occurs
- *
- */
- BigDecimal getBigDecimal(String columnName) throws SQLException;
-
- //---------------------------------------------------------------------
- // Traversal/Positioning
- //---------------------------------------------------------------------
-
- /**
- * JDBC 2.0
- *
- * <p>Indicates whether the cursor is before the first row in the result
- * set.
- *
- * @return true if the cursor is before the first row, false otherwise. Returns
- * false when the result set contains no rows.
- * @exception SQLException if a database access error occurs
- */
- boolean isBeforeFirst() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Indicates whether the cursor is after the last row in the result
- * set.
- *
- * @return true if the cursor is after the last row, false otherwise. Returns
- * false when the result set contains no rows.
- * @exception SQLException if a database access error occurs
- */
- boolean isAfterLast() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Indicates whether the cursor is on the first row of the result set.
- *
- * @return true if the cursor is on the first row, false otherwise.
- * @exception SQLException if a database access error occurs
- */
- boolean isFirst() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Indicates whether the cursor is on the last row of the result set.
- * Note: Calling the method <code>isLast</code> 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
- */
- boolean isLast() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Moves the cursor to the front of the result set, just before the
- * first row. 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
- */
- void beforeFirst() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Moves the cursor to the end of the result set, just after the last
- * row. 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
- */
- void afterLast() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Moves the cursor to the first row in the result set.
- *
- * @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
- */
- boolean first() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Moves the cursor to the last row in the result set.
- *
- * @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.
- */
- boolean last() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>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
- */
- int getRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Moves the cursor to the given row number in the result set.
- *
- * <p>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.
- *
- * <p>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
- * <code>absolute(-1)</code> positions the
- * cursor on the last row, <code>absolute(-2)</code> indicates the next-to-last
- * row, and so on.
- *
- * <p>An attempt to position the cursor beyond the first/last row in
- * the result set leaves the cursor before/after the first/last
- * row, respectively.
- *
- * <p>Note: Calling <code>absolute(1)</code> is the same
- * as calling <code>first()</code>.
- * Calling <code>absolute(-1)</code> is the same as calling <code>last()</code>.
- *
- * @return true if the cursor is on the result set; false otherwise
- * @exception SQLException if a database access error occurs or
- * row is 0, or result set type is TYPE_FORWARD_ONLY.
- */
- boolean absolute( int row ) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>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 <code>relative(0)</code> is valid, but does
- * not change the cursor position.
- *
- * <p>Note: Calling <code>relative(1)</code>
- * is different from calling <code>next()</code>
- * because is makes sense to call <code>next()</code> when there is no current row,
- * for example, when the cursor is positioned before the first row
- * or after the last row of the result set.
- *
- * @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
- */
- boolean relative( int rows ) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * <p>Moves the cursor to the previous row in the result set.
- *
- * <p>Note: <code>previous()</code> is not the same as
- * <code>relative(-1)</code> because it
- * makes sense to call</code>previous()</code> when there is no current row.
- *
- * @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
- */
- boolean previous() throws SQLException;
-
- //---------------------------------------------------------------------
- // Properties
- //---------------------------------------------------------------------
-
- /**
- * JDBC 2.0
- *
- * The rows in a result set will be processed in a forward direction;
- * first-to-last.
- */
- int FETCH_FORWARD = 1000;
-
- /**
- * JDBC 2.0
- *
- * The rows in a result set will be processed in a reverse direction;
- * last-to-first.
- */
- int FETCH_REVERSE = 1001;
-
- /**
- * JDBC 2.0
- *
- * The order in which rows in a result set will be processed is unknown.
- */
- int FETCH_UNKNOWN = 1002;
-
- /**
- * JDBC 2.0
- *
- * Gives a hint as to the direction in which the rows in this result set
- * will be processed. The initial value is determined by the statement
- * that produced the result set. The fetch direction may be changed
- * at any time.
- *
- * @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.
- */
- void setFetchDirection(int direction) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Returns the fetch direction for this result set.
- *
- * @return the current fetch direction for this result set
- * @exception SQLException if a database access error occurs
- */
- int getFetchDirection() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * 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 result
- * set. 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
- * 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 <= this.getMaxRows() is not satisfied.
- */
- void setFetchSize(int rows) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Returns the fetch size for this result set.
- *
- * @return the current fetch size for this result set
- * @exception SQLException if a database access error occurs
- */
- int getFetchSize() throws SQLException;
-
- /**
- * JDBC 2.0
- * The type for a <code>ResultSet</code> object whose cursor may
- * move only forward.
- */
- int TYPE_FORWARD_ONLY = 1003;
-
- /**
- * JDBC 2.0
- * The type for a <code>ResultSet</code> object that is scrollable
- * but generally not sensitive to changes made by others.
- *
- */
- int TYPE_SCROLL_INSENSITIVE = 1004;
-
- /**
- * JDBC 2.0
- * The type for a <code>ResultSet</code> object that is scrollable
- * and generally sensitive to changes made by others.
- */
- int TYPE_SCROLL_SENSITIVE = 1005;
-
- /**
- * JDBC 2.0
- *
- * Returns the type of this result set. The type is determined by
- * the statement that created the result set.
- *
- * @return TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, or
- * TYPE_SCROLL_SENSITIVE
- * @exception SQLException if a database access error occurs
- */
- int getType() throws SQLException;
-
- /**
- * JDBC 2.0
- * The concurrency mode for a <code>ResultSet</code> object
- * that may NOT be updated.
- *
- */
- int CONCUR_READ_ONLY = 1007;
-
- /**
- * JDBC 2.0
- * The concurrency mode for a <code>ResultSet</code> object
- * that may be updated.
- *
- */
- int CONCUR_UPDATABLE = 1008;
-
- /**
- * JDBC 2.0
- *
- * Returns the concurrency mode of this result set. The concurrency
- * used is determined by the statement that created the result set.
- *
- * @return the concurrency type, CONCUR_READ_ONLY or CONCUR_UPDATABLE
- * @exception SQLException if a database access error occurs
- */
- int getConcurrency() throws SQLException;
-
- //---------------------------------------------------------------------
- // Updates
- //---------------------------------------------------------------------
-
- /**
- * JDBC 2.0
- *
- * Indicates whether the current row has been updated. The value returned
- * depends on whether or not the result set can detect updates.
- *
- * @return true if the row has been visibly updated by the owner or
- * another, and updates are detected
- * @exception SQLException if a database access error occurs
- *
- * @see DatabaseMetaData#updatesAreDetected
- */
- boolean rowUpdated() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Indicates whether the current row has had an insertion. The value returned
- * depends on whether or not the result set can detect visible inserts.
- *
- * @return true if a row has had an insertion and insertions are detected
- * @exception SQLException if a database access error occurs
- *
- * @see DatabaseMetaData#insertsAreDetected
- */
- boolean rowInserted() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Indicates 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 the result set can detect deletions.
- *
- * @return true if a row was deleted and deletions are detected
- * @exception SQLException if a database access error occurs
- *
- * @see DatabaseMetaData#deletesAreDetected
- */
- boolean rowDeleted() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Give a nullable column a null value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateNull(int columnIndex) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a boolean value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBoolean(int columnIndex, boolean x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a byte value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateByte(int columnIndex, byte x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a short value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateShort(int columnIndex, short x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an integer value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateInt(int columnIndex, int x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a long value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateLong(int columnIndex, long x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a float value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateFloat(int columnIndex, float x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Double value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateDouble(int columnIndex, double x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a BigDecimal value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBigDecimal(int columnIndex, BigDecimal x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a String value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateString(int columnIndex, String x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a byte array value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBytes(int columnIndex, byte x[]) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Date value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateDate(int columnIndex, java.sql.Date x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Time value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateTime(int columnIndex, java.sql.Time x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Timestamp value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateTimestamp(int columnIndex, java.sql.Timestamp x)
- throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an ascii stream value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateAsciiStream(int columnIndex,
- java.io.InputStream x,
- int length) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a binary stream value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBinaryStream(int columnIndex,
- java.io.InputStream x,
- int length) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a character stream value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateCharacterStream(int columnIndex,
- java.io.Reader x,
- int length) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an Object value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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.DECIMAL or java.sql.Types.NUMERIC types
- * this is the number of digits after the decimal. For all other
- * types this value will be ignored.
- * @exception SQLException if a database access error occurs
- */
- void updateObject(int columnIndex, Object x, int scale)
- throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an Object value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateObject(int columnIndex, Object x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a null value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * methods are called to update the database.
- *
- * @param columnName the name of the column
- * @exception SQLException if a database access error occurs
- */
- void updateNull(String columnName) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a boolean value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBoolean(String columnName, boolean x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a byte value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateByte(String columnName, byte x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a short value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateShort(String columnName, short x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an integer value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateInt(String columnName, int x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a long value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateLong(String columnName, long x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a float value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateFloat(String columnName, float x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a double value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateDouble(String columnName, double x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a BigDecimal value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBigDecimal(String columnName, BigDecimal x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a String value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateString(String columnName, String x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a byte array value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateBytes(String columnName, byte x[]) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Date value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateDate(String columnName, java.sql.Date x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Time value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateTime(String columnName, java.sql.Time x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a Timestamp value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateTimestamp(String columnName, java.sql.Timestamp x)
- throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an ascii stream value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * methods are called to update the database.
- *
- * @param columnName the name of the column
- * @param x the new column value
- * @param length of the stream
- * @exception SQLException if a database access error occurs
- */
- void updateAsciiStream(String columnName,
- java.io.InputStream x,
- int length) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a binary stream value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * methods are called to update the database.
- *
- * @param columnName the name of the column
- * @param x the new column value
- * @param length of the stream
- * @exception SQLException if a database access error occurs
- */
- void updateBinaryStream(String columnName,
- java.io.InputStream x,
- int length) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with a character stream value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * methods are called to update the database.
- *
- * @param columnName the name of the column
- * @param x the new column value
- * @param length of the stream
- * @exception SQLException if a database access error occurs
- */
- void updateCharacterStream(String columnName,
- java.io.Reader reader,
- int length) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an Object value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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. For all other
- * types this value will be ignored.
- * @exception SQLException if a database access error occurs
- */
- void updateObject(String columnName, Object x, int scale)
- throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates a column with an Object value.
- *
- * The <code>updateXXX</code> methods are used to update column values in the
- * current row, or the insert row. The <code>updateXXX</code> methods do not
- * update the underlying database; instead the <code>updateRow</code> or <code>insertRow</code>
- * 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
- */
- void updateObject(String columnName, Object x) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Inserts the contents of the insert row into the result set and
- * the database. Must be on the insert row when this method is called.
- *
- * @exception SQLException if a database access error occurs,
- * if called when not on the insert row, or if not all of non-nullable columns in
- * the insert row have been given a value
- */
- void insertRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Updates the underlying database with the new contents of the
- * current row. Cannot be called when on the insert row.
- *
- * @exception SQLException if a database access error occurs or
- * if called when on the insert row
- */
- void updateRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Deletes the current row from the result set and the underlying
- * database. Cannot be called when on the insert row.
- *
- * @exception SQLException if a database access error occurs or if
- * called when on the insert row.
- */
- void deleteRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Refreshes the current row with its most recent value in
- * the database. Cannot be called when on the insert row.
- *
- * The <code>refreshRow</code> 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 <code>refreshRow</code> 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 <code>refreshRow</code> is called after
- * calling <code>updateXXX</code>, but before calling <code>updateRow</code>, then the
- * updates made to the row are lost. Calling the method <code>refreshRow</code> frequently
- * will likely slow performance.
- *
- * @exception SQLException if a database access error occurs or if
- * called when on the insert row
- */
- void refreshRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Cancels the updates made to a row.
- * This method may be called after calling an
- * <code>updateXXX</code> method(s) and before calling <code>updateRow</code> to rollback
- * the updates made to a row. If no updates have been made or
- * <code>updateRow</code> has already been called, then this method has no
- * effect.
- *
- * @exception SQLException if a database access error occurs or if
- * called when on the insert row
- *
- */
- void cancelRowUpdates() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * 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 <code>updateXXX</code> methods prior to
- * inserting the row into the result set.
- *
- * Only the <code>updateXXX</code>, <code>getXXX</code>,
- * and <code>insertRow</code> 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 <code>insertRow</code>.
- * The method <code>updateXXX</code> must be called before a
- * <code>getXXX</code> method can be called on a column value.
- *
- * @exception SQLException if a database access error occurs
- * or the result set is not updatable
- */
- void moveToInsertRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * 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
- */
- void moveToCurrentRow() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Returns the Statement that produced this <code>ResultSet</code> object.
- * If the result set was generated some other way, such as by a
- * <code>DatabaseMetaData</code> method, this method returns <code>null</code>.
- *
- * @return the Statment that produced the result set or
- * null if the result set was produced some other way
- * @exception SQLException if a database access error occurs
- */
- Statement getStatement() throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Returns the value of a column in the current row as a Java object.
- * This method uses the given <code>Map</code> 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 the mapping from SQL type names to Java classes
- * @return an object representing the SQL value
- */
- Object getObject(int i, java.util.Map map) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets a REF(<structured-type>) column value from the current row.
- *
- * @param i the first column is 1, the second is 2, ...
- * @return a <code>Ref</code> object representing an SQL REF value
- */
- Ref getRef(int i) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets a BLOB value in the current row of this <code>ResultSet</code> object.
- *
- * @param i the first column is 1, the second is 2, ...
- * @return a <code>Blob</code> object representing the SQL BLOB value in
- * the specified column
- */
- Blob getBlob(int i) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets a CLOB value in the current row of this <code>ResultSet</code> object.
- *
- * @param i the first column is 1, the second is 2, ...
- * @return a <code>Clob</code> object representing the SQL CLOB value in
- * the specified column
- */
- Clob getClob(int i) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets an SQL ARRAY value from the current row of this <code>ResultSet</code> object.
- *
- * @param i the first column is 1, the second is 2, ...
- * @return an <code>Array</code> object representing the SQL ARRAY value in
- * the specified column
- */
- Array getArray(int i) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Returns the value in the specified column as a Java object.
- * This method uses the specified <code>Map</code> object for
- * custom mapping if appropriate.
- *
- * @param colName the name of the column from which to retrieve the value
- * @param map the mapping from SQL type names to Java classes
- * @return an object representing the SQL value in the specified column
- */
- Object getObject(String colName, java.util.Map map) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets a REF(<structured-type>) column value from the current row.
- *
- * @param colName the column name
- * @return a <code>Ref</code> object representing the SQL REF value in
- * the specified column
- */
- Ref getRef(String colName) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets a BLOB value in the current row of this <code>ResultSet</code> object.
- *
- * @param colName the name of the column from which to retrieve the value
- * @return a <code>Blob</code> object representing the SQL BLOB value in
- * the specified column
- */
- Blob getBlob(String colName) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets a CLOB value in the current row of this <code>ResultSet</code> object.
- *
- * @param colName the name of the column from which to retrieve the value
- * @return a <code>Clob</code> object representing the SQL CLOB value in
- * the specified column
- */
- Clob getClob(String colName) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets an SQL ARRAY value in the current row of this <code>ResultSet</code> object.
- *
- * @param colName the name of the column from which to retrieve the value
- * @return an <code>Array</code> object representing the SQL ARRAY value in
- * the specified column
- */
- Array getArray(String colName) throws SQLException;
-
- /**
- * JDBC 2.0
- *
- * Gets the value of a column in the current row as a java.sql.Date
- * object. 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 calendar to use in constructing the date
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Date getDate(int columnIndex, Calendar cal) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Date
- * object. 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 calendar to use in constructing the date
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Date getDate(String columnName, Calendar cal) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Time
- * object. 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 calendar to use in constructing the time
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Time getTime(int columnIndex, Calendar cal) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Time
- * object. 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 calendar to use in constructing the time
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Time getTime(String columnName, Calendar cal) throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Timestamp
- * object. 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 calendar to use in constructing the timestamp
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Timestamp getTimestamp(int columnIndex, Calendar cal)
- throws SQLException;
-
- /**
- * Gets the value of a column in the current row as a java.sql.Timestamp
- * object. 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 calendar to use in constructing the timestamp
- * @return the column value; if the value is SQL NULL, the result is null
- * @exception SQLException if a database access error occurs
- */
- java.sql.Timestamp getTimestamp(String columnName, Calendar cal)
- throws SQLException;
- }
-
-
-
-
-
-
-
-
-
-