/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.jdbc.support.rowset;

import java.io.Serializable;
import java.math.BigDecimal;
import java.sql.Date;
import java.sql.Time;
import java.sql.Timestamp;
import java.util.Calendar;
import java.util.Map;

import org.springframework.jdbc.InvalidResultSetAccessException;

Mirror interface for RowSet, representing a disconnected variant of ResultSet data.

The main difference to the standard JDBC RowSet is that a 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 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).

Author:Thomas Risberg, Juergen Hoeller
See Also:
Since:1.2
/** * Mirror interface for {@link javax.sql.RowSet}, representing a disconnected variant of * {@link java.sql.ResultSet} data. * * <p>The main difference to the standard JDBC RowSet is that a {@link java.sql.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 {@link InvalidResultSetAccessException} * instead (when appropriate). * * <p>Note: This interface extends the {@code java.io.Serializable} marker interface. * Implementations, which typically hold disconnected data, are encouraged to be actually * serializable (as far as possible). * * @author Thomas Risberg * @author Juergen Hoeller * @since 1.2 * @see javax.sql.RowSet * @see java.sql.ResultSet * @see org.springframework.jdbc.InvalidResultSetAccessException * @see org.springframework.jdbc.core.JdbcTemplate#queryForRowSet */
public interface SqlRowSet extends Serializable {
Retrieve the meta-data, i.e. number, types and properties for the columns of this row set.
See Also:
Returns:a corresponding SqlRowSetMetaData instance
/** * Retrieve the meta-data, i.e. number, types and properties * for the columns of this row set. * @return a corresponding SqlRowSetMetaData instance * @see java.sql.ResultSet#getMetaData() */
SqlRowSetMetaData getMetaData();
Map the given column label to its column index.
Params:
  • columnLabel – the name of the column
See Also:
Returns:the column index for the given column label
/** * Map the given column label to its column index. * @param columnLabel the name of the column * @return the column index for the given column label * @see java.sql.ResultSet#findColumn(String) */
int findColumn(String columnLabel) throws InvalidResultSetAccessException; // RowSet methods for extracting data values
Retrieve the value of the indicated column in the current row as a BigDecimal object.
Params:
  • columnIndex – the column index
See Also:
Returns:an BigDecimal object representing the column value
/** * Retrieve the value of the indicated column in the current row as a BigDecimal object. * @param columnIndex the column index * @return an BigDecimal object representing the column value * @see java.sql.ResultSet#getBigDecimal(int) */
BigDecimal getBigDecimal(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a BigDecimal object.
Params:
  • columnLabel – the column label
See Also:
Returns:an BigDecimal object representing the column value
/** * Retrieve the value of the indicated column in the current row as a BigDecimal object. * @param columnLabel the column label * @return an BigDecimal object representing the column value * @see java.sql.ResultSet#getBigDecimal(String) */
BigDecimal getBigDecimal(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a boolean.
Params:
  • columnIndex – the column index
See Also:
Returns:a boolean representing the column value
/** * Retrieve the value of the indicated column in the current row as a boolean. * @param columnIndex the column index * @return a boolean representing the column value * @see java.sql.ResultSet#getBoolean(int) */
boolean getBoolean(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a boolean.
Params:
  • columnLabel – the column label
See Also:
Returns:a boolean representing the column value
/** * Retrieve the value of the indicated column in the current row as a boolean. * @param columnLabel the column label * @return a boolean representing the column value * @see java.sql.ResultSet#getBoolean(String) */
boolean getBoolean(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a byte.
Params:
  • columnIndex – the column index
See Also:
Returns:a byte representing the column value
/** * Retrieve the value of the indicated column in the current row as a byte. * @param columnIndex the column index * @return a byte representing the column value * @see java.sql.ResultSet#getByte(int) */
byte getByte(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a byte.
Params:
  • columnLabel – the column label
See Also:
Returns:a byte representing the column value
/** * Retrieve the value of the indicated column in the current row as a byte. * @param columnLabel the column label * @return a byte representing the column value * @see java.sql.ResultSet#getByte(String) */
byte getByte(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Date object.
Params:
  • columnIndex – the column index
See Also:
Returns:a Date object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Date object. * @param columnIndex the column index * @return a Date object representing the column value * @see java.sql.ResultSet#getDate(int) */
Date getDate(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Date object.
Params:
  • columnLabel – the column label
See Also:
Returns:a Date object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Date object. * @param columnLabel the column label * @return a Date object representing the column value * @see java.sql.ResultSet#getDate(String) */
Date getDate(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Date object.
Params:
  • columnIndex – the column index
  • cal – the Calendar to use in constructing the Date
See Also:
Returns:a Date object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Date object. * @param columnIndex the column index * @param cal the Calendar to use in constructing the Date * @return a Date object representing the column value * @see java.sql.ResultSet#getDate(int, Calendar) */
Date getDate(int columnIndex, Calendar cal) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Date object.
Params:
  • columnLabel – the column label
  • cal – the Calendar to use in constructing the Date
See Also:
Returns:a Date object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Date object. * @param columnLabel the column label * @param cal the Calendar to use in constructing the Date * @return a Date object representing the column value * @see java.sql.ResultSet#getDate(String, Calendar) */
Date getDate(String columnLabel, Calendar cal) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Double object.
Params:
  • columnIndex – the column index
See Also:
Returns:a Double object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Double object. * @param columnIndex the column index * @return a Double object representing the column value * @see java.sql.ResultSet#getDouble(int) */
double getDouble(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Double object.
Params:
  • columnLabel – the column label
See Also:
Returns:a Double object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Double object. * @param columnLabel the column label * @return a Double object representing the column value * @see java.sql.ResultSet#getDouble(String) */
double getDouble(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a float.
Params:
  • columnIndex – the column index
See Also:
Returns:a float representing the column value
/** * Retrieve the value of the indicated column in the current row as a float. * @param columnIndex the column index * @return a float representing the column value * @see java.sql.ResultSet#getFloat(int) */
float getFloat(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a float.
Params:
  • columnLabel – the column label
See Also:
Returns:a float representing the column value
/** * Retrieve the value of the indicated column in the current row as a float. * @param columnLabel the column label * @return a float representing the column value * @see java.sql.ResultSet#getFloat(String) */
float getFloat(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an int.
Params:
  • columnIndex – the column index
See Also:
Returns:an int representing the column value
/** * Retrieve the value of the indicated column in the current row as an int. * @param columnIndex the column index * @return an int representing the column value * @see java.sql.ResultSet#getInt(int) */
int getInt(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an int.
Params:
  • columnLabel – the column label
See Also:
Returns:an int representing the column value
/** * Retrieve the value of the indicated column in the current row as an int. * @param columnLabel the column label * @return an int representing the column value * @see java.sql.ResultSet#getInt(String) */
int getInt(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a long.
Params:
  • columnIndex – the column index
See Also:
Returns:a long representing the column value
/** * Retrieve the value of the indicated column in the current row as a long. * @param columnIndex the column index * @return a long representing the column value * @see java.sql.ResultSet#getLong(int) */
long getLong(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a long.
Params:
  • columnLabel – the column label
See Also:
Returns:a long representing the column value
/** * Retrieve the value of the indicated column in the current row as a long. * @param columnLabel the column label * @return a long representing the column value * @see java.sql.ResultSet#getLong(String) */
long getLong(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).
Params:
  • columnIndex – the column index
See Also:
Returns:a String representing the column value
Since:4.1.3
/** * Retrieve the value of the indicated column in the current row as a String * (for NCHAR, NVARCHAR, LONGNVARCHAR columns). * @param columnIndex the column index * @return a String representing the column value * @since 4.1.3 * @see java.sql.ResultSet#getNString(int) */
String getNString(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).
Params:
  • columnLabel – the column label
See Also:
Returns:a String representing the column value
Since:4.1.3
/** * Retrieve the value of the indicated column in the current row as a String * (for NCHAR, NVARCHAR, LONGNVARCHAR columns). * @param columnLabel the column label * @return a String representing the column value * @since 4.1.3 * @see java.sql.ResultSet#getNString(String) */
String getNString(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an Object.
Params:
  • columnIndex – the column index
See Also:
Returns:a Object representing the column value
/** * Retrieve the value of the indicated column in the current row as an Object. * @param columnIndex the column index * @return a Object representing the column value * @see java.sql.ResultSet#getObject(int) */
Object getObject(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an Object.
Params:
  • columnLabel – the column label
See Also:
Returns:a Object representing the column value
/** * Retrieve the value of the indicated column in the current row as an Object. * @param columnLabel the column label * @return a Object representing the column value * @see java.sql.ResultSet#getObject(String) */
Object getObject(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an Object.
Params:
  • columnIndex – the column index
  • map – a Map object containing the mapping from SQL types to Java types
See Also:
Returns:a Object representing the column value
/** * Retrieve the value of the indicated column in the current row as an Object. * @param columnIndex the column index * @param map a Map object containing the mapping from SQL types to Java types * @return a Object representing the column value * @see java.sql.ResultSet#getObject(int, Map) */
Object getObject(int columnIndex, Map<String, Class<?>> map) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an Object.
Params:
  • columnLabel – the column label
  • map – a Map object containing the mapping from SQL types to Java types
See Also:
Returns:a Object representing the column value
/** * Retrieve the value of the indicated column in the current row as an Object. * @param columnLabel the column label * @param map a Map object containing the mapping from SQL types to Java types * @return a Object representing the column value * @see java.sql.ResultSet#getObject(String, Map) */
Object getObject(String columnLabel, Map<String, Class<?>> map) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an Object.
Params:
  • columnIndex – the column index
  • type – the Java type to convert the designated column to
See Also:
Returns:a Object representing the column value
Since:4.1.3
/** * Retrieve the value of the indicated column in the current row as an Object. * @param columnIndex the column index * @param type the Java type to convert the designated column to * @return a Object representing the column value * @see java.sql.ResultSet#getObject(int) * @since 4.1.3 */
<T> T getObject(int columnIndex, Class<T> type) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as an Object.
Params:
  • columnLabel – the column label
  • type – the Java type to convert the designated column to
See Also:
Returns:a Object representing the column value
Since:4.1.3
/** * Retrieve the value of the indicated column in the current row as an Object. * @param columnLabel the column label * @param type the Java type to convert the designated column to * @return a Object representing the column value * @see java.sql.ResultSet#getObject(int) * @since 4.1.3 */
<T> T getObject(String columnLabel, Class<T> type) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a short.
Params:
  • columnIndex – the column index
See Also:
Returns:a short representing the column value
/** * Retrieve the value of the indicated column in the current row as a short. * @param columnIndex the column index * @return a short representing the column value * @see java.sql.ResultSet#getShort(int) */
short getShort(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a short.
Params:
  • columnLabel – the column label
See Also:
Returns:a short representing the column value
/** * Retrieve the value of the indicated column in the current row as a short. * @param columnLabel the column label * @return a short representing the column value * @see java.sql.ResultSet#getShort(String) */
short getShort(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a String.
Params:
  • columnIndex – the column index
See Also:
Returns:a String representing the column value
/** * Retrieve the value of the indicated column in the current row as a String. * @param columnIndex the column index * @return a String representing the column value * @see java.sql.ResultSet#getString(int) */
String getString(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a String.
Params:
  • columnLabel – the column label
See Also:
Returns:a String representing the column value
/** * Retrieve the value of the indicated column in the current row as a String. * @param columnLabel the column label * @return a String representing the column value * @see java.sql.ResultSet#getString(String) */
String getString(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Time object.
Params:
  • columnIndex – the column index
See Also:
Returns:a Time object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Time object. * @param columnIndex the column index * @return a Time object representing the column value * @see java.sql.ResultSet#getTime(int) */
Time getTime(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Time object.
Params:
  • columnLabel – the column label
See Also:
Returns:a Time object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Time object. * @param columnLabel the column label * @return a Time object representing the column value * @see java.sql.ResultSet#getTime(String) */
Time getTime(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Time object.
Params:
  • columnIndex – the column index
  • cal – the Calendar to use in constructing the Date
See Also:
Returns:a Time object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Time object. * @param columnIndex the column index * @param cal the Calendar to use in constructing the Date * @return a Time object representing the column value * @see java.sql.ResultSet#getTime(int, Calendar) */
Time getTime(int columnIndex, Calendar cal) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Time object.
Params:
  • columnLabel – the column label
  • cal – the Calendar to use in constructing the Date
See Also:
Returns:a Time object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Time object. * @param columnLabel the column label * @param cal the Calendar to use in constructing the Date * @return a Time object representing the column value * @see java.sql.ResultSet#getTime(String, Calendar) */
Time getTime(String columnLabel, Calendar cal) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Timestamp object.
Params:
  • columnIndex – the column index
See Also:
Returns:a Timestamp object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Timestamp object. * @param columnIndex the column index * @return a Timestamp object representing the column value * @see java.sql.ResultSet#getTimestamp(int) */
Timestamp getTimestamp(int columnIndex) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Timestamp object.
Params:
  • columnLabel – the column label
See Also:
Returns:a Timestamp object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Timestamp object. * @param columnLabel the column label * @return a Timestamp object representing the column value * @see java.sql.ResultSet#getTimestamp(String) */
Timestamp getTimestamp(String columnLabel) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Timestamp object.
Params:
  • columnIndex – the column index
  • cal – the Calendar to use in constructing the Date
See Also:
Returns:a Timestamp object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Timestamp object. * @param columnIndex the column index * @param cal the Calendar to use in constructing the Date * @return a Timestamp object representing the column value * @see java.sql.ResultSet#getTimestamp(int, Calendar) */
Timestamp getTimestamp(int columnIndex, Calendar cal) throws InvalidResultSetAccessException;
Retrieve the value of the indicated column in the current row as a Timestamp object.
Params:
  • columnLabel – the column label
  • cal – the Calendar to use in constructing the Date
See Also:
Returns:a Timestamp object representing the column value
/** * Retrieve the value of the indicated column in the current row as a Timestamp object. * @param columnLabel the column label * @param cal the Calendar to use in constructing the Date * @return a Timestamp object representing the column value * @see java.sql.ResultSet#getTimestamp(String, Calendar) */
Timestamp getTimestamp(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; // RowSet navigation methods
Move the cursor to the given row number in the row set, just after the last row.
Params:
  • row – the number of the row where the cursor should move
See Also:
Returns:true if the cursor is on the row set, false otherwise
/** * Move the cursor to the given row number in the row set, just after the last row. * @param row the number of the row where the cursor should move * @return {@code true} if the cursor is on the row set, {@code false} otherwise * @see java.sql.ResultSet#absolute(int) */
boolean absolute(int row) throws InvalidResultSetAccessException;
Move the cursor to the end of this row set.
See Also:
  • afterLast.afterLast()
/** * Move the cursor to the end of this row set. * @see java.sql.ResultSet#afterLast() */
void afterLast() throws InvalidResultSetAccessException;
Move the cursor to the front of this row set, just before the first row.
See Also:
  • beforeFirst.beforeFirst()
/** * Move the cursor to the front of this row set, just before the first row. * @see java.sql.ResultSet#beforeFirst() */
void beforeFirst() throws InvalidResultSetAccessException;
Move the cursor to the first row of this row set.
See Also:
Returns:true if the cursor is on a valid row, false otherwise
/** * Move the cursor to the first row of this row set. * @return {@code true} if the cursor is on a valid row, {@code false} otherwise * @see java.sql.ResultSet#first() */
boolean first() throws InvalidResultSetAccessException;
Retrieve the current row number.
See Also:
Returns:the current row number
/** * Retrieve the current row number. * @return the current row number * @see java.sql.ResultSet#getRow() */
int getRow() throws InvalidResultSetAccessException;
Retrieve whether the cursor is after the last row of this row set.
See Also:
Returns:true if the cursor is after the last row, false otherwise
/** * Retrieve whether the cursor is after the last row of this row set. * @return {@code true} if the cursor is after the last row, {@code false} otherwise * @see java.sql.ResultSet#isAfterLast() */
boolean isAfterLast() throws InvalidResultSetAccessException;
Retrieve whether the cursor is before the first row of this row set.
See Also:
Returns:true if the cursor is before the first row, false otherwise
/** * Retrieve whether the cursor is before the first row of this row set. * @return {@code true} if the cursor is before the first row, {@code false} otherwise * @see java.sql.ResultSet#isBeforeFirst() */
boolean isBeforeFirst() throws InvalidResultSetAccessException;
Retrieve whether the cursor is on the first row of this row set.
See Also:
Returns:true if the cursor is after the first row, false otherwise
/** * Retrieve whether the cursor is on the first row of this row set. * @return {@code true} if the cursor is after the first row, {@code false} otherwise * @see java.sql.ResultSet#isFirst() */
boolean isFirst() throws InvalidResultSetAccessException;
Retrieve whether the cursor is on the last row of this row set.
See Also:
Returns:true if the cursor is after the last row, false otherwise
/** * Retrieve whether the cursor is on the last row of this row set. * @return {@code true} if the cursor is after the last row, {@code false} otherwise * @see java.sql.ResultSet#isLast() */
boolean isLast() throws InvalidResultSetAccessException;
Move the cursor to the last row of this row set.
See Also:
Returns:true if the cursor is on a valid row, false otherwise
/** * Move the cursor to the last row of this row set. * @return {@code true} if the cursor is on a valid row, {@code false} otherwise * @see java.sql.ResultSet#last() */
boolean last() throws InvalidResultSetAccessException;
Move the cursor to the next row.
See Also:
Returns:true if the new row is valid, false if there are no more rows
/** * Move the cursor to the next row. * @return {@code true} if the new row is valid, {@code false} if there are no more rows * @see java.sql.ResultSet#next() */
boolean next() throws InvalidResultSetAccessException;
Move the cursor to the previous row.
See Also:
Returns:true if the new row is valid, false if it is off the row set
/** * Move the cursor to the previous row. * @return {@code true} if the new row is valid, {@code false} if it is off the row set * @see java.sql.ResultSet#previous() */
boolean previous() throws InvalidResultSetAccessException;
Move the cursor a relative number of rows, either positive or negative.
See Also:
Returns:true if the cursor is on a row, false otherwise
/** * Move the cursor a relative number of rows, either positive or negative. * @return {@code true} if the cursor is on a row, {@code false} otherwise * @see java.sql.ResultSet#relative(int) */
boolean relative(int rows) throws InvalidResultSetAccessException;
Report 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.

See Also:
Returns:true if the most recent column retrieved was SQL NULL, false otherwise
/** * Report whether the last column read had a value of SQL {@code NULL}. * <p>Note that you must first call one of the getter methods and then * call the {@code wasNull()} method. * @return {@code true} if the most recent column retrieved was * SQL {@code NULL}, {@code false} otherwise * @see java.sql.ResultSet#wasNull() */
boolean wasNull() throws InvalidResultSetAccessException; }