public interface

SqlRowSet

implements Serializable
org.springframework.jdbc.support.rowset.SqlRowSet
Known Indirect Subclasses

Class Overview

Mirror interface for javax.sql.RowSet, representing disconnected java.sql.ResultSet data.

The main difference to the standard JDBC RowSet is that an SQLException is never thrown here. This allows a SqlRowSet to be used without having to deal with checked exceptions. A SqlRowSet will throw Spring's org.springframework.jdbc.InvalidResultSetAccessException instead (when appropriate).

Note: This interface extends the java.io.Serializable marker interface. Implementations, which typically hold disconnected data, are encouraged to be actually serializable (as far as possible).

Summary

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

Public Methods

public abstract boolean absolute (int row)

Moves the cursor to the given row number in the RowSet, just after the last row.

Parameters
row the number of the row where the cursor should move
Returns
  • true if the cursor is on the RowSet, false otherwise
See Also

public abstract void afterLast ()

Moves the cursor to the end of this RowSet.

See Also

public abstract void beforeFirst ()

Moves the cursor to the front of this RowSet, just before the first row.

See Also

public abstract int findColumn (String columnLabel)

Maps the given column label to its column index.

Parameters
columnLabel the name of the column
Returns
  • the column index for the given column label

public abstract boolean first ()

Moves the cursor to the first row of this RowSet.

Returns
  • true if the cursor is on a valid row, false otherwise
See Also

public abstract BigDecimal getBigDecimal (int columnIndex)

Retrieves the value of the indicated column in the current row as an BigDecimal object.

Parameters
columnIndex the column index
Returns
  • an BigDecimal object representing the column value

public abstract BigDecimal getBigDecimal (String columnLabel)

Retrieves the value of the indicated column in the current row as an BigDecimal object.

Parameters
columnLabel the column label
Returns
  • an BigDecimal object representing the column value

public abstract boolean getBoolean (int columnIndex)

Retrieves the value of the indicated column in the current row as a boolean.

Parameters
columnIndex the column index
Returns
  • a boolean representing the column value
See Also

public abstract boolean getBoolean (String columnLabel)

Retrieves the value of the indicated column in the current row as a boolean.

Parameters
columnLabel the column label
Returns
  • a boolean representing the column value

public abstract byte getByte (String columnLabel)

Retrieves the value of the indicated column in the current row as a byte.

Parameters
columnLabel the column label
Returns
  • a byte representing the column value

public abstract byte getByte (int columnIndex)

Retrieves the value of the indicated column in the current row as a byte.

Parameters
columnIndex the column index
Returns
  • a byte representing the column value
See Also

public abstract Date getDate (int columnIndex, Calendar cal)

Retrieves the value of the indicated column in the current row as a Date object.

Parameters
columnIndex the column index
cal the Calendar to use in constructing the Date
Returns
  • a Date object representing the column value

public abstract Date getDate (int columnIndex)

Retrieves the value of the indicated column in the current row as a Date object.

Parameters
columnIndex the column index
Returns
  • a Date object representing the column value
See Also

public abstract Date getDate (String columnLabel, Calendar cal)

Retrieves the value of the indicated column in the current row as a Date object.

Parameters
columnLabel the column label
cal the Calendar to use in constructing the Date
Returns
  • a Date object representing the column value

public abstract Date getDate (String columnLabel)

Retrieves the value of the indicated column in the current row as a Date object.

Parameters
columnLabel the column label
Returns
  • a Date object representing the column value

public abstract double getDouble (String columnLabel)

Retrieves the value of the indicated column in the current row as a Double object.

Parameters
columnLabel the column label
Returns
  • a Double object representing the column value

public abstract double getDouble (int columnIndex)

Retrieves the value of the indicated column in the current row as a Double object.

Parameters
columnIndex the column index
Returns
  • a Double object representing the column value
See Also

public abstract float getFloat (int columnIndex)

Retrieves the value of the indicated column in the current row as a float.

Parameters
columnIndex the column index
Returns
  • a float representing the column value
See Also

public abstract float getFloat (String columnLabel)

Retrieves the value of the indicated column in the current row as a float.

Parameters
columnLabel the column label
Returns
  • a float representing the column value

public abstract int getInt (String columnLabel)

Retrieves the value of the indicated column in the current row as an int.

Parameters
columnLabel the column label
Returns
  • an int representing the column value

public abstract int getInt (int columnIndex)

Retrieves the value of the indicated column in the current row as an int.

Parameters
columnIndex the column index
Returns
  • an int representing the column value
See Also

public abstract long getLong (String columnLabel)

Retrieves the value of the indicated column in the current row as a long.

Parameters
columnLabel the column label
Returns
  • a long representing the column value

public abstract long getLong (int columnIndex)

Retrieves the value of the indicated column in the current row as a long.

Parameters
columnIndex the column index
Returns
  • a long representing the column value
See Also

public abstract SqlRowSetMetaData getMetaData ()

Retrieves the meta data (number, types and properties for the columns) of this row set.

Returns
  • a corresponding SqlRowSetMetaData instance
See Also

public abstract Object getObject (int columnIndex, Map<StringClass<?>> map)

Retrieves the value of the indicated column in the current row as an Object.

Parameters
columnIndex the column index
map a Map object containing the mapping from SQL types to Java types
Returns
  • a Object representing the column value

public abstract Object getObject (String columnLabel)

Retrieves the value of the indicated column in the current row as an Object.

Parameters
columnLabel the column label
Returns
  • a Object representing the column value

public abstract Object getObject (String columnLabel, Map<StringClass<?>> map)

Retrieves the value of the indicated column in the current row as an Object.

Parameters
columnLabel the column label
map a Map object containing the mapping from SQL types to Java types
Returns
  • a Object representing the column value

public abstract Object getObject (int columnIndex)

Retrieves the value of the indicated column in the current row as an Object.

Parameters
columnIndex the column index
Returns
  • a Object representing the column value
See Also

public abstract int getRow ()

Retrieves the current row number.

Returns
  • the current row number
See Also

public abstract short getShort (int columnIndex)

Retrieves the value of the indicated column in the current row as a short.

Parameters
columnIndex the column index
Returns
  • a short representing the column value
See Also

public abstract short getShort (String columnLabel)

Retrieves the value of the indicated column in the current row as a short.

Parameters
columnLabel the column label
Returns
  • a short representing the column value

public abstract String getString (int columnIndex)

Retrieves the value of the indicated column in the current row as a String.

Parameters
columnIndex the column index
Returns
  • a String representing the column value
See Also

public abstract String getString (String columnLabel)

Retrieves the value of the indicated column in the current row as a String.

Parameters
columnLabel the column label
Returns
  • a String representing the column value

public abstract Time getTime (String columnLabel)

Retrieves the value of the indicated column in the current row as a Time object.

Parameters
columnLabel the column label
Returns
  • a Time object representing the column value

public abstract Time getTime (int columnIndex, Calendar cal)

Retrieves the value of the indicated column in the current row as a Time object.

Parameters
columnIndex the column index
cal the Calendar to use in constructing the Date
Returns
  • a Time object representing the column value

public abstract Time getTime (int columnIndex)

Retrieves the value of the indicated column in the current row as a Time object.

Parameters
columnIndex the column index
Returns
  • a Time object representing the column value
See Also

public abstract Time getTime (String columnLabel, Calendar cal)

Retrieves the value of the indicated column in the current row as a Time object.

Parameters
columnLabel the column label
cal the Calendar to use in constructing the Date
Returns
  • a Time object representing the column value

public abstract Timestamp getTimestamp (String columnLabel)

Retrieves the value of the indicated column in the current row as a Timestamp object.

Parameters
columnLabel the column label
Returns
  • a Timestamp object representing the column value

public abstract Timestamp getTimestamp (String columnLabel, Calendar cal)

Retrieves the value of the indicated column in the current row as a Timestamp object.

Parameters
columnLabel the column label
cal the Calendar to use in constructing the Date
Returns
  • a Timestamp object representing the column value

public abstract Timestamp getTimestamp (int columnIndex, Calendar cal)

Retrieves the value of the indicated column in the current row as a Timestamp object.

Parameters
columnIndex the column index
cal the Calendar to use in constructing the Date
Returns
  • a Timestamp object representing the column value

public abstract Timestamp getTimestamp (int columnIndex)

Retrieves the value of the indicated column in the current row as a Timestamp object.

Parameters
columnIndex the column index
Returns
  • a Timestamp object representing the column value

public abstract boolean isAfterLast ()

Retrieves whether the cursor is after the last row of this RowSet.

Returns
  • true if the cursor is after the last row, false otherwise
See Also

public abstract boolean isBeforeFirst ()

Retrieves whether the cursor is after the first row of this RowSet.

Returns
  • true if the cursor is after the first row, false otherwise
See Also

public abstract boolean isFirst ()

Retrieves whether the cursor is on the first row of this RowSet.

Returns
  • true if the cursor is after the first row, false otherwise
See Also

public abstract boolean isLast ()

Retrieves whether the cursor is on the last row of this RowSet.

Returns
  • true if the cursor is after the last row, false otherwise
See Also

public abstract boolean last ()

Moves the cursor to the last row of this RowSet.

Returns
  • true if the cursor is on a valid row, false otherwise
See Also

public abstract boolean next ()

Moves the cursor to the next row.

Returns
  • true if the new row is valid, false if there are no more rows
See Also

public abstract boolean previous ()

Moves the cursor to the previous row.

Returns
  • true if the new row is valid, false if it is off the RowSet
See Also

public abstract boolean relative (int rows)

Moves the cursor a relative number f rows, either positive or negative.

Returns
  • true if the cursor is on a row, false otherwise
See Also

public abstract boolean wasNull ()

Reports whether the last column read had a value of SQL NULL. Note that you must first call one of the getter methods and then call the wasNull method.

Returns
  • true if the most recent coumn retrieved was SQL NULL, false otherwise
See Also