AbstractScrollableResults (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

java.lang.Object
- org.hibernate.internal.AbstractScrollableResults

All Implemented Interfaces:

Closeable, AutoCloseable, ScrollableResultsImplementor, ScrollableResults

Direct Known Subclasses:

FetchingScrollableResultsImpl, ScrollableResultsImpl
```
public abstract class AbstractScrollableResults
extends Object
implements ScrollableResultsImplementor
```
Base implementation of the ScrollableResults interface.

Author:

Steve Ebersole

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractScrollableResults(ResultSet rs, PreparedStatement ps, SharedSessionContractImplementor sess, Loader loader, QueryParameters queryParameters, Type[] types, HolderInstantiator holderInstantiator)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`afterScrollOperation()`
`void`	`close()` Release resources immediately.
`Object[]`	`get()` Get the current row of results.
`Object`	`get(int col)` 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.
`protected abstract Object[]`	`getCurrentRow()`
`Date`	`getDate(int col)` Convenience method to read a Date.
`Double`	`getDouble(int col)` Convenience method to read a double.
`protected Object`	`getFinal(int col, Type returnType)` Check that the requested type is compatible with the result type, and return the column value.
`Float`	`getFloat(int col)` Convenience method to read a float.
`protected HolderInstantiator`	`getHolderInstantiator()`
`Integer`	`getInteger(int col)` Convenience method to read an integer.
`protected Loader`	`getLoader()`
`Locale`	`getLocale(int col)` Convenience method to read a Locale.
`Long`	`getLong(int col)` Convenience method to read a long.
`protected Object`	`getNonFinal(int col, Type returnType)` Check that the requested type is compatible with the result type, and return the column value.
`int`	`getNumberOfTypes()`
`protected PreparedStatement`	`getPs()`
`protected QueryParameters`	`getQueryParameters()`
`protected ResultSet`	`getResultSet()`
`protected SharedSessionContractImplementor`	`getSession()`
`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.
`protected Type[]`	`getTypes()`
`boolean`	`isClosed()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.ScrollableResults
afterLast, beforeFirst, first, getRowNumber, isFirst, isLast, last, next, previous, scroll, setRowNumber

- Constructor Detail
  - AbstractScrollableResults
```
protected AbstractScrollableResults(ResultSet rs,
                                    PreparedStatement ps,
                                    SharedSessionContractImplementor sess,
                                    Loader loader,
                                    QueryParameters queryParameters,
                                    Type[] types,
                                    HolderInstantiator holderInstantiator)
```
- Method Detail
  - getCurrentRow
```
protected abstract Object[] getCurrentRow()
```
  - getResultSet
```
protected ResultSet getResultSet()
```
  - getPs
```
protected PreparedStatement getPs()
```
  - getSession
```
protected SharedSessionContractImplementor getSession()
```
  - getLoader
```
protected Loader getLoader()
```
  - getQueryParameters
```
protected QueryParameters getQueryParameters()
```
  - getTypes
```
protected Type[] getTypes()
```
  - getHolderInstantiator
```
protected HolderInstantiator getHolderInstantiator()
```
  - close
```
public final void close()
```
    Description copied from interface: ScrollableResults
    
    Release resources immediately.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface ScrollableResults
  - isClosed
```
public boolean isClosed()
```
    Specified by:
    
    isClosed in interface ScrollableResultsImplementor
  - getNumberOfTypes
```
public int getNumberOfTypes()
```
    Specified by:
    
    getNumberOfTypes in interface ScrollableResultsImplementor
  - get
```
public final Object[] get()
                   throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Get the current row of results.
    
    Specified by:
    
    get in interface ScrollableResults
    
    Returns:
    
    The array of results
    
    Throws:
    
    HibernateException
  - get
```
public final Object get(int col)
                 throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    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).
    
    Specified by:
    
    get in interface ScrollableResults
    
    Parameters:
    
    col - the column, numbered from zero
    
    Returns:
    
    The requested result object; may return null
    
    Throws:
    
    HibernateException
  - getFinal
```
protected final Object getFinal(int col,
                                Type returnType)
                         throws HibernateException
```
    Check that the requested type is compatible with the result type, and return the column value. This version makes sure the the classes are identical.
    
    Parameters:
    
    col - the column
    
    returnType - a "final" type
    
    Throws:
    
    HibernateException
  - getNonFinal
```
protected final Object getNonFinal(int col,
                                   Type returnType)
                            throws HibernateException
```
    Check that the requested type is compatible with the result type, and return the column value. This version makes sure the the classes are "assignable".
    
    Parameters:
    
    col - the column
    
    returnType - any type
    
    Throws:
    
    HibernateException
  - getBigDecimal
```
public final BigDecimal getBigDecimal(int col)
                               throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a BigDecimal.
    
    Specified by:
    
    getBigDecimal in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a BigDecimal
    
    Throws:
    
    HibernateException
  - getBigInteger
```
public final BigInteger getBigInteger(int col)
                               throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a BigInteger.
    
    Specified by:
    
    getBigInteger in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a BigInteger
    
    Throws:
    
    HibernateException
  - getBinary
```
public final byte[] getBinary(int col)
                       throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a binary (byte[]).
    
    Specified by:
    
    getBinary in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a binary (byte[])
    
    Throws:
    
    HibernateException
  - getText
```
public final String getText(int col)
                     throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a String using streaming.
    
    Specified by:
    
    getText in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a String
    
    Throws:
    
    HibernateException
  - getBlob
```
public final Blob getBlob(int col)
                   throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a blob.
    
    Specified by:
    
    getBlob in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Blob
    
    Throws:
    
    HibernateException
  - getClob
```
public final Clob getClob(int col)
                   throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a clob.
    
    Specified by:
    
    getClob in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Clob
    
    Throws:
    
    HibernateException
  - getBoolean
```
public final Boolean getBoolean(int col)
                         throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a boolean.
    
    Specified by:
    
    getBoolean in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a boolean
    
    Throws:
    
    HibernateException
  - getByte
```
public final Byte getByte(int col)
                   throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a byte.
    
    Specified by:
    
    getByte in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a byte
    
    Throws:
    
    HibernateException
  - getCharacter
```
public final Character getCharacter(int col)
                             throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a char.
    
    Specified by:
    
    getCharacter in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a char
    
    Throws:
    
    HibernateException
  - getDate
```
public final Date getDate(int col)
                   throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a Date.
    
    Specified by:
    
    getDate in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Date
    
    Throws:
    
    HibernateException
  - getCalendar
```
public final Calendar getCalendar(int col)
                           throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a Calendar.
    
    Specified by:
    
    getCalendar in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Calendar
    
    Throws:
    
    HibernateException
  - getDouble
```
public final Double getDouble(int col)
                       throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a double.
    
    Specified by:
    
    getDouble in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a double
    
    Throws:
    
    HibernateException
  - getFloat
```
public final Float getFloat(int col)
                     throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a float.
    
    Specified by:
    
    getFloat in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a float
    
    Throws:
    
    HibernateException
  - getInteger
```
public final Integer getInteger(int col)
                         throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read an integer.
    
    Specified by:
    
    getInteger in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as an integer
    
    Throws:
    
    HibernateException
  - getLong
```
public final Long getLong(int col)
                   throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a long.
    
    Specified by:
    
    getLong in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a long
    
    Throws:
    
    HibernateException
  - getShort
```
public final Short getShort(int col)
                     throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a short.
    
    Specified by:
    
    getShort in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a short
    
    Throws:
    
    HibernateException
  - getString
```
public final String getString(int col)
                       throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a string.
    
    Specified by:
    
    getString in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a String
    
    Throws:
    
    HibernateException
  - getLocale
```
public final Locale getLocale(int col)
                       throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a Locale.
    
    Specified by:
    
    getLocale in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a Locale
    
    Throws:
    
    HibernateException
  - getTimeZone
```
public final TimeZone getTimeZone(int col)
                           throws HibernateException
```
    Description copied from interface: ScrollableResults
    
    Convenience method to read a TimeZone.
    
    Specified by:
    
    getTimeZone in interface ScrollableResults
    
    Parameters:
    
    col - The column, numbered from zero
    
    Returns:
    
    The column value as a TimeZone
    
    Throws:
    
    HibernateException
  - getType
```
public final Type getType(int i)
```
    Description copied from interface: ScrollableResults
    
    Get the type of the ith column of results.
    
    Specified by:
    
    getType in interface ScrollableResults
    
    Parameters:
    
    i - the column, numbered from zero
    
    Returns:
    
    the Hibernate type
  - afterScrollOperation
```
protected void afterScrollOperation()
```

Class AbstractScrollableResults

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.ScrollableResults

Constructor Detail

AbstractScrollableResults

Method Detail

getCurrentRow

getResultSet

getPs

getSession

getLoader

getQueryParameters

getTypes

getHolderInstantiator

close

isClosed

getNumberOfTypes

get

get

getFinal

getNonFinal

getBigDecimal

getBigInteger

getBinary

getText

getBlob

getClob

getBoolean

getByte

getCharacter

getDate

getCalendar

getDouble

getFloat

getInteger

getLong

getShort

getString

getLocale

getTimeZone

getType

afterScrollOperation