Interface SqlRowSet
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
ResultSetWrappingSqlRowSet
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 an SqlRowSet to be used without having to deal with
checked exceptions. An 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).
- Since:
- 1.2
- Author:
- Thomas Risberg, Juergen Hoeller
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
absolute
(int row) Move the cursor to the given row number in the row set, just after the last row.void
Move the cursor to the end of this row set.void
Move the cursor to the front of this row set, just before the first row.int
findColumn
(String columnLabel) Map the given column label to its column index.boolean
first()
Move the cursor to the first row of this row set.getBigDecimal
(int columnIndex) Retrieve the value of the indicated column in the current row as a BigDecimal object.getBigDecimal
(String columnLabel) Retrieve the value of the indicated column in the current row as a BigDecimal object.boolean
getBoolean
(int columnIndex) Retrieve the value of the indicated column in the current row as a boolean.boolean
getBoolean
(String columnLabel) Retrieve the value of the indicated column in the current row as a boolean.byte
getByte
(int columnIndex) Retrieve the value of the indicated column in the current row as a byte.byte
Retrieve the value of the indicated column in the current row as a byte.getDate
(int columnIndex) Retrieve the value of the indicated column in the current row as a Date object.Retrieve the value of the indicated column in the current row as a Date object.Retrieve the value of the indicated column in the current row as a Date object.Retrieve the value of the indicated column in the current row as a Date object.double
getDouble
(int columnIndex) Retrieve the value of the indicated column in the current row as a Double object.double
Retrieve the value of the indicated column in the current row as a Double object.float
getFloat
(int columnIndex) Retrieve the value of the indicated column in the current row as a float.float
Retrieve the value of the indicated column in the current row as a float.int
getInt
(int columnIndex) Retrieve the value of the indicated column in the current row as an int.int
Retrieve the value of the indicated column in the current row as an int.long
getLong
(int columnIndex) Retrieve the value of the indicated column in the current row as a long.long
Retrieve the value of the indicated column in the current row as a long.Retrieve the meta-data, i.e.getNString
(int columnIndex) Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).getNString
(String columnLabel) Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).getObject
(int columnIndex) Retrieve the value of the indicated column in the current row as an Object.<T> T
Retrieve the value of the indicated column in the current row as an Object.Retrieve the value of the indicated column in the current row as an Object.Retrieve the value of the indicated column in the current row as an Object.<T> T
Retrieve the value of the indicated column in the current row as an Object.Retrieve the value of the indicated column in the current row as an Object.int
getRow()
Retrieve the current row number.short
getShort
(int columnIndex) Retrieve the value of the indicated column in the current row as a short.short
Retrieve the value of the indicated column in the current row as a short.getString
(int columnIndex) Retrieve the value of the indicated column in the current row as a String.Retrieve the value of the indicated column in the current row as a String.getTime
(int columnIndex) Retrieve the value of the indicated column in the current row as a Time object.Retrieve the value of the indicated column in the current row as a Time object.Retrieve the value of the indicated column in the current row as a Time object.Retrieve the value of the indicated column in the current row as a Time object.getTimestamp
(int columnIndex) Retrieve the value of the indicated column in the current row as a Timestamp object.getTimestamp
(int columnIndex, Calendar cal) Retrieve the value of the indicated column in the current row as a Timestamp object.getTimestamp
(String columnLabel) Retrieve the value of the indicated column in the current row as a Timestamp object.getTimestamp
(String columnLabel, Calendar cal) Retrieve the value of the indicated column in the current row as a Timestamp object.boolean
Retrieve whether the cursor is after the last row of this row set.boolean
Retrieve whether the cursor is before the first row of this row set.boolean
isFirst()
Retrieve whether the cursor is on the first row of this row set.boolean
isLast()
Retrieve whether the cursor is on the last row of this row set.boolean
last()
Move the cursor to the last row of this row set.boolean
next()
Move the cursor to the next row.boolean
previous()
Move the cursor to the previous row.boolean
relative
(int rows) Move the cursor a relative number of rows, either positive or negative.boolean
wasNull()
Report whether the last column read had a value of SQLNULL
.
-
Method Details
-
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:
-
findColumn
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:
-
getBigDecimal
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:
-
getBigDecimal
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:
-
getBoolean
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:
-
getBoolean
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:
-
getByte
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:
-
getByte
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:
-
getDate
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:
-
getDate
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:
-
getDate
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:
-
getDate
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:
-
getDouble
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:
-
getDouble
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:
-
getFloat
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:
-
getFloat
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:
-
getInt
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:
-
getInt
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:
-
getLong
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:
-
getLong
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:
-
getNString
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:
-
getNString
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:
-
getObject
Retrieve the value of the indicated column in the current row as an Object.- Parameters:
columnIndex
- the column index- Returns:
- an Object representing the column value
- Throws:
InvalidResultSetAccessException
- See Also:
-
getObject
Retrieve the value of the indicated column in the current row as an Object.- Parameters:
columnLabel
- the column label- Returns:
- an Object representing the column value
- Throws:
InvalidResultSetAccessException
- See Also:
-
getObject
@Nullable Object getObject(int columnIndex, Map<String, Class<?>> map) throws InvalidResultSetAccessExceptionRetrieve 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:
- an Object representing the column value
- Throws:
InvalidResultSetAccessException
- See Also:
-
getObject
@Nullable Object getObject(String columnLabel, Map<String, Class<?>> map) throws InvalidResultSetAccessExceptionRetrieve 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:
- an Object representing the column value
- Throws:
InvalidResultSetAccessException
- See Also:
-
getObject
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:
- an Object representing the column value
- Throws:
InvalidResultSetAccessException
- Since:
- 4.1.3
- See Also:
-
getObject
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:
- an Object representing the column value
- Throws:
InvalidResultSetAccessException
- Since:
- 4.1.3
- See Also:
-
getShort
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:
-
getShort
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:
-
getString
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:
-
getString
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:
-
getTime
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:
-
getTime
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:
-
getTime
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:
-
getTime
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:
-
getTimestamp
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:
-
getTimestamp
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:
-
getTimestamp
@Nullable 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:
-
getTimestamp
@Nullable 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:
-
absolute
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:
true
if the cursor is on the row set,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
afterLast
Move the cursor to the end of this row set.- Throws:
InvalidResultSetAccessException
- See Also:
-
beforeFirst
Move the cursor to the front of this row set, just before the first row.- Throws:
InvalidResultSetAccessException
- See Also:
-
first
Move the cursor to the first row of this row set.- Returns:
true
if the cursor is on a valid row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
getRow
Retrieve the current row number.- Returns:
- the current row number
- Throws:
InvalidResultSetAccessException
- See Also:
-
isAfterLast
Retrieve whether the cursor is after the last row of this row set.- Returns:
true
if the cursor is after the last row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
isBeforeFirst
Retrieve whether the cursor is before the first row of this row set.- Returns:
true
if the cursor is before the first row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
isFirst
Retrieve whether the cursor is on the first row of this row set.- Returns:
true
if the cursor is after the first row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
isLast
Retrieve whether the cursor is on the last row of this row set.- Returns:
true
if the cursor is after the last row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
last
Move the cursor to the last row of this row set.- Returns:
true
if the cursor is on a valid row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
next
Move the cursor to the next row.- Returns:
true
if the new row is valid,false
if there are no more rows- Throws:
InvalidResultSetAccessException
- See Also:
-
previous
Move the cursor to the previous row.- Returns:
true
if the new row is valid,false
if it is off the row set- Throws:
InvalidResultSetAccessException
- See Also:
-
relative
Move the cursor a relative number of rows, either positive or negative.- Returns:
true
if the cursor is on a row,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-
wasNull
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:
true
if the most recent column retrieved was SQLNULL
,false
otherwise- Throws:
InvalidResultSetAccessException
- See Also:
-