ResultSetWrappingSqlRowSet

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.jdbc.support.rowset
Class ResultSetWrappingSqlRowSet

java.lang.Object
  org.springframework.jdbc.support.rowset.ResultSetWrappingSqlRowSet

All Implemented Interfaces:: Serializable, SqlRowSet

public class ResultSetWrappingSqlRowSet
extends Object
implements SqlRowSet
extends Object
implements SqlRowSet

Default implementation of Spring's SqlRowSet interface.

This implementation wraps a javax.sql.ResultSet, catching any SQLExceptions and translating them to the appropriate Spring InvalidResultSetAccessException.

The passed-in ResultSets should already be disconnected if the SqlRowSet is supposed to be usable in a disconnected fashion. This means that you will usually pass in a javax.sql.rowset.CachedRowSet, which implements the ResultSet interface.

Note: Since JDBC 4.0, it has been clarified that any methods using a String to identify the column should be using the column label. The column label is assigned using the ALIAS keyword in the SQL query string. When the query doesn't use an ALIAS, the default label is the column name. Most JDBC ResultSet implementations follow this new pattern but there are exceptions such as the com.sun.rowset.CachedRowSetImpl class which only uses the column name, ignoring any column labels. As of Spring 3.0.5, ResultSetWrappingSqlRowSet will translate column labels to the correct column index to provide better support for the com.sun.rowset.CachedRowSetImpl which is the default implementation used by JdbcTemplate when working with RowSets.

Note: This class implements the java.io.Serializable marker interface through the SqlRowSet interface, but is only actually serializable if the disconnected ResultSet/RowSet contained in it is serializable. Most CachedRowSet implementations are actually serializable, so this should usually work out.

Since:: 1.2
Author:: Thomas Risberg, Juergen Hoeller
See Also:: ResultSet, CachedRowSet, JdbcTemplate.queryForRowSet(java.lang.String), Serialized Form

Constructor Summary
`ResultSetWrappingSqlRowSet(ResultSet resultSet)` Create a new ResultSetWrappingSqlRowSet for the given ResultSet.

Method Summary
`boolean`	`absolute(int row)` Moves the cursor to the given row number in the RowSet, just after the last row.
`void`	`afterLast()` Moves the cursor to the end of this RowSet.
`void`	`beforeFirst()` Moves the cursor to the front of this RowSet, just before the first row.
`int`	`findColumn(String columnLabel)` Maps the given column label to its column index.
`boolean`	`first()` Moves the cursor to the first row of this RowSet.
`BigDecimal`	`getBigDecimal(int columnIndex)` Retrieves the value of the indicated column in the current row as an BigDecimal object.
`BigDecimal`	`getBigDecimal(String columnLabel)` Retrieves the value of the indicated column in the current row as an BigDecimal object.
`boolean`	`getBoolean(int columnIndex)` Retrieves the value of the indicated column in the current row as a boolean.
`boolean`	`getBoolean(String columnLabel)` Retrieves the value of the indicated column in the current row as a boolean.
`byte`	`getByte(int columnIndex)` Retrieves the value of the indicated column in the current row as a byte.
`byte`	`getByte(String columnLabel)` Retrieves the value of the indicated column in the current row as a byte.
`Date`	`getDate(int columnIndex)` Retrieves the value of the indicated column in the current row as a Date object.
`Date`	`getDate(int columnIndex, Calendar cal)` Retrieves the value of the indicated column in the current row as a Date object.
`Date`	`getDate(String columnLabel)` Retrieves the value of the indicated column in the current row as a Date object.
`Date`	`getDate(String columnLabel, Calendar cal)` Retrieves the value of the indicated column in the current row as a Date object.
`double`	`getDouble(int columnIndex)` Retrieves the value of the indicated column in the current row as a Double object.
`double`	`getDouble(String columnLabel)` Retrieves the value of the indicated column in the current row as a Double object.
`float`	`getFloat(int columnIndex)` Retrieves the value of the indicated column in the current row as a float.
`float`	`getFloat(String columnLabel)` Retrieves the value of the indicated column in the current row as a float.
`int`	`getInt(int columnIndex)` Retrieves the value of the indicated column in the current row as an int.
`int`	`getInt(String columnLabel)` Retrieves the value of the indicated column in the current row as an int.
`long`	`getLong(int columnIndex)` Retrieves the value of the indicated column in the current row as a long.
`long`	`getLong(String columnLabel)` Retrieves the value of the indicated column in the current row as a long.
`SqlRowSetMetaData`	`getMetaData()` Retrieves the meta data (number, types and properties for the columns) of this row set.
`Object`	`getObject(int columnIndex)` Retrieves the value of the indicated column in the current row as an Object.
`Object`	`getObject(int i, Map<String,Class<?>> map)` Retrieves the value of the indicated column in the current row as an Object.
`Object`	`getObject(String columnLabel)` Retrieves the value of the indicated column in the current row as an Object.
`Object`	`getObject(String columnLabel, Map<String,Class<?>> map)` Retrieves the value of the indicated column in the current row as an Object.
`ResultSet`	`getResultSet()` Return the underlying ResultSet (usually a `javax.sql.rowset.CachedRowSet`).
`int`	`getRow()` Retrieves the current row number.
`short`	`getShort(int columnIndex)` Retrieves the value of the indicated column in the current row as a short.
`short`	`getShort(String columnLabel)` Retrieves the value of the indicated column in the current row as a short.
`String`	`getString(int columnIndex)` Retrieves the value of the indicated column in the current row as a String.
`String`	`getString(String columnLabel)` Retrieves the value of the indicated column in the current row as a String.
`Time`	`getTime(int columnIndex)` Retrieves the value of the indicated column in the current row as a Time object.
`Time`	`getTime(int columnIndex, Calendar cal)` Retrieves the value of the indicated column in the current row as a Time object.
`Time`	`getTime(String columnLabel)` Retrieves the value of the indicated column in the current row as a Time object.
`Time`	`getTime(String columnLabel, Calendar cal)` Retrieves the value of the indicated column in the current row as a Time object.
`Timestamp`	`getTimestamp(int columnIndex)` Retrieves the value of the indicated column in the current row as a Timestamp object.
`Timestamp`	`getTimestamp(int columnIndex, Calendar cal)` Retrieves the value of the indicated column in the current row as a Timestamp object.
`Timestamp`	`getTimestamp(String columnLabel)` Retrieves the value of the indicated column in the current row as a Timestamp object.
`Timestamp`	`getTimestamp(String columnLabel, Calendar cal)` Retrieves the value of the indicated column in the current row as a Timestamp object.
`boolean`	`isAfterLast()` Retrieves whether the cursor is after the last row of this RowSet.
`boolean`	`isBeforeFirst()` Retrieves whether the cursor is after the first row of this RowSet.
`boolean`	`isFirst()` Retrieves whether the cursor is on the first row of this RowSet.
`boolean`	`isLast()` Retrieves whether the cursor is on the last row of this RowSet.
`boolean`	`last()` Moves the cursor to the last row of this RowSet.
`boolean`	`next()` Moves the cursor to the next row.
`boolean`	`previous()` Moves the cursor to the previous row.
`boolean`	`relative(int rows)` Moves the cursor a relative number f rows, either positive or negative.
`boolean`	`wasNull()` Reports whether the last column read had a value of SQL `NULL`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ResultSetWrappingSqlRowSet

public ResultSetWrappingSqlRowSet(ResultSet resultSet)
                           throws InvalidResultSetAccessException

Create a new ResultSetWrappingSqlRowSet for the given ResultSet.

Parameters:: resultSet - a disconnected ResultSet to wrap (usually a javax.sql.rowset.CachedRowSet)
Throws:: InvalidResultSetAccessException - if extracting the ResultSetMetaData failed
See Also:: CachedRowSet, ResultSet.getMetaData(), ResultSetWrappingSqlRowSetMetaData

Method Detail

getResultSet

public final ResultSet getResultSet()

Return the underlying ResultSet (usually a javax.sql.rowset.CachedRowSet).

See Also:: CachedRowSet