/* Copyrights and Licenses
*
* This product includes Hypersonic SQL.
* Originally developed by Thomas Mueller and the Hypersonic SQL Group.
*
* Copyright (c) 1995-2000 by the Hypersonic SQL Group. All rights reserved.
* Redistribution and use in source and binary forms, with or without modification, are permitted
* provided that the following conditions are met:
* - Redistributions of source code must retain the above copyright notice, this list of conditions
* and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
* - All advertising materials mentioning features or use of this software must display the
* following acknowledgment: "This product includes Hypersonic SQL."
* - Products derived from this software may not be called "Hypersonic SQL" nor may
* "Hypersonic SQL" appear in their names without prior written permission of the
* Hypersonic SQL Group.
* - Redistributions of any form whatsoever must retain the following acknowledgment: "This
* product includes Hypersonic SQL."
* This software is provided "as is" and any expressed or implied warranties, including, but
* not limited to, the implied warranties of merchantability and fitness for a particular purpose are
* disclaimed. In no event shall the Hypersonic SQL Group or its contributors be liable for any
* direct, indirect, incidental, special, exemplary, or consequential damages (including, but
* not limited to, procurement of substitute goods or services; loss of use, data, or profits;
* or business interruption). However caused any on any theory of liability, whether in contract,
* strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this
* software, even if advised of the possibility of such damage.
* This software consists of voluntary contributions made by many individuals on behalf of the
* Hypersonic SQL Group.
*
*
* For work added by the HSQL Development Group:
*
* Copyright (c) 2001-2004, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer, including earlier
* license statements (above) and comply with all above license conditions.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution, including earlier
* license statements (above) and comply with all above license conditions.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.jdbc;
import java.io.ByteArrayInputStream;
import java.io.StringReader;
import java.math.BigDecimal;
import java.sql.*; // for Array, Blob, Clob, Ref (jdk 1.1)
import java.util.*; // for Map (jdk 1.1)
import org.hsqldb.Binary;
import org.hsqldb.Column;
import org.hsqldb.HsqlDateTime;
import org.hsqldb.HsqlException;
import org.hsqldb.HsqlProperties;
import org.hsqldb.JavaObject;
import org.hsqldb.Record;
import org.hsqldb.Result;
import org.hsqldb.ResultConstants;
import org.hsqldb.Trace;
import org.hsqldb.Types;
import org.hsqldb.lib.AsciiStringInputStream;
import org.hsqldb.lib.StringInputStream;
// fredt@users 20020320 - patch 1.7.0 - JDBC 2 support and error trapping
// JDBC 2 methods can now be called from jdk 1.1.x - see javadoc comments
// SCROLL_INSENSITIVE and FORWARD_ONLY types for ResultSet are now supported
// fredt@users 20020315 - patch 497714 by lakuhns@users - scrollable ResultSet
// all absolute and relative positioning methods defined
// boucherb@users 20020409 - added "throws SQLException" to all methods where
// it was missing here but specified in the java.sql.ResultSet and
// java.sql.ResultSetMetaData interfaces, updated generic documentation to
// JDK 1.4, and added JDBC3 methods and docs
// boucherb@users and fredt@users 20020505 extensive review and update
// of docs and behaviour to comply with java.sql specification
// tony_lai@users 20020820 - patch 595073 - duplicated exception msg
// fredt@users 20030622 - patch 1.7.2 - columns and labels are case sensitive
// boucherb@users 200404xx - javadoc updates
/**
*
* 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 (JavaTM 2 SDK,
* Standard Edition, version 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:
*
* - to update a column value in the current row. In a scrollable
*
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 be AINSWORTH
* rs.updateRow(); // updates the row in the data source
*
*
* - to insert column values into the insert row. An updatable
*
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 be 35
* rs.updateBoolean(3, true); // updates the third row to true
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* A ResultSet object generated by HSQLDB is by default of
* ResultSet.TYPE_FORWARD_ONLY (as is standard JDBC behavior)
* and does not allow the use of absolute and relative positioning
* methods. However, since 1.7.0, if a statement is created
* with:
*
*
* Statement stmt = conn.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);
*
*
* then the
ResultSet objects it produces support
* using all of the absolute and relative positioning methods of JDBC2
* to set the position of the current row, for example:
*
*
* rs.absolute(5);
* String fifthRowValue = rs.getString(1);
* rs.relative(4);
* String ninthRowValue = rs.getString(1);
*
*
* Note: An HSQLDB
ResultSet object persists, even after its
* connection is closed. This is regardless of the operational mode of
* the {@link Database Database} from which it came. That is, they
* persist whether originating from a
Server,
*
WebServer or in-process mode
Database.
*
*
* Including HSQLDB 1.7.2, there is no support for any of the methods
* introduced in JDBC 2 relating to updateable result sets. These methods
* include all updateXXX methods, as well as the {@link #insertRow},
* {@link #updateRow}, {@link #deleteRow}, {@link #moveToInsertRow} (and so on)
* methods; invoking any such method throws an SQLException
* stating that the operation is not supported.
*
* JRE 1.1.x Notes:
*
* In general, JDBC 2 support requires Java 1.2 and above, and JDBC 3 requires
* Java 1.4 and above. In HSQLDB, support for methods introduced in different
* versions of JDBC depends on the JDK version used for compiling and building
* HSQLDB.
*
* Since 1.7.0, it is possible to build the product so that
* all JDBC 2 methods can be called while executing under the version 1.1.x
* Java Runtime EnvironmentTM.
* However, some of these method calls require int values that
* are defined only in the JDBC 2 or greater version of the
*
* ResultSet interface. For this reason, when the
* product is compiled under JDK 1.1.x, these values are defined here, in this
* class.
*
* In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the
* JDBC2-only ResultSet values can be achieved by referring
* to them in parameter specifications and return value comparisons,
* respectively, as follows:
*
*
* jdbcResultSet.FETCH_FORWARD
* jdbcResultSet.TYPE_FORWARD_ONLY
* jdbcResultSet.TYPE_SCROLL_INSENSITIVE
* jdbcResultSet.CONCUR_READ_ONLY
* // etc.
*
*
* However, please note that code written in such a manner will not be
* compatible for use with other JDBC 2 drivers, since they expect and use
*
ResultSet, rather than
jdbcResultSet. Also
* note, this feature is offered solely as a convenience to developers
* who must work under JDK 1.1.x due to operating constraints, yet wish to
* use some of the more advanced features available under the JDBC 2
* specification.
*
* (fredt@users)
* (boucherb@users)
*
*
ResultSetMetaData
*/
public class jdbcResultSet implements ResultSet {
// fredt@users 20020320 - patch 497714 by lakuhns@users - scrollable ResultSet
// variable values in different states
// Condition definitions
// bInit iCurrentRow nCurrent nCurrent.next
// ----- ----------- -------- -------------
// beforeFirst false 0 N/A N/A
// first true 1 !null next or null
// last true last row # !null null
// afterLast true last row + 1 N/A N/A
//------------------------ Private Attributes --------------------------
/*
* Campbell's comments
* Future Development Information for Developers and Contributors
* Providing a
* full and robust implementation guaranteeing consistently accurate
* results and behaviour depends upon introducing several new engine
* features for which the internals of the product currently have no
* infrastructure:
*
*
* - a unique rowid for each row in the database which lasts the life
* of a row, independent of any updates made to that row
* - the ability to explicitly lock either the tables or the
* individual rows of an updateable result, for the duration that
* the result is open
* - the ability to choose between transactions supporting repeatable
* reads, committed reads, and uncommitted reads
*
- the ability to map an updated result row's columns back to
* specific updateable objects on the database.
*
* Note: Typically, it is easy to do this mapping if all the
* rows of a result consist of columns from a single table. And it
* is especially easy if the result's columns are a superset of the
* primary key columns of that table. The ability to
* update a result consisting of any combintation of join, union,
* intersect, difference and grouping operations, however, is much more
* complex to implement and often impossible, especially under
* grouping and non-natural joins. Also, it is not even guaranteed
* that the columns of a result map back to *any* updateable object
* on the database, for instance in the cases where the
* result's column values are general expressions or the result
* comes from a stored procedure where the data may not even come,
* directly or indirectly, from updateable database objects such as
* columns in table rows.
*
*
* For developers working under a JDBC3 environment,
* it is gently recommended to take a look at Sun's early access
*
* RowSet implementation, as this can be used to add
* JDBC driver independent scrollablility and updateability.
* However, as a driver independent implementation, it obviously cannot
* guarantee to use the traditional table and/or row locking features
* that many DBMS make available to ensure the success of all
* valid updates against updateable results sets. As such, performing
* updates through Sun's early access RowSet implementation
* may not always succeed, even when it is generally expected that they
* should. This is because the condition used to find the original row
* on the database to update (which, for a driver independent
* implementation, would have to be equality on all columns values of
* the originally retrieved row) can become invalid if another
* transaction modifies or deletes that row on the database at some
* point between the time the row was last retrieved or refreshed in
* the RowSet and the time the RowSet attempts to make its next
* update to that row. Also, any driver independent implementation
* of RowSet is still dependent on each driver guaranteeing that its
* ResultSet objects return completely accurate
* ResultSetMetaData that fulfills all of the
* JDBC ResultSetMetaData contracts under all circumstances.
* However, up to and including 1.7.0, HSQLDB does not make such guarantees
* under all conditions. See the discussion at {@link #getMetaData}.
* (boucherb@users) (version 1.7.0)
*/
// boucherb@users/hiep256@users 20010829 - patch 1.7.2 - allow expression to
// return Results as Object, where object is Result or jdbcResultSet.
// - rResult access changed to allow getting internal result object
// from Parser.processCall()
/** The internal representation. */
public Result rResult;
/**
* The current record containing the data for the row
*/
private Record nCurrent;
/** The row upon which this ResultSet is currently positioned. */
private int iCurrentRow;
/** When the result of updating the database, the number of updated rows. */
private int iUpdateCount;
/** Is current row before the first row? */
private boolean bInit; // false if before first row
/** How many columns does this ResultSet have? */
int iColumnCount;
/** Did the last getXXX method encounter a null value? */
private boolean bWasNull;
/** The ResultSetMetaData object for this ResultSet */
private ResultSetMetaData rsmd;
/** Properties of this ResultSet's parent Connection. */
private HsqlProperties connProperties;
/** is the connection via network */
private boolean isNetConn;
/**
* The Statement that generated this result. Null if the result is
* from DatabaseMetaData
*/
jdbcStatement sqlStatement;
//------------------------ Package Attributes --------------------------
/**
* The scrollability / scroll sensitivity type of this result.
*/
int rsType = TYPE_FORWARD_ONLY;
/**
*
* 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
*/
public boolean next() throws SQLException {
bWasNull = false;
// Have an empty resultset so exit with false
if (rResult == null || rResult.isEmpty()) {
return false;
}
if (!bInit) {
// The resultset has not been traversed, so set the cursor
// to the first row (1)
nCurrent = rResult.rRoot;
bInit = true;
iCurrentRow = 1;
} else {
// The resultset has been traversed, if afterLast, retrun false
if (nCurrent == null) {
return false;
}
// On a valid row so go to next
nCurrent = nCurrent.next;
iCurrentRow++;
}
// finally test to see if we are in an afterLast situation
if (nCurrent == null) {
// Yes, set the current row to after last and exit with false
iCurrentRow = rResult.getSize() + 1;
return false;
} else {
// Not afterLast, so success
return true;
}
}
/**
*
* 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
*/
public void close() throws SQLException {
iUpdateCount = -1;
rResult = null;
}
/**
*
* 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
*/
public boolean wasNull() throws SQLException {
return bWasNull;
}
//======================================================================
// 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
*/
public String getString(int columnIndex) throws SQLException {
return (String) getColumnInType(columnIndex, Types.CHAR);
}
/**
*
* 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
*/
public boolean getBoolean(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.BOOLEAN);
return o == null ? false
: ((Boolean) o).booleanValue();
}
/**
*
* 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
*/
public byte getByte(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.TINYINT);
return o == null ? 0
: ((Number) o).byteValue();
}
/**
*
* 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
*/
public short getShort(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.SMALLINT);
return o == null ? 0
: ((Number) o).shortValue();
}
/**
*
* 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
*/
public int getInt(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.INTEGER);
return o == null ? 0
: ((Number) o).intValue();
}
/**
*
* 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
*/
public long getLong(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.BIGINT);
return o == null ? 0
: ((Number) o).longValue();
}
/**
*
* 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
*/
public float getFloat(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.REAL);
return o == null ? (float) 0.0
: ((Number) o).floatValue();
}
/**
*
* 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
*/
public double getDouble(int columnIndex) throws SQLException {
Object o = getColumnInType(columnIndex, Types.DOUBLE);
return o == null ? 0.0
: ((Number) o).doubleValue();
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Beginning with 1.7.0, HSQLDB converts the result and sets the scale
* with BigDecimal.ROUND_HALF_DOWN.
*
NULL, the
* value returned is null
* @exception SQLException if a database access error occurs
* @deprecated by java.sun.com as of JDK 1.2
*/
public BigDecimal getBigDecimal(int columnIndex,
int scale) throws SQLException {
// boucherb@users 20020502 - added conversion
BigDecimal bd = (BigDecimal) getColumnInType(columnIndex,
Types.DECIMAL);
if (scale < 0) {
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT);
}
if (bd != null) {
bd.setScale(scale, BigDecimal.ROUND_HALF_DOWN);
}
return bd;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* HSQLDB returns correct values for columns of type BINARY,
* CHAR and their variations. For other types, it returns
* the byte[] for the String representation
* of the value.
*
NULL, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
public byte[] getBytes(int columnIndex) throws SQLException {
Object x = getObject(columnIndex);
if (x == null) {
return null;
}
if (x instanceof byte[]) {
return (byte[]) x;
}
if (x instanceof java.lang.String) {
return ((String) x).getBytes();
}
x = getColumnInType(columnIndex, Types.BINARY);
return (byte[]) x;
}
/**
*
* 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
*/
public java.sql.Date getDate(int columnIndex) throws SQLException {
return (java.sql.Date) getColumnInType(columnIndex, Types.DATE);
}
/**
*
* 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
*/
public java.sql.Time getTime(int columnIndex) throws SQLException {
return (Time) getColumnInType(columnIndex, Types.TIME);
}
/**
*
* 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
*/
public java.sql.Timestamp getTimestamp(int columnIndex)
throws SQLException {
return (Timestamp) getColumnInType(columnIndex, Types.TIMESTAMP);
}
/**
*
* 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
* InputStream.available
* is called whether there is data available or not.
*
*
*
*
*
HSQLDB-Specific Information:
*
* The limitation noted above does not apply to HSQLDB.
*
* In 1.6.1 and previous, getAsciiStream was identical to
* getUnicodeStream and both simply returned a byte stream
* constructed from the raw {@link #getBytes(int) getBytes}
* representation.
*
* Starting with 1.7.0, this has been updated to comply with the
* java.sql specification.
*
* When the column is of type CHAR and its variations, it requires no
* conversion since it is represented internally already as a
* Java String object. When the column is not of type CHAR and its
* variations, the returned stream is based on a conversion to the
* Java String representation of the value. In either case,
* the obtained stream is always equivalent to a stream of the low order
* bytes from the value's String representation.
*
* HSQLDB SQL CHAR and its variations are all Unicode strings
* internally, so the recommended alternatives to this method are
* {@link #getString(int) getString},
* {@link #getUnicodeStream(int) getUnicodeStream} (deprecated)
* and new to 1.7.0: {@link #getCharacterStream(int) getCharacterStream}
* (now prefered over the deprecated getUnicodeStream alternative).
*
NULL, the
* value returned is null
* @exception SQLException if a database access error occurs
*/
public java.io.InputStream getAsciiStream(int columnIndex)
throws SQLException {
String s = getString(columnIndex);
if (s == null) {
return null;
}
return new AsciiStringInputStream(s);
}
/**
*
* 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 LONGVARCHARvalues. 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* The limitation noted above does not apply to HSQLDB.
*
* Up to and including 1.6.1, getUnicodeStream (and getAsciiStream)
* both simply returned a byte stream constructed from the
* raw {@link #getBytes(int) getBytes} representation.
*
* Starting with 1.7.0, this has been corrected to comply with the
* java.sql specification.
*
* When the column is of type CHAR and its variations, it requires no
* conversion since it is represented internally already as
* Java Strings. When the column is not of type CHAR and its variations,
* the returned stream is based on a conversion to the
* Java String representation of the value. In either case,
* the obtained stream is always equivalent to a stream of
* bytes from the value's String representation, with high-byte first.
*
NULL, the value returned is
* null
* @exception SQLException if a database access error occurs
* @deprecated use getCharacterStream in place of
* getUnicodeStream
*/
public java.io.InputStream getUnicodeStream(int columnIndex)
throws SQLException {
String s = getString(columnIndex);
if (s == null) {
return null;
}
return new StringInputStream(s);
}
/**
*
* 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
*/
// fredt@users 20020215 - patch 485704 by boucherb@users
public java.io.InputStream getBinaryStream(int columnIndex)
throws SQLException {
byte[] b = getBytes(columnIndex);
return wasNull() ? null
: new ByteArrayInputStream(b);
}
//======================================================================
// 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
*/
public String getString(String columnName) throws SQLException {
return getString(findColumn(columnName));
}
/**
*
* 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
*/
public boolean getBoolean(String columnName) throws SQLException {
return getBoolean(findColumn(columnName));
}
/**
*
* 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
*/
public byte getByte(String columnName) throws SQLException {
return getByte(findColumn(columnName));
}
/**
*
* 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
*/
public short getShort(String columnName) throws SQLException {
return getShort(findColumn(columnName));
}
/**
*
* 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
*/
public int getInt(String columnName) throws SQLException {
return getInt(findColumn(columnName));
}
/**
*
* 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
*/
public long getLong(String columnName) throws SQLException {
return getLong(findColumn(columnName));
}
/**
*
* 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
*/
public float getFloat(String columnName) throws SQLException {
return getFloat(findColumn(columnName));
}
/**
*
* 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
*/
public double getDouble(String columnName) throws SQLException {
return getDouble(findColumn(columnName));
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Beginning with 1.7.0, HSQLDB converts the result and sets the scale
* with BigDecimal.ROUND_HALF_DOWN.
*
NULL, the
* value returned is null
* @exception SQLException if a database access error occurs
* @deprecated by java.sun.com as of JDK 1.2
*/
public BigDecimal getBigDecimal(String columnName,
int scale) throws SQLException {
return getBigDecimal(findColumn(columnName), scale);
}
/**
*
* 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
*/
public byte[] getBytes(String columnName) throws SQLException {
return getBytes(findColumn(columnName));
}
/**
*
* 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
*/
public java.sql.Date getDate(String columnName) throws SQLException {
return getDate(findColumn(columnName));
}
/**
*
* 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
*/
public java.sql.Time getTime(String columnName) throws SQLException {
return getTime(findColumn(columnName));
}
/**
*
* 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
*/
public java.sql.Timestamp getTimestamp(String columnName)
throws SQLException {
return getTimestamp(findColumn(columnName));
}
/**
*
* 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
* @see #getAsciiStream(int)
*/
public java.io.InputStream getAsciiStream(String columnName)
throws SQLException {
return getAsciiStream(findColumn(columnName));
}
/**
*
* 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
* @see #getUnicodeStream(int)
*/
public java.io.InputStream getUnicodeStream(String columnName)
throws SQLException {
return getUnicodeStream(findColumn(columnName));
}
/**
*
* Retrieves the value of the designated column in the current row
* of this ResultSet object 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.
*
*
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
*/
public java.io.InputStream getBinaryStream(String columnName)
throws SQLException {
return getBinaryStream(findColumn(columnName));
}
//=====================================================================
// 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Up to and including 1.7.1, HSQLDB does not produce
* SQLWarning objects. This method always returns
* null.
*
SQLWarning object reported or
* null if there are none
*
* Up to and including 1.7.1, HSQLDB always returns null.
* @exception SQLException if a database access error occurs or this
* method is called on a closed result set
*/
public SQLWarning getWarnings() throws SQLException {
return null;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.1, HSQLDB does not produce SQLWarning
* objects on any ResultSet object warning chain; calls to this method
* are ignored.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support this feature.
*
* Calling this method always throws an SQLException,
* stating that the operation is not supported.
*
ResultSet object's cursor
* @exception SQLException if a database access error occurs
*/
public String getCursorName() throws SQLException {
throw jdbcUtil.notSupported;
}
/**
*
* Retrieves the number, types and properties of
* this ResultSet object's columns.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Example:
*
* The following code fragment creates a ResultSet object rs,
* creates a ResultSetMetaData object rsmd, and uses rsmd
* to find out how many columns rs has and whether the first column
* in rs can be used in a WHERE clause.
*
*
* ResultSet rs = stmt.executeQuery("SELECT a, b, c FROM TABLE2");
* ResultSetMetaData rsmd = rs.getMetaData();
* int numberOfColumns = rsmd.getColumnCount();
* boolean b = rsmd.isSearchable(1);
*
*
*
*
*
Warning:
*
* Including 1.7.1, HSQLDB did not generate accurate
* ResultSetMetaData. Below were the the most important
* methods to consider:
*
*
* - isAutoIncrement(int) always returned
false
* - isCurrency(int) always returned
false
* - isNullable(int) always returned
*
columnNullableUnknown
* - getColumnDisplaySize(int) returned zero for all valid column
* numbers
* - getSchemaName(int) always returned
* ""
* - getPrecision(int) always returned zero
* - getScale(int) always returned zero
* - getCatalogName(int) always returned
* ""
*
*
*
*
* Starting with 1.7.2, ResultSetMetaData has been split out into its own
* interface implemenation (jdbcResultSetMetaData), support has been
* improved considerably for a number of methods and behaviour has
* been altered slightly in many areas.
*
ResultSet object's columns
* @exception SQLException if a database access error occurs
* @see jdbcResultSetMetaData
*/
public ResultSetMetaData getMetaData() throws SQLException {
if (rsmd == null) {
rsmd = new jdbcResultSetMetaData(this, connProperties);
}
return rsmd;
}
/**
*
* 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 datatabase-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
*/
public Object getObject(int columnIndex) throws SQLException {
checkAvailable();
Object o;
try {
o = nCurrent.data[--columnIndex];
} catch (ArrayIndexOutOfBoundsException e) {
throw jdbcUtil.sqlException(Trace.COLUMN_NOT_FOUND,
String.valueOf(++columnIndex));
}
// use checknull because getColumnInType is not used
if (checkNull(o)) {
return null;
}
// fredt@users 20020328 - patch 482109 by fredt - OBJECT handling
// fredt@users 20030708 - patch 1.7.2 - OBJECT handling - superseded
if (o instanceof JavaObject) {
try {
return ((JavaObject) o).getObject();
} catch (HsqlException e) {
throw jdbcUtil.sqlException(
Trace.error(Trace.SERIALIZATION_FAILURE));
}
} else if (o instanceof Binary) {
return ((Binary) o).getClonedBytes();
} else if (o instanceof java.sql.Date) {
return ((java.sql.Date) o).clone();
} else if (o instanceof java.sql.Time) {
return ((java.sql.Time) o).clone();
} else if (o instanceof java.sql.Timestamp) {
return ((java.sql.Timestamp) o).clone();
} else {
return o;
}
}
/**
*
* 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 datatabase-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
*/
public Object getObject(String columnName) throws SQLException {
return getObject(findColumn(columnName));
}
//----------------------------------------------------------------
/**
*
* 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
*/
public int findColumn(String columnName) throws SQLException {
for (int i = 0; i < iColumnCount; i++) {
String name = rResult.metaData.sLabel[i];
if (columnName.equalsIgnoreCase(name)) {
return i + 1;
}
}
throw jdbcUtil.sqlException(Trace.COLUMN_NOT_FOUND, columnName);
}
//--------------------------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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Starting with 1.7.0. HSQLDB supports this.
*
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 JDK 1.2
*/
public java.io.Reader getCharacterStream(int columnIndex)
throws SQLException {
String s = getString(columnIndex);
if (s == null) {
return null;
}
return new StringReader(s);
}
/**
*
* Retrieves the value of the designated column in the current row
* of this ResultSet object as a
* java.io.Reader object.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Starting with 1.7.0, HSQLDB supports this.
*
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 JDK 1.2
*/
public java.io.Reader getCharacterStream(String columnName)
throws SQLException {
return getCharacterStream(findColumn(columnName));
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public BigDecimal getBigDecimal(int columnIndex)
throws java.sql.SQLException {
return (BigDecimal) getColumnInType(columnIndex, Types.DECIMAL);
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public BigDecimal getBigDecimal(String columnName) throws SQLException {
return getBigDecimal(findColumn(columnName));
}
//---------------------------------------------------------------------
// 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean isBeforeFirst() throws SQLException {
// bInit indicates whether the resultset has not been traversed or not
// true - it has ---- false it hasn't
checkClosed();
return rResult.rRoot != null &&!bInit;
// End New Cose
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean isAfterLast() throws SQLException {
// At afterLast condition exists when resultset has been traversed and
// the current row is null. iCurrentRow should also be set to
// afterlast but no need to test
checkClosed();
return rResult.rRoot != null && bInit && nCurrent == null;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean isFirst() throws SQLException {
checkClosed();
return iCurrentRow == 1;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, this method is not terribly expensive;
* the entire result is fetched internally before this object
* is returned to a caller.
*
true if the cursor is on the last row;
* false otherwise
* @exception SQLException if a database access error occurs
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean isLast() throws SQLException {
checkClosed();
// If the resultset has not been traversed, then exit with false
// At the last row if the next row is null
return rResult.rRoot != null && bInit && nCurrent != null
&& nCurrent.next == null;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public void beforeFirst() throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
// Set to beforeFirst status
bInit = false;
nCurrent = null;
iCurrentRow = 0;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public void afterLast() throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
if (rResult != null && rResult.rRoot != null) {
// not an empty resultset, so set the afterLast status
bInit = true;
iCurrentRow = rResult.getSize() + 1;
nCurrent = null;
}
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean first() throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
if (rResult == null) {
return false;
}
bInit = false;
if (rResult.rRoot != null) {
bInit = true;
nCurrent = rResult.rRoot;
iCurrentRow = 1;
}
return bInit;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean last() throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
if (rResult == null) {
return false;
}
if (rResult.rRoot == null) {
return false;
}
// it resultset not traversed yet, set to first row
if (!bInit || nCurrent == null) {
first();
}
// go to the last row
while (nCurrent.next != null) {
iCurrentRow++;
nCurrent = nCurrent.next;
}
return true;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public int getRow() throws SQLException {
checkClosed();
return iCurrentRow;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean absolute(int row) throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
if (rResult == null) {
return false;
}
if (rResult.rRoot == null || row == 0) {
// No rows in the resultset or tried to execute absolute(0)
// which is not valid
return false;
}
// A couple of special cases
switch (row) {
case 1 :
return first(); // absolute(1) is same as first()
case -1 :
return last(); // absolute(-1) is same as last()
}
// If the row variable is negative, calculate the target
// row from the end of the resultset.
if (row < 0) {
// we know there are rows in resultset, so get the last
last();
// calculate the target row
row = iCurrentRow + row + 1;
// Exit if the target row is before the beginning of the resultset
if (row <= 0) {
beforeFirst();
return false;
}
}
if (row < iCurrentRow || iCurrentRow == 0) {
// Need to go back and start from the beginning of the resultset
beforeFirst();
}
// go to the tagget row;
while (row > iCurrentRow) {
next();
if (nCurrent == null) {
break;
}
}
return nCurrent != null;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean relative(int rows) throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
if (rResult == null) {
return false;
}
if (rResult.rRoot == null) {
return false;
}
// if the direction is backward calculate the target row
if (rows < 0) {
rows = iCurrentRow + rows;
// set status to beforeFirst status
beforeFirst();
// Exit if the target row is before the beginning of the resultset
if (rows <= 0) {
return false;
}
}
while (rows-- > 0) {
next();
if (nCurrent == null) {
break;
}
}
// if nCurrent is null, the postion will be afterLast
return nCurrent != null;
}
/**
*
* 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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean previous() throws SQLException {
checkClosed();
if (this.getType() == TYPE_FORWARD_ONLY) {
throw jdbcUtil.sqlException(Trace.RESULTSET_FORWARD_ONLY);
}
if (rResult == null || rResult.rRoot == null || iCurrentRow == 0) {
// Empty resultset or no valid row
return false;
}
if (bInit && nCurrent == null) {
// Special condition: in an afterlast condition so go to last
// row in the resultset
return last();
}
int targetRow = iCurrentRow - 1;
if (targetRow == 0) {
// Have gone to a beforeFirst status. Not sure if the
// beforeFirst status should be set or not.
// The spec is not very clear.
beforeFirst();
return false;
}
// Go to the target row. We always have to start from the first row
// since the resultset is a forward direction list only
first();
while (targetRow != iCurrentRow) {
nCurrent = nCurrent.next;
iCurrentRow++;
}
return nCurrent != null;
}
//---------------------------------------------------------------------
// Properties
//---------------------------------------------------------------------
// fredt@users - 20020902 - patch 1.7.1 - fetch size and direction
// We now interpret fetch size and direction as irrelevent to HSQLDB because
// the result set is built and returned as one whole data structure.
// Exceptions thrown are adjusted to mimimal and the javadoc updated.
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB builds and returns result sets as a whole;
* this method does nothing. However, as mandated by the JDBC standard,
* an SQLException is thrown if the result set type is TYPE_FORWARD_ONLY
* and a fetch direction other than FETCH_FORWARD is requested.
*
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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
* @see jdbcStatement#setFetchDirection
* @see #getFetchDirection
*/
public void setFetchDirection(int direction) throws SQLException {
checkClosed();
if (rsType == TYPE_FORWARD_ONLY && direction != FETCH_FORWARD) {
throw jdbcUtil.notSupported;
}
}
/**
*
* Retrieves the fetch direction for this
* ResultSet object.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB builds and returns result sets as a whole;
* this method always returns FETCH_FORWARD, but the value
* has no real meaning.
*
ResultSet
* object
* @exception SQLException if a database access error occurs
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
* @see #setFetchDirection
*/
public int getFetchDirection() throws SQLException {
checkClosed();
return FETCH_FORWARD;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB builds and returns result sets
* as a whole; this method does nothing.
*
0 <= rows <= this.getMaxRows() is not satisfied
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
* @see #getFetchSize
* @see jdbcStatement#setFetchSize
* @see jdbcStatement#getFetchSize
*/
public void setFetchSize(int rows) throws SQLException {
checkAvailable();
if (rows < 0
|| (sqlStatement.maxRows != 0
&& rows > sqlStatement.maxRows)) {
throw jdbcUtil.sqlException(Trace.INVALID_JDBC_ARGUMENT);
}
}
/**
*
* Retrieves the fetch size for this
* ResultSet object.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB builds and returns result sets
* as a whole; the value returned (always 1) has no significance.
*
ResultSet object
* @exception SQLException if a database access error occurs
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
* @see #setFetchSize
* @see jdbcStatement#getFetchSize
* @see jdbcStatement#setFetchSize
*/
public int getFetchSize() throws SQLException {
checkClosed();
return 1;
}
/**
*
* Retrieves the type of this ResultSet object.
* The type is determined by the Statement object
* that created the result set.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support and thus
* never returns ResultSet.TYPE_SCROLL_SENSITIVE.
*
ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE,
* or ResultSet.TYPE_SCROLL_SENSITIVE (not supported)
* @exception SQLException if a database access error occurs
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public int getType() throws SQLException {
checkClosed();
return rsType;
}
/**
*
* Retrieves the concurrency mode of this ResultSet object.
* The concurrency used is determined by the
* Statement object that created the result set.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB supports only CONCUR_READ_ONLY;
* this method always returns CONCUR_READ_ONLY.
*
ResultSet.CONCUR_READ_ONLY
* or ResultSet.CONCUR_UPDATABLE
* @exception SQLException if a database access error occurs
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public int getConcurrency() throws SQLException {
checkClosed();
return CONCUR_READ_ONLY;
}
//---------------------------------------------------------------------
// Updates
//---------------------------------------------------------------------
/**
*
* Retrieves whether the current row has been updated. The value returned
* depends on whether or not the result set can detect updates.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always returns false.
*
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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean rowUpdated() throws SQLException {
checkClosed();
return false;
}
/**
*
* Retrieves whether the current row has had an insertion.
* The value returned depends on whether or not this
* ResultSet object can detect visible inserts.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always returns false.
*
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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean rowInserted() throws SQLException {
checkClosed();
return false;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always returns false.
*
true if a row was deleted and deletions are
* detected; false otherwise
* @exception SQLException if a database access error occurs
* @see DatabaseMetaData#deletesAreDetected
* @since JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public boolean rowDeleted() throws SQLException {
checkClosed();
return false;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.1, HSQLDB does not support updateable results.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable results.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException, stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
updateRow or
* insertRow methods are called to update the database.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
updateRow or
* insertRow methods are called to update the database.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
updateRow or
* insertRow methods are called to update the database.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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 JDK 1.2 (JDK 1.1.x developers: read the new overview for
* jdbcResultSet)
*/
public void updateObject(int columnIndex, Object x,
int scale) throws SQLException {
throw jdbcUtil.notSupported;
}
/**
*
* 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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
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.
*
*
*
*
*
HSQLDB-Specific Information:
*
* Including 1.7.2, HSQLDB does not support updateable result sets.
*
* This method always throws an SQLException stating that
* the operation is not supported.
*
The search page
Other source code files at this package level
Click here to learn more about this project