Java Doc for ResultSet_base.java in  » Database-JDBC-Connection-Pool » octopus » com » internetcds » jdbc » tds » Java Source Code / Java DocumentationJava Source Code and Java Documentation

A ResultSet provides access to a table of data generated by executing a Statement. The table rows are retrieved in sequence. Within a row its column values can be accessed in any order.

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.
author:
   Craig Spannring
author:
   The FreeTDS project
version:
   $Id: ResultSet_base.java,v 1.2 2007-10-19 13:21:40 sinisa Exp $
See Also:   Statement.executeQuery
See Also:   Statement.getResultSet
See Also:   ResultSetMetaData
See Also:   Tds.getRow

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.

In SQL, a result table is retrieved through a cursor that is named.

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.

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 first warning reported by calls on this ResultSet is returned.

If an input stream from the previous row is open, it is implicitly closed.

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.
exception:
  SQLException - if a database-access error occurs.

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.
Parameters:
  columnIndex - the first column is 1, the second is 2, ... a Java input stream that delivers the database column valueas a stream of one byte ASCII characters. If the value is SQL NULLthen the result is null.
exception:
  SQLException - if a database-access error occurs.

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.
Parameters:
  columnName - is the SQL name of the column a Java input stream that delivers the database column valueas a stream of one byte ASCII characters. If the value is SQL NULLthen the result is null.
exception:
  SQLException - if a database-access error occurs.

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.
Parameters:
  columnIndex - the first column is 1, the second is 2, ... a Java input stream that delivers the database column valueas a stream of uninterpreted bytes. If the value is SQL NULLthen the result is null.
exception:
  SQLException - if a database-access error occurs.

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.
Parameters:
  columnName - is the SQL name of the column a Java input stream that delivers the database column valueas a stream of uninterpreted bytes. If the value is SQL NULLthen the result is null.
exception:
  SQLException - if a database-access error occurs.

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.

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 the ResultSet's SQL cursor name
exception:
  SQLException - if a database-access error occurs.

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 specified in the JDBC spec.

This method may also be used to read datatabase specific abstract data types. JDBC 2.0 In the JDBC 2.0 API, the behavior of method getObject is extended to materialize data of SQL user-defined types. When the a column contains a structured or distinct value, the behavior of this method is as if it were a call to: getObject(columnIndex, this.getStatement().getConnection().getTypeMap()).
Parameters:
  columnIndex - the first column is 1, the second is 2, ... A java.lang.Object holding the column value.
exception:
  SQLException - if a database-access error occurs.

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 specified in the JDBC spec. JDBC 2.0 In the JDBC 2.0 API, the behavior of method getObject is extended to materialize data of SQL user-defined types. When the a column contains a structured or distinct value, the behavior of this method is as if it were a call to: getObject(columnIndex, this.getStatement().getConnection().getTypeMap()).

This method may also be used to read datatabase specific abstract data types.
Parameters:
  columnName - is the SQL name of the column A java.lang.Object holding the column value.
exception:
  SQLException - if a database-access error occurs.

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.
Parameters:
  columnIndex - the first column is 1, the second is 2, ... a Java input stream that delivers the database column valueas a stream of two byte Unicode characters. If the value is SQL NULLthen the result is null.
exception:
  SQLException - if a database-access error occurs.

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.
Parameters:
  columnName - is the SQL name of the column a Java input stream that delivers the database column valueas a stream of two byte Unicode characters. If the value is SQL NULLthen the result is null.
exception:
  SQLException - if a database-access error occurs.

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. the first SQLWarning or null
exception:
  SQLException - if a database-access error occurs.

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. true if the new current row is valid; false if thereare no more rows
exception:
  SQLException - if a database-access error occurs.