: Class ResultSet

Overview

Package

Class

Tree

Deprecated

Index

Help

1.50.39

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

interbase.interclient
Class ResultSet

java.lang.Object
  |
  +--interbase.interclient.ResultSet

public final class ResultSet
extends Object
implements ResultSet, Adaptor, borland.jdbc.SQLAdapter

Represents a cursor for the results of a SQL query.

A ResultSet provides access to a table of data. A ResultSet object is usually generated by executing a Statement.

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.

The getXXX methods retrieve column values for the current row. You can retrieve values either using the index number of the column, or by using the name of the column. In general using the column index will be more efficient. Columns are numbered from 1.

For maximum portability, ResultSet columns within each row should be read in left-to-right order and each column should be read only once.

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.

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 were used there is no way for the programmer to guarantee that they actually refer to the intended columns.

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.

The number, types and properties of a ResultSet's columns are provided by the ResulSetMetaData object returned by the getMetaData method.

InterClient note: As stated in the specification above "ResultSet columns within each row should be read in left-to-right order and each column should be read only once." This reflects implementation limitations in some underlying database protocols. The current version of InterClient supports random access of result columns. However, future versions may not have this capability by default in order to leverage any performance advantages that may come with sequential-only access. So in the future, random access may require setting a connection property to enable this behavior. Please send mail to mailto:icsupport@interbase.com if you have an opinion about this behavior.

Since:: JDBC 1, with extended behavior in JDBC 2
See Also:: Statement.executeQuery(java.lang.String), Statement.getResultSet(), ResultSetMetaData

Field Summary
`static int`	`CONCUR_READ_ONLY`
`static int`	`CONCUR_UPDATABLE`
`static int`	`FETCH_FORWARD` The rows in a result set will be processed in a forward direction; first-to-last.
`static int`	`FETCH_REVERSE` The rows in a result set will be processed in a reverse direction; last-to-first.
`static int`	`FETCH_UNKNOWN` The order in which rows in a result set will be processed is unknown.
`static int`	`TYPE_FORWARD_ONLY`
`static int`	`TYPE_SCROLL_INSENSITIVE`
`static int`	`TYPE_SCROLL_SENSITIVE`

Method Summary
`boolean`	`absolute(int row)` Move to an absolute row number in the result set.
`boolean`	`adapt(int modifier, Object extraInfo)` Adapt the JDBC object which implements this interface to the modification described by one of the above modifiers.
`void`	`afterLast()` Moves to the end of the result set, just after the last row.
`void`	`beforeFirst()` Moves to the front of the result set, just before the first row.
`void`	`cancelRowUpdates()` The cancelRowUpdates() method may be called after calling an updateXXX() method(s) and before calling updateRow() to rollback the updates made to a row.
`void`	`clearWarnings()` After this call getWarnings returns null until a new warning is reported for this ResultSet.
`void`	`close()` In some cases, it is desirable to immediately release a ResultSet's database and JDBC resources instead of waiting for this to happen when it is automatically closed; the close method provides this immediate release.
`void`	`deleteRow()` Delete the current row from the result set and the underlying database.
`protected void`	`finalize()` A result set will be closed when its finalizer is called by the garbage collector.
`int`	`findColumn(String columnName)` Map a Resultset column name to a ResultSet column index.
`boolean`	`first()` Moves to the first row in the result set.
`Array`	`getArray(int i)` Get an array column.
`Array`	`getArray(String colName)` Get an array column.
`InputStream`	`getAsciiStream(int column)` A column value can be retrieved as a stream of ASCII characters and then read in chunks from the stream.
`InputStream`	`getAsciiStream(String columnName)` A column value can be retrieved as a stream of ASCII characters and then read in chunks from the stream.
`BigDecimal`	`getBigDecimal(int columnIndex)` Get the value of a column in the current row as a java.math.BigDecimal object.
`BigDecimal`	`getBigDecimal(int column, int scale)` Deprecated. to be deprecated in future release, replaced by getBigDecimal(int) without scale in JDBC 2
`BigDecimal`	`getBigDecimal(String columnName)` Get the value of a column in the current row as a java.math.BigDecimal object.
`BigDecimal`	`getBigDecimal(String columnName, int scale)` Deprecated. to be deprecated in future release, replaced by getBigDecimal(java.lang.String) without scale in JDBC 2
`InputStream`	`getBinaryStream(int column)` A column value can be retrieved as a stream of uninterpreted bytes and then read in chunks from the stream.
`InputStream`	`getBinaryStream(String columnName)` A column value can be retrieved as a stream of uninterpreted bytes and then read in chunks from the stream.
`Blob`	`getBlob(int i)` Get a BLOB column.
`Blob`	`getBlob(String colName)` Get a BLOB column.
`boolean`	`getBoolean(int column)` Get the value of a column in the current row as a Java boolean.
`boolean`	`getBoolean(String columnName)` Get the value of a column in the current row as a Java boolean.
`byte`	`getByte(int column)` Get the value of a column in the current row as a Java byte.
`byte`	`getByte(String columnName)` Get the value of a column in the current row as a Java byte.
`byte[]`	`getBytes(int column)` Get the value of a column in the current row as a Java byte array.
`byte[]`	`getBytes(String columnName)` Get the value of a column in the current row as a Java byte array.
`Reader`	`getCharacterStream(int columnIndex)` Get the value of a column in the current row as a java.io.Reader.
`Reader`	`getCharacterStream(String columnName)` Get the value of a column in the current row as a java.io.Reader.
`Clob`	`getClob(int i)` Get a CLOB column.
`Clob`	`getClob(String colName)` Get a CLOB column.
`int`	`getConcurrency()` Return the concurrency of this result set.
`String`	`getCursorName()` Get the name of the SQL cursor used by this ResultSet.
`Date`	`getDate(int column)` Get the value of a column in the current row as a java.sql.Date object.
`Date`	`getDate(int columnIndex, Calendar cal)` Get the value of a column in the current row as a java.sql.Date object.
`Date`	`getDate(String columnName)` Get the value of a column in the current row as a java.sql.Date object.
`Date`	`getDate(String columnName, Calendar cal)` Get the value of a column in the current row as a java.sql.Date object.
`double`	`getDouble(int column)` Get the value of a column in the current row as a Java double.
`double`	`getDouble(String columnName)` Get the value of a column in the current row as a Java double.
`int`	`getFetchDirection()` Return the fetch direction for this result set.
`int`	`getFetchSize()` Return the fetch size for this result set.
`float`	`getFloat(int column)` Get the value of a column in the current row as a Java float.
`float`	`getFloat(String columnName)` Get the value of a column in the current row as a Java float.
`int`	`getInt(int column)` Get the value of a column in the current row as a Java int.
`int`	`getInt(String columnName)` Get the value of a column in the current row as a Java int.
`long`	`getLong(int column)` Get the value of a column in the current row as a Java long.
`long`	`getLong(String columnName)` Get the value of a column in the current row as a Java long.
`ResultSetMetaData`	`getMetaData()` The number, types and properties of a ResultSet's columns are provided by the getMetaData method.
`Object`	`getObject(int column)` Get the value of a column in the current row as a Java object.
`Object`	`getObject(int i, Map map)` Returns the value of column `i` as a Java object.
`Object`	`getObject(String columnName)` Get the value of a column in the current row as a Java object.
`Object`	`getObject(String colName, Map map)` Returns the value of column `i` as a Java object.
`Ref`	`getRef(int i)` Get a REF(<structured-type>) column.
`Ref`	`getRef(String colName)` Get a REF(<structured-type>) column.
`int`	`getRow()` Determine the current row number.
`short`	`getShort(int column)` Get the value of a column in the current row as a Java short.
`short`	`getShort(String columnName)` Get the value of a column in the current row as a Java short.
`Statement`	`getStatement()` Return the Statement that produced the ResultSet.
`String`	`getString(int column)` Get the value of a column in the current row as a Java String.
`String`	`getString(String columnName)` Get the value of a column in the current row as a Java String.
`Time`	`getTime(int column)` Get the value of a column in the current row as a java.sql.Time object.
`Time`	`getTime(int columnIndex, Calendar cal)` Get the value of a column in the current row as a java.sql.Time object.
`Time`	`getTime(String columnName)` Get the value of a column in the current row as a java.sql.Time object.
`Time`	`getTime(String columnName, Calendar cal)` Get the value of a column in the current row as a java.sql.Time object.
`Timestamp`	`getTimestamp(int column)` Get the value of a column in the current row as a java.sql.Timestamp object.
`Timestamp`	`getTimestamp(int columnIndex, Calendar cal)` Get the value of a column in the current row as a java.sql.Timestamp object.
`Timestamp`	`getTimestamp(String columnName)` Get the value of a column in the current row as a java.sql.Timestamp object.
`Timestamp`	`getTimestamp(String columnName, Calendar cal)` Get the value of a column in the current row as a java.sql.Timestamp object.
`int`	`getType()` Return the type of this result set.
`InputStream`	`getUnicodeStream(int column)` Deprecated. to be deprecated in future release, replaced by getCharacterStream(int) in JDBC 2.
`InputStream`	`getUnicodeStream(String columnName)` Deprecated. to be deprecated in future release, replaced by getCharacterStream(java.lang.String) in JDBC 2.
`SQLWarning`	`getWarnings()` The first warning reported by calls on this ResultSet is returned.
`void`	`insertRow()` Insert the contents of the insert row into the result set and the database.
`boolean`	`isAfterLast()` Determine if the cursor is after the last row in the result set.
`boolean`	`isBeforeFirst()` Determine if the cursor is before the first row in the result set.
`boolean`	`isFirst()` Determine if the cursor is on the first row of the result set.
`boolean`	`isLast()` Determine if the cursor is on the last row of the result set.
`boolean`	`isNull(int column)` Is the column value a SQL NULL.
`boolean`	`last()` Moves to the last row in the result set.
`void`	`moveToCurrentRow()` Move the cursor to the remembered cursor position, usually the current row.
`void`	`moveToInsertRow()` Move to the insert row.
`boolean`	`next()` A ResultSet is initially positioned before its first row; the first call to next makes the first row the current row; the second call makes the second row the current row, etc.
`boolean`	`previous()` Moves to the previous row in the result set.
`void`	`refreshRow()` Refresh the value of the current row with its current value in the database.
`boolean`	`relative(int rows)` Moves a relative number of rows, either positive or negative.
`void`	`revert(int modifier)` Revert back to the default JDBC behavior for the object adapted for the modification described by the given modifier.
`boolean`	`rowDeleted()` Determine if this row has been deleted.
`boolean`	`rowInserted()` Determine if the current row has been inserted.
`boolean`	`rowUpdated()` Determine if the current row has been updated.
`void`	`setFetchDirection(int direction)` Give a hint as to the direction in which the rows in this result set will be processed.
`void`	`setFetchSize(int rows)` Give 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.
`void`	`updateAsciiStream(int columnIndex, InputStream x, int length)` Update a column with an ascii stream value.
`void`	`updateAsciiStream(String columnName, InputStream x, int length)` Update a column with an ascii stream value.
`void`	`updateBigDecimal(int columnIndex, BigDecimal x)` Update a column with a BigDecimal value.
`void`	`updateBigDecimal(String columnName, BigDecimal x)` Update a column with a BigDecimal value.
`void`	`updateBinaryStream(int columnIndex, InputStream x, int length)` Update a column with a binary stream value.
`void`	`updateBinaryStream(String columnName, InputStream x, int length)` Update a column with a binary stream value.
`void`	`updateBoolean(int columnIndex, boolean x)` Update a column with a boolean value.
`void`	`updateBoolean(String columnName, boolean x)` Update a column with a boolean value.
`void`	`updateByte(int columnIndex, byte x)` Update a column with a byte value.
`void`	`updateByte(String columnName, byte x)` Update a column with a byte value.
`void`	`updateBytes(int columnIndex, byte[] x)` Update a column with a byte array value.
`void`	`updateBytes(String columnName, byte[] x)` Update a column with a byte array value.
`void`	`updateCharacterStream(int columnIndex, Reader x, int length)` Update a column with a character stream value.
`void`	`updateCharacterStream(String columnName, Reader reader, int length)` Update a column with a character stream value.
`void`	`updateDate(int columnIndex, Date x)` Update a column with a Date value.
`void`	`updateDate(String columnName, Date x)` Update a column with a Date value.
`void`	`updateDouble(int columnIndex, double x)` Update a column with a Double value.
`void`	`updateDouble(String columnName, double x)` Update a column with a double value.
`void`	`updateFloat(int columnIndex, float x)` Update a column with a float value.
`void`	`updateFloat(String columnName, float x)` Update a column with a float value.
`void`	`updateInt(int columnIndex, int x)` Update a column with an integer value.
`void`	`updateInt(String columnName, int x)` Update a column with an integer value.
`void`	`updateLong(int columnIndex, long x)` Update a column with a long value.
`void`	`updateLong(String columnName, long x)` Update a column with a long value.
`void`	`updateNull(int columnIndex)` Give a nullable column a null value.
`void`	`updateNull(String columnName)` Update a column with a null value.
`void`	`updateObject(int columnIndex, Object x)` Update a column with an Object value.
`void`	`updateObject(int columnIndex, Object x, int scale)` Update a column with an Object value.
`void`	`updateObject(String columnName, Object x)` Update a column with an Object value.
`void`	`updateObject(String columnName, Object x, int scale)` Update a column with an Object value.
`void`	`updateRow()` Update the underlying database with the new contents of the current row.
`void`	`updateShort(int columnIndex, short x)` Update a column with a short value.
`void`	`updateShort(String columnName, short x)` Update a column with a short value.
`void`	`updateString(int columnIndex, String x)` Update a column with a String value.
`void`	`updateString(String columnName, String x)` Update a column with a String value.
`void`	`updateTime(int columnIndex, Time x)` Update a column with a Time value.
`void`	`updateTime(String columnName, Time x)` Update a column with a Time value.
`void`	`updateTimestamp(int columnIndex, Timestamp x)` Update a column with a Timestamp value.
`void`	`updateTimestamp(String columnName, Timestamp x)` Update a column with a Timestamp value.
`boolean`	`wasNull()` A column may have the value of SQL NULL; wasNull reports whether the last column read had this special value.

Methods inherited from class java.lang.Object

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

Field Detail

FETCH_FORWARD

public static final int FETCH_FORWARD

The rows in a result set will be processed in a forward direction; first-to-last.

Since:: JDBC 2, not yet supported

FETCH_REVERSE

public static final int FETCH_REVERSE

The rows in a result set will be processed in a reverse direction; last-to-first.

Since:: JDBC 2, not yet supported

FETCH_UNKNOWN

public static final int FETCH_UNKNOWN

The order in which rows in a result set will be processed is unknown.

Since:: JDBC 2, not yet supported

TYPE_FORWARD_ONLY

public static final int TYPE_FORWARD_ONLY

Since:: JDBC 2, not yet supported

TYPE_SCROLL_INSENSITIVE

public static final int TYPE_SCROLL_INSENSITIVE

Since:: JDBC 2, not yet supported

TYPE_SCROLL_SENSITIVE

public static final int TYPE_SCROLL_SENSITIVE

Since:: JDBC 2, not yet supported

CONCUR_READ_ONLY

public static final int CONCUR_READ_ONLY

Since:: JDBC 2, not yet supported

CONCUR_UPDATABLE

public static final int CONCUR_UPDATABLE

Since:: JDBC 2, not yet supported

Method Detail

finalize

protected void finalize()
                 throws Throwable

A result set will be closed when its finalizer is called by the garbage collector. However, there is no guarantee that the garbage collector will ever run, and in general will not run when an application terminates abruptly without closing its resources.

Therefore, it is recommended that result sets be explicitly closed even when your application throws an exception. This can be achieved by placing a call to close() in a finally clause of your application as follows

 try {
   ...
 }
 finally {
   if (resultSet != null) 
     try { resultSet.close (); } catch (SQLException ohWell) {}
   if (statement != null)
     try { statement.close (); } catch (SQLException ohWell) {}
   if (connection != null)
     try { connection.close (); } catch (SQLException ohWell) {}
 }

Or alternatively, use the new System.runFinalizersOnExit(true) method in Java 1.1 or later.

Overrides:: finalize in class Object
Since:: Extension

public boolean next()
             throws SQLException

A ResultSet is initially positioned before its first row; the first call to next makes the first row the current row; the second call makes the second row the current row, etc.

If an input stream from the previous row is open, it is implicitly closed. The ResultSet's warning chain is cleared when a new row is read.

InterClient note: InterClient allows for interleaved calls to next() on two separate result sets.

Specified by:: next in interface ResultSet
Returns:: true if the new current row is valid; false if there are no more rows
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

close

public void close()
           throws SQLException

In some cases, it is desirable to immediately release a ResultSet's database and JDBC resources instead of waiting for this to happen when it is automatically closed; the close method provides this immediate release.

Note: 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.

Specified by:: close in interface ResultSet
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

wasNull

public boolean wasNull()
                throws SQLException

A column may have the value of SQL NULL; wasNull reports whether the last column read had this special value. Note that you must first call getXXX on a column to try to read its value and then call wasNull() to find if the value was the SQL NULL.

Specified by:: wasNull in interface ResultSet
Returns:: true if last column read was SQL NULL
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: isNull(int)

getString

public String getString(int column)
                 throws SQLException

Get the value of a column in the current row as a Java String.

Specified by:: getString in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getBoolean

public boolean getBoolean(int column)
                   throws SQLException

Get the value of a column in the current row as a Java boolean.

Specified by:: getBoolean in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is false
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getByte

public byte getByte(int column)
             throws SQLException

Get the value of a column in the current row as a Java byte.

Specified by:: getByte in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getShort

public short getShort(int column)
               throws SQLException

Get the value of a column in the current row as a Java short.

Specified by:: getShort in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getInt

public int getInt(int column)
           throws SQLException

Get the value of a column in the current row as a Java int.

Specified by:: getInt in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getLong

public long getLong(int column)
             throws SQLException

Get the value of a column in the current row as a Java long.

Specified by:: getLong in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getFloat

public float getFloat(int column)
               throws SQLException

Get the value of a column in the current row as a Java float.

Specified by:: getFloat in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDouble

public double getDouble(int column)
                 throws SQLException

Get the value of a column in the current row as a Java double.

Specified by:: getDouble in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getBigDecimal

public BigDecimal getBigDecimal(int column,
                                int scale)
                         throws SQLException

Deprecated. to be deprecated in future release, replaced by getBigDecimal(int) without scale in JDBC 2

Get the value of a column in the current row as a java.math.BigDecimal object.

Specified by:: getBigDecimal in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; scale - the number of digits to the right of the decimal
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getBytes

public byte[] getBytes(int column)
                throws SQLException

Get the value of a column in the current row as a Java byte array. The bytes represent the raw values returned by the driver.

Specified by:: getBytes in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDate

public Date getDate(int column)
             throws SQLException

Get the value of a column in the current row as a java.sql.Date object.

Specified by:: getDate in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getTime

public Time getTime(int column)
             throws SQLException

Get the value of a column in the current row as a java.sql.Time object.

Specified by:: getTime in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getTimestamp

public Timestamp getTimestamp(int column)
                       throws SQLException

Get the value of a column in the current row as a java.sql.Timestamp object.

Specified by:: getTimestamp in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getAsciiStream

public InputStream getAsciiStream(int column)
                           throws SQLException

A column value can be retrieved as a stream of ASCII characters and then 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 get method implicitly closes the stream. . Also, a stream may return 0 for available() whether there is data available or not.

Specified by:: getAsciiStream in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: 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.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getUnicodeStream

public InputStream getUnicodeStream(int column)
                             throws SQLException

Deprecated. to be deprecated in future release, replaced by getCharacterStream(int) in JDBC 2.

A column value can be retrieved as a stream of Unicode characters and then 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.

Specified by:: getUnicodeStream in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: 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.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getCharacterStream(int)

getBinaryStream

public InputStream getBinaryStream(int column)
                            throws SQLException

A column value can be retrieved as a stream of uninterpreted bytes and then 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 get method implicitly closes the stream. Also, a stream may return 0 for available() whether there is data available or not.

Specified by:: getBinaryStream in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: 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.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getString

public String getString(String columnName)
                 throws SQLException

Get the value of a column in the current row as a Java String.

Specified by:: getString in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getBoolean

public boolean getBoolean(String columnName)
                   throws SQLException

Get the value of a column in the current row as a Java boolean.

Specified by:: getBoolean in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is false
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getByte

public byte getByte(String columnName)
             throws SQLException

Get the value of a column in the current row as a Java byte.

Specified by:: getByte in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.

getShort

public short getShort(String columnName)
               throws SQLException

Get the value of a column in the current row as a Java short.

Specified by:: getShort in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getInt

public int getInt(String columnName)
           throws SQLException

Get the value of a column in the current row as a Java int.

Specified by:: getInt in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getLong

public long getLong(String columnName)
             throws SQLException

Get the value of a column in the current row as a Java long.

Specified by:: getLong in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getFloat

public float getFloat(String columnName)
               throws SQLException

Get the value of a column in the current row as a Java float.

Specified by:: getFloat in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDouble

public double getDouble(String columnName)
                 throws SQLException

Get the value of a column in the current row as a Java double.

Specified by:: getDouble in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is 0
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getBigDecimal

public BigDecimal getBigDecimal(String columnName,
                                int scale)
                         throws SQLException

Deprecated. to be deprecated in future release, replaced by getBigDecimal(java.lang.String) without scale in JDBC 2

Get the value of a column in the current row as a java.math.BigDecimal object.

Specified by:: getBigDecimal in interface ResultSet
Parameters:: columnName - is the SQL name of the column; scale - the number of digits to the right of the decimal
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getBytes

public byte[] getBytes(String columnName)
                throws SQLException

Get the value of a column in the current row as a Java byte array. The bytes represent the raw values returned by the driver.

Specified by:: getBytes in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDate

public Date getDate(String columnName)
             throws SQLException

Get the value of a column in the current row as a java.sql.Date object.

InterClient note: In order to improve performance when scrolling through a result set, this method can be used in conjunction with interbase.interclient.Adaptor.SINGLE_INSTANCE_TIME so that only a single Date instance is created for any given result set; the single Date instance is reused row by row. This saves the overhead in calling the Date constructor for each row.

Specified by:: getDate in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getTime

public Time getTime(String columnName)
             throws SQLException

Get the value of a column in the current row as a java.sql.Time object.

InterClient note: In order to improve performance when scrolling through a result set, this method can be used in conjunction with interbase.interclient.Adaptor.SINGLE_INSTANCE_TIME so that only a single Time instance is created for any given result set; the single Time instance is reused row by row. This saves the overhead in calling the Time constructor for each row.

Specified by:: getTime in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getTimestamp

public Timestamp getTimestamp(String columnName)
                       throws SQLException

Get the value of a column in the current row as a java.sql.Timestamp object.

InterClient note: In order to improve performance when scrolling through a result set, this method can be used in conjunction with interbase.interclient.Adaptor.SINGLE_INSTANCE_TIME so that only a single Timestamp instance is created for any given result set; the single Timestamp instance is reused row by row. This saves the overhead in calling the Timestamp constructor for each row.

Specified by:: getTimestamp in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getAsciiStream

public InputStream getAsciiStream(String columnName)
                           throws SQLException

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 get method implicitly closes the stream.

Specified by:: getAsciiStream in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: 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.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getUnicodeStream

public InputStream getUnicodeStream(String columnName)
                             throws SQLException

Deprecated. to be deprecated in future release, replaced by getCharacterStream(java.lang.String) in JDBC 2.

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 get method implicitly closes the stream.

Specified by:: getUnicodeStream in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: 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.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getCharacterStream(int)

getBinaryStream

public InputStream getBinaryStream(String columnName)
                            throws SQLException

A column value can be retrieved as a stream of uninterpreted bytes and then 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 get method implicitly closes the stream.

Specified by:: getBinaryStream in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: 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.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

The first warning reported by calls on this ResultSet is returned. Subsequent ResultSet warnings will be chained to this SQLWarning.

The warning chain is automatically cleared each time a new row is read.

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.

Specified by:: getWarnings in interface ResultSet
Returns:: the first SQLWarning or null
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

clearWarnings

public void clearWarnings()
                   throws SQLException

After this call getWarnings returns null until a new warning is reported for this ResultSet.

Specified by:: clearWarnings in interface ResultSet
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getCursorName

public String getCursorName()
                     throws SQLException

Get the name of the SQL cursor used by this ResultSet.

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.

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.

Note: If positioned update is not supported a SQLException is thrown

Specified by:: getCursorName in interface ResultSet
Returns:: the ResultSet's SQL cursor name
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMetaData

public ResultSetMetaData getMetaData()
                              throws SQLException

The number, types and properties of a ResultSet's columns are provided by the getMetaData method.

Specified by:: getMetaData in interface ResultSet
Returns:: the description of a ResultSet's columns
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getObject

public Object getObject(int column)
                 throws SQLException

Get the value of a column in the current row as a Java object.

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.

This method may also be used to read datatabase specific abstract data types.

JDBC 2.0 note: New behavior for getObject(). The behavior of method getObject() is extended to materialize data of SQL user-defined types. When the column columnIndex is a structured or distinct value, the behavior of this method is as if it were a call to:

 getObject(columnIndex, this.getStatement().getConnection().getTypeMap())

Specified by:: getObject in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: a java.lang.Object holding the column value.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, with extended behavior in JDBC 2

getObject

public Object getObject(String columnName)
                 throws SQLException

Get the value of a column in the current row as a Java object.

This method may also be used to read datatabase specific abstract data types.

JDBC 2.0 note: New behavior for getObject(). The behavior of method getObject() is extended to materialize data of SQL user-defined types. When the column columnName is a structured or distinct value, the behavior of this method is as if it were a call to:

 getObject(columnName, this.getStatement().getConnection().getTypeMap())

Specified by:: getObject in interface ResultSet
Parameters:: columnName - is the SQL name of the column
Returns:: a java.lang.Object holding the column value.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, with extended behavior in JDBC 2

findColumn

public int findColumn(String columnName)
               throws SQLException

Map a Resultset column name to a ResultSet column index.

Specified by:: findColumn in interface ResultSet
Parameters:: columnName - the name of the column
Returns:: the column index
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getCharacterStream

public Reader getCharacterStream(int columnIndex)
                          throws SQLException

Get the value of a column in the current row as a java.io.Reader.

Specified by:: getCharacterStream in interface ResultSet
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

getCharacterStream

public Reader getCharacterStream(String columnName)
                          throws SQLException

Get the value of a column in the current row as a java.io.Reader.

Specified by:: getCharacterStream in interface ResultSet
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

getBigDecimal

public BigDecimal getBigDecimal(int columnIndex)
                         throws SQLException

Get the value of a column in the current row as a java.math.BigDecimal object.

Specified by:: getBigDecimal in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Returns:: the column value (full precision); if the value is SQL NULL, the result is null
Throws:: SQLException - if a database-access error occurs.
Since:: JDBC 2, not yet supported

getBigDecimal

public BigDecimal getBigDecimal(String columnName)
                         throws SQLException

Get the value of a column in the current row as a java.math.BigDecimal object.

Specified by:: getBigDecimal in interface ResultSet
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

isBeforeFirst

public boolean isBeforeFirst()
                      throws SQLException

Determine if the cursor is before the first row in the result set.

Specified by:: isBeforeFirst in interface ResultSet
Returns:: true if before the first row, false otherwise. Returns false when the result set contains no rows.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

isAfterLast

public boolean isAfterLast()
                    throws SQLException

Determine if the cursor is after the last row in the result set.

Specified by:: isAfterLast in interface ResultSet
Returns:: true if after the last row, false otherwise. Returns false when the result set contains no rows.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

isFirst

public boolean isFirst()
                throws SQLException

Determine if the cursor is on the first row of the result set.

Specified by:: isFirst in interface ResultSet
Returns:: true if on the first row, false otherwise.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

isLast

public boolean isLast()
               throws SQLException

Determine if the cursor is on the last row of the result set. Note: Calling isLast() may be expensive since 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.

Specified by:: isLast in interface ResultSet
Returns:: true if on the last row, false otherwise.
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

beforeFirst

public void beforeFirst()
                 throws SQLException

Moves to the front of the result set, just before the first row. Has no effect if the result set contains no rows.

Specified by:: beforeFirst in interface ResultSet
Throws:: SQLException - if a database-access error occurs, or result set type is TYPE_FORWARD_ONLY
Since:: JDBC 2, not yet supported

afterLast

public void afterLast()
               throws SQLException

Moves to the end of the result set, just after the last row. Has no effect if the result set contains no rows.

Specified by:: afterLast in interface ResultSet
Throws:: SQLException - if a database-access error occurs, or result set type is TYPE_FORWARD_ONLY.
Since:: JDBC 2, not yet supported

first

public boolean first()
              throws SQLException

Moves to the first row in the result set.

Specified by:: first in interface ResultSet
Returns:: true if on a valid row, false if no rows in the result set.
Throws:: SQLException - if a database-access error occurs, or result set type is TYPE_FORWARD_ONLY.
Since:: JDBC 2, not yet supported

last

public boolean last()
             throws SQLException

Moves to the last row in the result set.

Specified by:: last in interface ResultSet
Returns:: true if on a valid row, false if no rows in the result set.
Throws:: SQLException - if a database access error occurs, or result set type is TYPE_FORWARD_ONLY.
Since:: JDBC 2, not yet supported

getRow

public int getRow()
           throws SQLException

Determine the current row number. The first row is number 1, the second number 2, etc.

Specified by:: getRow in interface ResultSet
Returns:: the current row number, else return 0 if there is no current row
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

absolute

public boolean absolute(int row)
                 throws SQLException

Move to an absolute row number in the result set.

If row is positive, moves to an absolute row with respect to the beginning of the result set. The first row is row 1, the second is row 2, etc.

If row is negative, moves to an absolute row position with respect to the end of result set. For example, calling absolute(-1) positions the cursor on the last row, absolute(-2) indicates the next-to-last row, etc.

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.

Note: Calling absolute(1) is the same as calling first(). Calling absolute(-1) is the same as calling last().

Specified by:: absolute in interface ResultSet
Returns:: true if on the result set, false if off.
Throws:: SQLException - if a database access error occurs, or row is 0, or result set type is TYPE_FORWARD_ONLY.
Since:: JDBC 2, not yet supported

relative

public boolean relative(int rows)
                 throws SQLException

Moves 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 relative(1) is different than calling next() since is makes sense to call next() 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.

Specified by:: relative in interface ResultSet
Returns:: true if on a row, false otherwise.
Throws:: SQLException - if a database access error occurs, or there is no current row, or result set type is TYPE_FORWARD_ONLY.
Since:: JDBC 2, not yet supported

public boolean previous()
                 throws SQLException

Moves to the previous row in the result set.

Note: previous() is not the same as relative(-1) since it makes sense to call previous() when there is no current row.

Specified by:: previous in interface ResultSet
Returns:: true if on a valid row, false if off the result set.
Throws:: SQLException - if a database access error occurs, or result set type is TYPE_FORWAR_DONLY.
Since:: JDBC 2, not yet supported

setFetchDirection

public void setFetchDirection(int direction)
                       throws SQLException

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

Specified by:: setFetchDirection in interface ResultSet
Throws:: SQLException - if a database access error occurs, or the result set type is TYPE_FORWARD_ONLY and direction is not FETCH_FORWARD.
Since:: JDBC 2, not yet supported

getFetchDirection

public int getFetchDirection()
                      throws SQLException

Return the fetch direction for this result set.

Specified by:: getFetchDirection in interface ResultSet
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

setFetchSize

public void setFetchSize(int rows)
                  throws SQLException

Give 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, then 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 creates the result set. The fetch size may be changed at any time.

Specified by:: setFetchSize in interface ResultSet
Parameters:: rows - the number of rows to fetch
Throws:: SQLException - if a database access error occurs, or the condition 0 <= rows <= this.getMaxRows() is not satisfied.
Since:: JDBC 2, not yet supported

getFetchSize

public int getFetchSize()
                 throws SQLException

Return the fetch size for this result set.

Specified by:: getFetchSize in interface ResultSet
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getType

public int getType()
            throws SQLException

Return the type of this result set. The type is determined based on the statement that created the result set.

Specified by:: getType in interface ResultSet
Returns:: TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, or TYPE_SCROLL_SENSITIVE
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getConcurrency

public int getConcurrency()
                   throws SQLException

Return the concurrency of this result set. The concurrency used is determined by the statement that created the result set.

Specified by:: getConcurrency in interface ResultSet
Returns:: the concurrency type, CONCUR_READ_ONLY, etc.
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

rowUpdated

public boolean rowUpdated()
                   throws SQLException

Determine if the current row has been updated. The value returned depends on whether or not the result set can detect updates.

Specified by:: rowUpdated in interface ResultSet
Returns:: true if the row has been visibly updated by the owner or another, and updates are detected
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported
See Also:: DatabaseMetaData.updatesAreDetected(int)

rowInserted

public boolean rowInserted()
                    throws SQLException

Determine if the current row has been inserted. The value returned depends on whether or not the result set can detect visible inserts.

Specified by:: rowInserted in interface ResultSet
Returns:: true if inserted and inserts are detected
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported
See Also:: DatabaseMetaData.insertsAreDetected(int)

rowDeleted

public boolean rowDeleted()
                   throws SQLException

Determine if this 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.

Specified by:: rowDeleted in interface ResultSet
Returns:: true if deleted and deletes are detected
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported
See Also:: DatabaseMetaData.deletesAreDetected(int)

updateNull

public void updateNull(int columnIndex)
                throws SQLException

Give a nullable column a null value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateNull in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBoolean

public void updateBoolean(int columnIndex,
                          boolean x)
                   throws SQLException

Update a column with a boolean value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateBoolean in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateByte

public void updateByte(int columnIndex,
                       byte x)
                throws SQLException

Update a column with a byte value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateByte in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateShort

public void updateShort(int columnIndex,
                        short x)
                 throws SQLException

Update a column with a short value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateShort in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateInt

public void updateInt(int columnIndex,
                      int x)
               throws SQLException

Update a column with an integer value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateInt in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateLong

public void updateLong(int columnIndex,
                       long x)
                throws SQLException

Update a column with a long value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateLong in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateFloat

public void updateFloat(int columnIndex,
                        float x)
                 throws SQLException

Update a column with a float value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateFloat in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateDouble

public void updateDouble(int columnIndex,
                         double x)
                  throws SQLException

Update a column with a Double value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateDouble in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBigDecimal

public void updateBigDecimal(int columnIndex,
                             BigDecimal x)
                      throws SQLException

Update a column with a BigDecimal value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateBigDecimal in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateString

public void updateString(int columnIndex,
                         String x)
                  throws SQLException

Update a column with a String value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateString in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBytes

public void updateBytes(int columnIndex,
                        byte[] x)
                 throws SQLException

Update a column with a byte array value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateBytes in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateDate

public void updateDate(int columnIndex,
                       Date x)
                throws SQLException

Update a column with a Date value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateDate in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateTime

public void updateTime(int columnIndex,
                       Time x)
                throws SQLException

Update a column with a Time value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateTime in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateTimestamp

public void updateTimestamp(int columnIndex,
                            Timestamp x)
                     throws SQLException

Update a column with a Timestamp value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateTimestamp in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateAsciiStream

public void updateAsciiStream(int columnIndex,
                              InputStream x,
                              int length)
                       throws SQLException

Update a column with an ascii stream value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateAsciiStream in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value; length - the length of the stream
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBinaryStream

public void updateBinaryStream(int columnIndex,
                               InputStream x,
                               int length)
                        throws SQLException

Update a column with a binary stream value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateBinaryStream in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value; length - the length of the stream
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateCharacterStream

public void updateCharacterStream(int columnIndex,
                                  Reader x,
                                  int length)
                           throws SQLException

Update a column with a character stream value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateCharacterStream in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value; length - the length of the stream
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateObject

public void updateObject(int columnIndex,
                         Object x,
                         int scale)
                  throws SQLException

Update a column with an Object value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateObject in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value; 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.
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateObject

public void updateObject(int columnIndex,
                         Object x)
                  throws SQLException

Specified by:: updateObject in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateNull

public void updateNull(String columnName)
                throws SQLException

Update a column with a null value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateNull in interface ResultSet
Parameters:: columnName - the name of the column
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBoolean

public void updateBoolean(String columnName,
                          boolean x)
                   throws SQLException

Specified by:: updateBoolean in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateByte

public void updateByte(String columnName,
                       byte x)
                throws SQLException

Specified by:: updateByte in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateShort

public void updateShort(String columnName,
                        short x)
                 throws SQLException

Specified by:: updateShort in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateInt

public void updateInt(String columnName,
                      int x)
               throws SQLException

Specified by:: updateInt in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateLong

public void updateLong(String columnName,
                       long x)
                throws SQLException

Specified by:: updateLong in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateFloat

public void updateFloat(String columnName,
                        float x)
                 throws SQLException

Specified by:: updateFloat in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateDouble

public void updateDouble(String columnName,
                         double x)
                  throws SQLException

Update a column with a double value. The updateXXX() methods are used to update column values in the current row, or the insert row. The updateXXX() methods do not update the underlying database, instead the updateRow() or insertRow() methods are called to update the database.

Specified by:: updateDouble in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBigDecimal

public void updateBigDecimal(String columnName,
                             BigDecimal x)
                      throws SQLException

Specified by:: updateBigDecimal in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateString

public void updateString(String columnName,
                         String x)
                  throws SQLException

Specified by:: updateString in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBytes

public void updateBytes(String columnName,
                        byte[] x)
                 throws SQLException

Specified by:: updateBytes in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateDate

public void updateDate(String columnName,
                       Date x)
                throws SQLException

Specified by:: updateDate in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateTime

public void updateTime(String columnName,
                       Time x)
                throws SQLException

Specified by:: updateTime in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateTimestamp

public void updateTimestamp(String columnName,
                            Timestamp x)
                     throws SQLException

Specified by:: updateTimestamp in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateAsciiStream

public void updateAsciiStream(String columnName,
                              InputStream x,
                              int length)
                       throws SQLException

Specified by:: updateAsciiStream in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value; length - of the stream
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateBinaryStream

public void updateBinaryStream(String columnName,
                               InputStream x,
                               int length)
                        throws SQLException

Specified by:: updateBinaryStream in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value; length - of the stream
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateCharacterStream

public void updateCharacterStream(String columnName,
                                  Reader reader,
                                  int length)
                           throws SQLException

Specified by:: updateCharacterStream in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value; length - of the stream
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateObject

public void updateObject(String columnName,
                         Object x,
                         int scale)
                  throws SQLException

Specified by:: updateObject in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value; 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.
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

updateObject

public void updateObject(String columnName,
                         Object x)
                  throws SQLException

Specified by:: updateObject in interface ResultSet
Parameters:: columnName - the name of the column; x - the new column value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

insertRow

public void insertRow()
               throws SQLException

Insert the contents of the insert row into the result set and the database. Must be on the insert row when this method is called.

Specified by:: insertRow in interface ResultSet
Throws:: SQLException - if a database access error occurs, if called when not on the insert row, or if all non-nullable columns in the insert row have not been given a value
Since:: JDBC 2, not yet supported

updateRow

public void updateRow()
               throws SQLException

Update the underlying database with the new contents of the current row. Cannot be called when on the insert row.

Specified by:: updateRow in interface ResultSet
Throws:: SQLException - if a database access error occurs, or if called when on the insert row
Since:: JDBC 2, not yet supported

deleteRow

public void deleteRow()
               throws SQLException

Delete the current row from the result set and the underlying database. Cannot be called when on the insert row.

Specified by:: deleteRow in interface ResultSet
Throws:: SQLException - if a database access error occurs, or if called when on the insert row.
Since:: JDBC 2, not yet supported

refreshRow

public void refreshRow()
                throws SQLException

Refresh the value of the current row with its current value in the database. Cannot be called when on the insert row. The refreshRow() method provides a way for an application to explicitly tell the JDBC driver to refetch a row(s) from the database. An application may want to call refreshRow() when caching or prefetching is being done by the JDBC driver to fetch the latest value of a row from the database. The JDBC driver may actually refresh multiple rows at once if the fetch size is greater than one. All values are refetched subject to the transaction isolation level and cursor sensitivity. If refreshRow() is called after calling updateXXX(), but before calling updateRow() then the updates made to the row are lost. Calling refreshRow() frequently will likely slow performance.

Specified by:: refreshRow in interface ResultSet
Throws:: SQLException - if a database access error occurs, or if called when on the insert row.
Since:: JDBC 2, not yet supported

cancelRowUpdates

public void cancelRowUpdates()
                      throws SQLException

The cancelRowUpdates() method may be called after calling an updateXXX() method(s) and before calling updateRow() to rollback the updates made to a row. If no updates have been made or updateRow() has already been called, then this method has no effect.

Specified by:: cancelRowUpdates in interface ResultSet
Throws:: SQLException - if a database access error occurs, or if called when on the insert row.
Since:: JDBC 2, not yet supported

moveToInsertRow

public void moveToInsertRow()
                     throws SQLException

Move 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 updateXXX() methods prior to inserting the row into the result set. Only the updateXXX(), getXXX(), and insertRow() methods may be called when the cursor is on the insert row. All of the columns in a result set must be given a value each time this method is called before calling insertRow(). UpdateXXX()must be called before getXXX() on a column.

Specified by:: moveToInsertRow in interface ResultSet
Throws:: SQLException - if a database access error occurs, or the result set is not updatable
Since:: JDBC 2, not yet supported

moveToCurrentRow

public void moveToCurrentRow()
                      throws SQLException

Move the cursor to the remembered cursor position, usually the current row. Has no effect unless the cursor is on the insert row.

Specified by:: moveToCurrentRow in interface ResultSet
Throws:: SQLException - if a database access error occurs, or the result set is not updatable
Since:: JDBC 2, not yet supported

getStatement

public Statement getStatement()
                       throws SQLException

Return the Statement that produced the ResultSet.

Specified by:: getStatement in interface ResultSet
Returns:: the Statment that produced the result set, or null if the result was produced some other way.
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, since 1.50

getObject

public Object getObject(int i,
                        Map map)
                 throws SQLException

Returns the value of column i as a Java object. Use the map to determine the class from which to construct data of SQL structured and distinct types.

Specified by:: getObject in interface ResultSet
Parameters:: i - the first column is 1, the second is 2, ...; map - the mapping from SQL type names to Java classes
Returns:: an object representing the SQL value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getRef

public Ref getRef(int i)
           throws SQLException

Get a REF(<structured-type>) column.

Specified by:: getRef in interface ResultSet
Parameters:: i - the first column is 1, the second is 2, ...
Returns:: an object representing data of an SQL REF type
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getBlob

public Blob getBlob(int i)
             throws SQLException

Get a BLOB column.

Specified by:: getBlob in interface ResultSet
Parameters:: i - the first column is 1, the second is 2, ...
Returns:: an object representing a BLOB
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getClob

public Clob getClob(int i)
             throws SQLException

Get a CLOB column.

Specified by:: getClob in interface ResultSet
Parameters:: i - the first column is 1, the second is 2, ...
Returns:: an object representing a CLOB
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getArray

public Array getArray(int i)
               throws SQLException

Get an array column.

Specified by:: getArray in interface ResultSet
Parameters:: i - the first column is 1, the second is 2, ...
Returns:: an object representing an SQL array
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getObject

public Object getObject(String colName,
                        Map map)
                 throws SQLException

Returns the value of column i as a Java object. Use the map to determine the class from which to construct data of SQL structured and distinct types.

Specified by:: getObject in interface ResultSet
Parameters:: colName - the column name; map - the mapping from SQL type names to Java classes
Returns:: an object representing the SQL value
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getRef

public Ref getRef(String colName)
           throws SQLException

Get a REF(<structured-type>) column.

Specified by:: getRef in interface ResultSet
Parameters:: colName - the column name
Returns:: an object representing data of an SQL REF type
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getBlob

public Blob getBlob(String colName)
             throws SQLException

Get a BLOB column.

Specified by:: getBlob in interface ResultSet
Parameters:: colName - the column name
Returns:: an object representing a BLOB
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getClob

public Clob getClob(String colName)
             throws SQLException

Get a CLOB column.

Specified by:: getClob in interface ResultSet
Parameters:: colName - the column name
Returns:: an object representing a CLOB
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getArray

public Array getArray(String colName)
               throws SQLException

Get an array column.

Specified by:: getArray in interface ResultSet
Parameters:: colName - the column name
Returns:: an object representing an SQL array
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getDate

public Date getDate(int columnIndex,
                    Calendar cal)
             throws SQLException

Get the value of a column in the current row as a java.sql.Date object. Use the calendar to construct an appropriate millisecond value for the Date, if the underlying database doesn't store timezone information.

Specified by:: getDate in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; cal - the calendar to use in constructing the date
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getDate

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

Specified by:: getDate in interface ResultSet
Parameters:: columnName - is the SQL name of the column; cal - the calendar to use in constructing the date
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getTime

public Time getTime(int columnIndex,
                    Calendar cal)
             throws SQLException

Get the value of a column in the current row as a java.sql.Time object. Use the calendar to construct an appropriate millisecond value for the Time, if the underlying database doesn't store timezone information.

Specified by:: getTime in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; cal - the calendar to use in constructing the time
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getTime

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

Specified by:: getTime in interface ResultSet
Parameters:: columnName - is the SQL name of the column; cal - the calendar to use in constructing the time
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getTimestamp

public Timestamp getTimestamp(int columnIndex,
                              Calendar cal)
                       throws SQLException

Get the value of a column in the current row as a java.sql.Timestamp object. Use the calendar to construct an appropriate millisecond value for the Timestamp, if the underlying database doesn't store timezone information.

Specified by:: getTimestamp in interface ResultSet
Parameters:: columnIndex - the first column is 1, the second is 2, ...; cal - the calendar to use in constructing the timestamp
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

getTimestamp

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

Specified by:: getTimestamp in interface ResultSet
Parameters:: columnName - is the SQL name of the column; cal - the calendar to use in constructing the timestamp
Returns:: the column value; if the value is SQL NULL, the result is null
Throws:: SQLException - if a database access error occurs
Since:: JDBC 2, not yet supported

isNull

public boolean isNull(int column)
               throws SQLException

Is the column value a SQL NULL.

Unlike other drivers, InterClient does not require that a column be read before it is checked for NULL.

Throws:: SQLException - if a database access error occurs.
Since:: Extension
See Also:: wasNull()

adapt

public boolean adapt(int modifier,
                     Object extraInfo)
              throws SQLException

Adapt the JDBC object which implements this interface to the modification described by one of the above modifiers.

Specified by:: adapt in interface Adaptor
Parameters:: modifier - is either RIGHT_TRIM_STRINGS, SINGLE_INSTANCE_TIME; extraInfo - Any extra information that needs to be specified along with the modifier.
Returns:: true if the modifier is supported, false otherwise.
Throws:: SQLException - if a database access error occurs.
Since:: Extension

revert

public void revert(int modifier)
            throws SQLException

Revert back to the default JDBC behavior for the object adapted for the modification described by the given modifier.

Specified by:: revert in interface Adaptor
Parameters:: modifier - is either RIGHT_TRIM_STRINGS, SINGLE_INSTANCE_TIME
Throws:: SQLException - if a database access error occurs.
Since:: Extension

Overview

Package

Class

Tree

Deprecated

Index

Help

1.50.39

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Send comments or suggestions to icsupport@interbase.com

interbase.interclient Class ResultSet

FETCH_FORWARD

FETCH_REVERSE

FETCH_UNKNOWN

TYPE_FORWARD_ONLY

TYPE_SCROLL_INSENSITIVE

TYPE_SCROLL_SENSITIVE

CONCUR_READ_ONLY

CONCUR_UPDATABLE

finalize

next

close

wasNull

getString

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getBigDecimal

getBytes

getDate

getTime

getTimestamp

getAsciiStream

getUnicodeStream

getBinaryStream

getString

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getBigDecimal

getBytes

getDate

getTime

getTimestamp

getAsciiStream

getUnicodeStream

getBinaryStream

getWarnings

clearWarnings

getCursorName

getMetaData

getObject

getObject

findColumn

getCharacterStream

getCharacterStream

getBigDecimal

getBigDecimal

isBeforeFirst

isAfterLast

isFirst

isLast

beforeFirst

afterLast

first

last

getRow

absolute

relative

previous

setFetchDirection

getFetchDirection

setFetchSize

getFetchSize

getType

getConcurrency

rowUpdated

rowInserted

rowDeleted

updateNull

updateBoolean

updateByte

interbase.interclient
Class ResultSet