ScrollableResults (Hibernate JavaDocs)

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ScrollableResultsImplementor
```
public interface ScrollableResults
extends AutoCloseable, Closeable
```
A result iterator that allows moving around within the results by arbitrary increments. The Query / ScrollableResults pattern is very similar to the JDBC PreparedStatement/ ResultSet pattern and the semantics of methods of this interface are similar to the similarly named methods on ResultSet.

Contrary to JDBC, columns of results are numbered from zero.

See Also:

Query.scroll()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`afterLast()` Go to a location just after the last result.
`void`	`beforeFirst()` Go to a location just before first result, This is the location of the cursor on a newly returned scrollable result.
`void`	`close()` Release resources immediately.
`boolean`	`first()` Go to the first result.
`Object[]`	`get()` Get the current row of results.
`Object`	`get(int i)` Get the `i`th object in the current row of results, without initializing any other results in the row.
`BigDecimal`	`getBigDecimal(int col)` Convenience method to read a BigDecimal.
`BigInteger`	`getBigInteger(int col)` Convenience method to read a BigInteger.
`byte[]`	`getBinary(int col)` Convenience method to read a binary (byte[]).
`Blob`	`getBlob(int col)` Convenience method to read a blob.
`Boolean`	`getBoolean(int col)` Convenience method to read a boolean.
`Byte`	`getByte(int col)` Convenience method to read a byte.
`Calendar`	`getCalendar(int col)` Convenience method to read a Calendar.
`Character`	`getCharacter(int col)` Convenience method to read a char.
`Clob`	`getClob(int col)` Convenience method to read a clob.
`Date`	`getDate(int col)` Convenience method to read a Date.
`Double`	`getDouble(int col)` Convenience method to read a double.
`Float`	`getFloat(int col)` Convenience method to read a float.
`Integer`	`getInteger(int col)` Convenience method to read an integer.
`Locale`	`getLocale(int col)` Convenience method to read a Locale.
`Long`	`getLong(int col)` Convenience method to read a long.
`int`	`getRowNumber()` Get the current position in the results.
`Short`	`getShort(int col)` Convenience method to read a short.
`String`	`getString(int col)` Convenience method to read a string.
`String`	`getText(int col)` Convenience method to read a String using streaming.
`TimeZone`	`getTimeZone(int col)` Convenience method to read a TimeZone.
`Type`	`getType(int i)` Get the type of the `i`th column of results.
`boolean`	`isFirst()` Is this the first result?
`boolean`	`isLast()` Is this the last result?
`boolean`	`last()` Go to the last result.
`boolean`	`next()` Advance to the next result.
`boolean`	`previous()` Retreat to the previous result.
`boolean`	`scroll(int positions)` Scroll the specified number of positions from the current position.
`boolean`	`setRowNumber(int rowNumber)` Set the current position in the result set.

- Method Detail
  - close
```
void close()
```
    Release resources immediately.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - next
```
boolean next()
```
    Advance to the next result.
    
    Returns:
    
    true if there is another result
  - previous
```
boolean previous()
```
    Retreat to the previous result.
    
    Returns:
    
    true if there is a previous result
  - scroll
```
boolean scroll(int positions)
```
    Scroll the specified number of positions from the current position.
    
    Parameters:
    
    positions - a positive (forward) or negative (backward) number of rows
    
    Returns:
    
    true if there is a result at the new location
  - last
```
boolean last()
```
    Go to the last result.
    
    Returns:
    
    true if there are any results
  - first
```
boolean first()
```
    Go to the first result.
    
    Returns:
    
    true if there are any results
  - beforeFirst
```
void beforeFirst()
```
    Go to a location just before first result, This is the location of the cursor on a newly returned scrollable result.
  - afterLast
```
void afterLast()
```
    Go to a location just after the last result.
  - isFirst
```
boolean isFirst()
```
    Is this the first result?
    
    Returns:
    
    true if this is the first row of results, otherwise false
  - isLast
```
boolean isLast()
```
    Is this the last result?
    
    Returns:
    
    true if this is the last row of results.
  - getRowNumber
```
int getRowNumber()
```
    Get the current position in the results. The first position is number 0 (unlike JDBC).
    
    Returns:
    
    The current position number, numbered from 0; -1 indicates that there is no current row
  - setRowNumber
```
boolean setRowNumber(int rowNumber)
```
    Set the current position in the result set. Can be numbered from the first position (positive number) or the last row (negative number).
    
    Parameters:
    
    rowNumber - the row number. A positive number indicates a value numbered from the first row; a negative number indicates a value numbered from the last row.
    
    Returns:
    
    true if there is a row at that row number
  - get
```
Object[] get()
```
    Get the current row of results.
    
    Returns:
    
    The array of results
  - get
```
Object get(int i)
```
    Get the ith object in the current row of results, without initializing any other results in the row. This method may be used safely, regardless of the type of the column (ie. even for scalar results).
    
    Parameters:
    
    i - the column, numbered from zero
    
    Returns:
    
    The requested result object; may return null
    
    Throws:
    
    IndexOutOfBoundsException - If i is an invalid index.
  - getType
```
Type getType(int i)
```
    Get the type of the ith column of results.
    
    Parameters:
    
    i - the column, numbered from zero
    
    Returns:
    
    the Hibernate type
    
    Throws:
    
    IndexOutOfBoundsException - If i is an invalid index.
  - getInteger
```
Integer getInteger(int col)
```
    Convenience method to read an integer.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as an integer
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getLong
```
Long getLong(int col)
```
    Convenience method to read a long.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a long
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getFloat
```
Float getFloat(int col)
```
    Convenience method to read a float.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a float
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getBoolean
```
Boolean getBoolean(int col)
```
    Convenience method to read a boolean.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a boolean
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getDouble
```
Double getDouble(int col)
```
    Convenience method to read a double.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a double
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getShort
```
Short getShort(int col)
```
    Convenience method to read a short.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a short
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getByte
```
Byte getByte(int col)
```
    Convenience method to read a byte.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a byte
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getCharacter
```
Character getCharacter(int col)
```
    Convenience method to read a char.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a char
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getBinary
```
byte[] getBinary(int col)
```
    Convenience method to read a binary (byte[]).
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a binary (byte[])
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getText
```
String getText(int col)
```
    Convenience method to read a String using streaming.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a String
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getBlob
```
Blob getBlob(int col)
```
    Convenience method to read a blob.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Blob
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getClob
```
Clob getClob(int col)
```
    Convenience method to read a clob.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Clob
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getString
```
String getString(int col)
```
    Convenience method to read a string.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a String
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getBigDecimal
```
BigDecimal getBigDecimal(int col)
```
    Convenience method to read a BigDecimal.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a BigDecimal
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getBigInteger
```
BigInteger getBigInteger(int col)
```
    Convenience method to read a BigInteger.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a BigInteger
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getDate
```
Date getDate(int col)
```
    Convenience method to read a Date.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Date
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getLocale
```
Locale getLocale(int col)
```
    Convenience method to read a Locale.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Locale
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getCalendar
```
Calendar getCalendar(int col)
```
    Convenience method to read a Calendar.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Calendar
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.
  - getTimeZone
```
TimeZone getTimeZone(int col)
```
    Convenience method to read a TimeZone.
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a TimeZone
    
    Throws:
    
    IndexOutOfBoundsException - If col is an invalid index.

Interface ScrollableResults

Method Summary

Method Detail

close

next

previous

scroll

last

first

beforeFirst

afterLast

isFirst

isLast

getRowNumber

setRowNumber

get

get

getType

getInteger

getLong

getFloat

getBoolean

getDouble

getShort

getByte

getCharacter

getBinary

getText

getBlob

getClob

getString

getBigDecimal

getBigInteger

getDate

getLocale

getCalendar

getTimeZone