org.hibernate.internal

Class ScrollableResultsImpl

java.lang.Object

org.hibernate.internal.AbstractScrollableResults

org.hibernate.internal.ScrollableResultsImpl

All Implemented Interfaces:

Closeable, AutoCloseable, ScrollableResults

public class ScrollableResultsImpl
extends AbstractScrollableResults
implements ScrollableResults

Standard ScrollableResults implementation.

Author:

Gavin King

Constructor Summary

Constructors

Constructor and Description
ScrollableResultsImpl(ResultSet rs, PreparedStatement ps, SessionImplementor sess, Loader loader, QueryParameters queryParameters, Type[] types, HolderInstantiator holderInstantiator) Constructs a ScrollableResultsImpl using the specified information.

Method Summary

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.
protected JDBCException	convert(SQLException sqle, String message)
boolean	first() Go to the first result.
protected Object[]	getCurrentRow()
int	getRowNumber() Get the current position in the 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 i) Scroll the specified number of positions from the current position.
boolean	setRowNumber(int rowNumber) Set the current position in the result set.

Methods inherited from class org.hibernate.internal.AbstractScrollableResults

afterScrollOperation, close, get, get, getBigDecimal, getBigInteger, getBinary, getBlob, getBoolean, getByte, getCalendar, getCharacter, getClob, getDate, getDouble, getFinal, getFloat, getHolderInstantiator, getInteger, getLoader, getLocale, getLong, getNonFinal, getPs, getQueryParameters, getResultSet, getSession, getShort, getString, getText, getTimeZone, getType, getTypes

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

close, get, get, getBigDecimal, getBigInteger, getBinary, getBlob, getBoolean, getByte, getCalendar, getCharacter, getClob, getDate, getDouble, getFloat, getInteger, getLocale, getLong, getShort, getString, getText, getTimeZone, getType

Constructor Detail

ScrollableResultsImpl

public ScrollableResultsImpl(ResultSet rs,
                             PreparedStatement ps,
                             SessionImplementor sess,
                             Loader loader,
                             QueryParameters queryParameters,
                             Type[] types,
                             HolderInstantiator holderInstantiator)

Constructs a ScrollableResultsImpl using the specified information.

Parameters:

rs - The scrollable result set

ps - The prepared statement used to obtain the result set

sess - The originating session

loader - The loader

queryParameters - query parameters

types - The result types

holderInstantiator - Ugh

Method Detail

getCurrentRow

protected Object[] getCurrentRow()

Specified by:

getCurrentRow in class AbstractScrollableResults

scroll

public boolean scroll(int i)

Description copied from interface: ScrollableResults

Scroll the specified number of positions from the current position.

Specified by:

scroll in interface ScrollableResults

Parameters:

i - a positive (forward) or negative (backward) number of rows

Returns:

true if there is a result at the new location

convert

protected JDBCException convert(SQLException sqle,
                                String message)

first

public boolean first()

Description copied from interface: ScrollableResults

Go to the first result.

Specified by:

first in interface ScrollableResults

Returns:

true if there are any results

last

public boolean last()

Description copied from interface: ScrollableResults

Go to the last result.

Specified by:

last in interface ScrollableResults

Returns:

true if there are any results

next

public boolean next()

Description copied from interface: ScrollableResults

Advance to the next result.

Specified by:

next in interface ScrollableResults

Returns:

true if there is another result

previous

public boolean previous()

Description copied from interface: ScrollableResults

Retreat to the previous result.

Specified by:

previous in interface ScrollableResults

Returns:

true if there is a previous result

afterLast

public void afterLast()

Description copied from interface: ScrollableResults

Go to a location just after the last result.

Specified by:

afterLast in interface ScrollableResults

beforeFirst

public void beforeFirst()

Description copied from interface: ScrollableResults

Go to a location just before first result, This is the location of the cursor on a newly returned scrollable result.

Specified by:

beforeFirst in interface ScrollableResults

isFirst

public boolean isFirst()

Description copied from interface: ScrollableResults

Is this the first result?

Specified by:

isFirst in interface ScrollableResults

Returns:

true if this is the first row of results, otherwise false

isLast

public boolean isLast()

Description copied from interface: ScrollableResults

Is this the last result?

Specified by:

isLast in interface ScrollableResults

Returns:

true if this is the last row of results.

getRowNumber

public int getRowNumber()
                 throws HibernateException

Description copied from interface: ScrollableResults

Get the current position in the results. The first position is number 0 (unlike JDBC).

Specified by:

getRowNumber in interface ScrollableResults

Returns:

The current position number, numbered from 0; -1 indicates that there is no current row

Throws:

HibernateException

setRowNumber

public boolean setRowNumber(int rowNumber)
                     throws HibernateException

Description copied from interface: ScrollableResults

Set the current position in the result set. Can be numbered from the first position (positive number) or the last row (negative number).

Specified by:

setRowNumber in interface ScrollableResults

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

Throws:

HibernateException