Interface SqlRowSet
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
ResultSetWrappingSqlRowSet
public interface SqlRowSet extends Serializable
Mirror interface forRowSet, representing a disconnected variant ofResultSetdata.The main difference to the standard JDBC RowSet is that a
SQLExceptionis never thrown here. This allows a SqlRowSet to be used without having to deal with checked exceptions. A SqlRowSet will throw Spring'sInvalidResultSetAccessExceptioninstead (when appropriate).Note: This interface extends the
java.io.Serializablemarker interface. Implementations, which typically hold disconnected data, are encouraged to be actually serializable (as far as possible).- Since:
- 1.2
- Author:
- Thomas Risberg, Juergen Hoeller
- See Also:
RowSet,ResultSet,InvalidResultSetAccessException,JdbcTemplate.queryForRowSet(java.lang.String)
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanabsolute(int row)Move the cursor to the given row number in the row set, just after the last row.voidafterLast()Move the cursor to the end of this row set.voidbeforeFirst()Move the cursor to the front of this row set, just before the first row.intfindColumn(String columnLabel)Map the given column label to its column index.booleanfirst()Move the cursor to the first row of this row set.BigDecimalgetBigDecimal(int columnIndex)Retrieve the value of the indicated column in the current row as a BigDecimal object.BigDecimalgetBigDecimal(String columnLabel)Retrieve the value of the indicated column in the current row as a BigDecimal object.booleangetBoolean(int columnIndex)Retrieve the value of the indicated column in the current row as a boolean.booleangetBoolean(String columnLabel)Retrieve the value of the indicated column in the current row as a boolean.bytegetByte(int columnIndex)Retrieve the value of the indicated column in the current row as a byte.bytegetByte(String columnLabel)Retrieve the value of the indicated column in the current row as a byte.DategetDate(int columnIndex)Retrieve the value of the indicated column in the current row as a Date object.DategetDate(int columnIndex, Calendar cal)Retrieve the value of the indicated column in the current row as a Date object.DategetDate(String columnLabel)Retrieve the value of the indicated column in the current row as a Date object.DategetDate(String columnLabel, Calendar cal)Retrieve the value of the indicated column in the current row as a Date object.doublegetDouble(int columnIndex)Retrieve the value of the indicated column in the current row as a Double object.doublegetDouble(String columnLabel)Retrieve the value of the indicated column in the current row as a Double object.floatgetFloat(int columnIndex)Retrieve the value of the indicated column in the current row as a float.floatgetFloat(String columnLabel)Retrieve the value of the indicated column in the current row as a float.intgetInt(int columnIndex)Retrieve the value of the indicated column in the current row as an int.intgetInt(String columnLabel)Retrieve the value of the indicated column in the current row as an int.longgetLong(int columnIndex)Retrieve the value of the indicated column in the current row as a long.longgetLong(String columnLabel)Retrieve the value of the indicated column in the current row as a long.SqlRowSetMetaDatagetMetaData()Retrieve the meta-data, i.e.StringgetNString(int columnIndex)Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).StringgetNString(String columnLabel)Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).ObjectgetObject(int columnIndex)Retrieve the value of the indicated column in the current row as an Object.<T> TgetObject(int columnIndex, Class<T> type)Retrieve the value of the indicated column in the current row as an Object.ObjectgetObject(int columnIndex, Map<String,Class<?>> map)Retrieve the value of the indicated column in the current row as an Object.ObjectgetObject(String columnLabel)Retrieve the value of the indicated column in the current row as an Object.<T> TgetObject(String columnLabel, Class<T> type)Retrieve the value of the indicated column in the current row as an Object.ObjectgetObject(String columnLabel, Map<String,Class<?>> map)Retrieve the value of the indicated column in the current row as an Object.intgetRow()Retrieve the current row number.shortgetShort(int columnIndex)Retrieve the value of the indicated column in the current row as a short.shortgetShort(String columnLabel)Retrieve the value of the indicated column in the current row as a short.StringgetString(int columnIndex)Retrieve the value of the indicated column in the current row as a String.StringgetString(String columnLabel)Retrieve the value of the indicated column in the current row as a String.TimegetTime(int columnIndex)Retrieve the value of the indicated column in the current row as a Time object.TimegetTime(int columnIndex, Calendar cal)Retrieve the value of the indicated column in the current row as a Time object.TimegetTime(String columnLabel)Retrieve the value of the indicated column in the current row as a Time object.TimegetTime(String columnLabel, Calendar cal)Retrieve the value of the indicated column in the current row as a Time object.TimestampgetTimestamp(int columnIndex)Retrieve the value of the indicated column in the current row as a Timestamp object.TimestampgetTimestamp(int columnIndex, Calendar cal)Retrieve the value of the indicated column in the current row as a Timestamp object.TimestampgetTimestamp(String columnLabel)Retrieve the value of the indicated column in the current row as a Timestamp object.TimestampgetTimestamp(String columnLabel, Calendar cal)Retrieve the value of the indicated column in the current row as a Timestamp object.booleanisAfterLast()Retrieve whether the cursor is after the last row of this row set.booleanisBeforeFirst()Retrieve whether the cursor is before the first row of this row set.booleanisFirst()Retrieve whether the cursor is on the first row of this row set.booleanisLast()Retrieve whether the cursor is on the last row of this row set.booleanlast()Move the cursor to the last row of this row set.booleannext()Move the cursor to the next row.booleanprevious()Move the cursor to the previous row.booleanrelative(int rows)Move the cursor a relative number of rows, either positive or negative.booleanwasNull()Report whether the last column read had a value of SQLNULL.
Method Detail
getMetaData
SqlRowSetMetaData getMetaData()
Retrieve the meta-data, i.e. number, types and properties for the columns of this row set.- Returns:
- a corresponding SqlRowSetMetaData instance
- See Also:
ResultSet.getMetaData()
findColumn
int findColumn(String columnLabel) throws InvalidResultSetAccessException
Map the given column label to its column index.- Parameters:
columnLabel- the name of the column- Returns:
- the column index for the given column label
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.findColumn(String)
getBigDecimal
BigDecimal getBigDecimal(int columnIndex) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a BigDecimal object.- Parameters:
columnIndex- the column index- Returns:
- an BigDecimal object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getBigDecimal(int)
getBigDecimal
BigDecimal getBigDecimal(String columnLabel) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a BigDecimal object.- Parameters:
columnLabel- the column label- Returns:
- an BigDecimal object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getBigDecimal(String)
getBoolean
boolean getBoolean(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getBoolean(int)
getBoolean
boolean getBoolean(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getBoolean(String)
getByte
byte getByte(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getByte(int)
getByte
byte getByte(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getByte(String)
getDate
Date getDate(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getDate(int)
getDate
Date getDate(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getDate(String)
getDate
Date getDate(int columnIndex, Calendar cal) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a Date object.- Parameters:
columnIndex- the column indexcal- the Calendar to use in constructing the Date- Returns:
- a Date object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getDate(int, Calendar)
getDate
Date getDate(String columnLabel, Calendar cal) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a Date object.- Parameters:
columnLabel- the column labelcal- the Calendar to use in constructing the Date- Returns:
- a Date object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getDate(String, Calendar)
getDouble
double getDouble(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getDouble(int)
getDouble
double getDouble(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getDouble(String)
getFloat
float getFloat(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getFloat(int)
getFloat
float getFloat(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getFloat(String)
getInt
int getInt(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getInt(int)
getInt
int getInt(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getInt(String)
getLong
long getLong(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getLong(int)
getLong
long getLong(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getLong(String)
getNString
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).- Parameters:
columnIndex- the column index- Returns:
- a String representing the column value
- Throws:
InvalidResultSetAccessException- Since:
- 4.1.3
- See Also:
ResultSet.getNString(int)
getNString
String getNString(String columnLabel) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).- Parameters:
columnLabel- the column label- Returns:
- a String representing the column value
- Throws:
InvalidResultSetAccessException- Since:
- 4.1.3
- See Also:
ResultSet.getNString(String)
getObject
Object getObject(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getObject(int)
getObject
Object getObject(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getObject(String)
getObject
Object getObject(int columnIndex, Map<String,Class<?>> map) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as an Object.- Parameters:
columnIndex- the column indexmap- a Map object containing the mapping from SQL types to Java types- Returns:
- a Object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getObject(int, Map)
getObject
Object getObject(String columnLabel, Map<String,Class<?>> map) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as an Object.- Parameters:
columnLabel- the column labelmap- a Map object containing the mapping from SQL types to Java types- Returns:
- a Object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getObject(String, Map)
getObject
<T> T getObject(int columnIndex, Class<T> type) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as an Object.- Parameters:
columnIndex- the column indextype- the Java type to convert the designated column to- Returns:
- a Object representing the column value
- Throws:
InvalidResultSetAccessException- Since:
- 4.1.3
- See Also:
ResultSet.getObject(int, Class)
getObject
<T> T getObject(String columnLabel, Class<T> type) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as an Object.- Parameters:
columnLabel- the column labeltype- the Java type to convert the designated column to- Returns:
- a Object representing the column value
- Throws:
InvalidResultSetAccessException- Since:
- 4.1.3
- See Also:
ResultSet.getObject(String, Class)
getShort
short getShort(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getShort(int)
getShort
short getShort(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getShort(String)
getString
String getString(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getString(int)
getString
String getString(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getString(String)
getTime
Time getTime(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTime(int)
getTime
Time getTime(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTime(String)
getTime
Time getTime(int columnIndex, Calendar cal) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a Time object.- Parameters:
columnIndex- the column indexcal- the Calendar to use in constructing the Date- Returns:
- a Time object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTime(int, Calendar)
getTime
Time getTime(String columnLabel, Calendar cal) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a Time object.- Parameters:
columnLabel- the column labelcal- the Calendar to use in constructing the Date- Returns:
- a Time object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTime(String, Calendar)
getTimestamp
Timestamp getTimestamp(int columnIndex) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTimestamp(int)
getTimestamp
Timestamp getTimestamp(String columnLabel) throws InvalidResultSetAccessException
Retrieve 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
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTimestamp(String)
getTimestamp
Timestamp getTimestamp(int columnIndex, Calendar cal) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a Timestamp object.- Parameters:
columnIndex- the column indexcal- the Calendar to use in constructing the Date- Returns:
- a Timestamp object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTimestamp(int, Calendar)
getTimestamp
Timestamp getTimestamp(String columnLabel, Calendar cal) throws InvalidResultSetAccessException
Retrieve the value of the indicated column in the current row as a Timestamp object.- Parameters:
columnLabel- the column labelcal- the Calendar to use in constructing the Date- Returns:
- a Timestamp object representing the column value
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getTimestamp(String, Calendar)
absolute
boolean absolute(int row) throws InvalidResultSetAccessException
Move the cursor to the given row number in the row set, just after the last row.- Parameters:
row- the number of the row where the cursor should move- Returns:
trueif the cursor is on the row set,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.absolute(int)
afterLast
void afterLast() throws InvalidResultSetAccessException
Move the cursor to the end of this row set.- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.afterLast()
beforeFirst
void beforeFirst() throws InvalidResultSetAccessException
Move the cursor to the front of this row set, just before the first row.- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.beforeFirst()
first
boolean first() throws InvalidResultSetAccessException
Move the cursor to the first row of this row set.- Returns:
trueif the cursor is on a valid row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.first()
getRow
int getRow() throws InvalidResultSetAccessException
Retrieve the current row number.- Returns:
- the current row number
- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.getRow()
isAfterLast
boolean isAfterLast() throws InvalidResultSetAccessException
Retrieve whether the cursor is after the last row of this row set.- Returns:
trueif the cursor is after the last row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.isAfterLast()
isBeforeFirst
boolean isBeforeFirst() throws InvalidResultSetAccessException
Retrieve whether the cursor is before the first row of this row set.- Returns:
trueif the cursor is before the first row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.isBeforeFirst()
isFirst
boolean isFirst() throws InvalidResultSetAccessException
Retrieve whether the cursor is on the first row of this row set.- Returns:
trueif the cursor is after the first row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.isFirst()
isLast
boolean isLast() throws InvalidResultSetAccessException
Retrieve whether the cursor is on the last row of this row set.- Returns:
trueif the cursor is after the last row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.isLast()
last
boolean last() throws InvalidResultSetAccessException
Move the cursor to the last row of this row set.- Returns:
trueif the cursor is on a valid row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.last()
next
boolean next() throws InvalidResultSetAccessException
Move the cursor to the next row.- Returns:
trueif the new row is valid,falseif there are no more rows- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.next()
previous
boolean previous() throws InvalidResultSetAccessException
Move the cursor to the previous row.- Returns:
trueif the new row is valid,falseif it is off the row set- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.previous()
relative
boolean relative(int rows) throws InvalidResultSetAccessException
Move the cursor a relative number of rows, either positive or negative.- Returns:
trueif the cursor is on a row,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.relative(int)
wasNull
boolean wasNull() throws InvalidResultSetAccessException
Report whether the last column read had a value of SQLNULL.Note that you must first call one of the getter methods and then call the
wasNull()method.- Returns:
trueif the most recent column retrieved was SQLNULL,falseotherwise- Throws:
InvalidResultSetAccessException- See Also:
ResultSet.wasNull()