com.goldencode.p2j.persist

Class ScrollingResults

java.lang.Object

com.goldencode.p2j.persist.ScrollingResults

All Implemented Interfaces:

Results

final class ScrollingResults
extends java.lang.Object
implements Results

A simple, scrolling implementation of the Results interface, which offers a thin layer around the internal, ScrollableResults object provided by the query.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	closed Track closed state of the results.
private static CentralLogger	LOG Logger
private Persistence	persistence Persistence object which provided the underlying ScrollableResults
private Persistence.Context	persistenceContext The Persistence context.
private ScrollableResults<java.lang.Object>	results Scrollable result set; primary keys or Records

Constructor Summary

Constructors

Constructor and Description
ScrollingResults(Persistence persistence, ScrollableResults<java.lang.Object> results) Construct an instance of this object from a scrollable result set provided by query execution.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Close the wrapped ScrollableResults object.
boolean	first() Move cursor to the first result row.
java.lang.Object[]	get() Get the array of objects at the current result row.
java.lang.Object[]	get(boolean forceOnlyId) Get the array of objects at the current result row when forceOnlyId is false.
java.lang.Object	get(int column) Get the object at the current result row, at the specified column.
java.lang.Long	getID(int column) Get the primary key ID at the current result row, at the specified column.
int	getRowNumber() Get the row number currently under the cursor.
boolean	isFirst() Is the cursor on the first row in the result set?
boolean	isLast() Is the cursor on the last row in the result set?
boolean	last() Move cursor to the last result row.
boolean	next() Move cursor to the next result row.
boolean	previous() Move cursor to the previous result row.
void	reset() Reset the cursor to its natural starting position, before the first result row.
boolean	scroll(int rows) Scroll the cursor ahead by the specified number of rows.
void	sessionClosing() Invoked when the current Hibernate session is about to close.
boolean	setRowNumber(int row) Set the row number currently under the cursor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.persist.Results

addRow, deleteRow, getNumberOfLoadedRows, isAutoFetch, isResultSetCached

Field Detail

LOG

private static final CentralLogger LOG

Logger

results

private final ScrollableResults<java.lang.Object> results

Scrollable result set; primary keys or Records

persistence

private final Persistence persistence

Persistence object which provided the underlying ScrollableResults

persistenceContext

private final Persistence.Context persistenceContext

The Persistence context. Only used at cleanup time when the getter is not accessible any more.

closed

private boolean closed

Track closed state of the results.

Constructor Detail

ScrollingResults

ScrollingResults(Persistence persistence,
                 ScrollableResults<java.lang.Object> results)
          throws PersistenceException

Construct an instance of this object from a scrollable result set provided by query execution.

Parameters:

persistence - The associated persistence service object.

results - Scrollable result set generated by the query.

Throws:

PersistenceException

Method Detail

first

public boolean first()

Move cursor to the first result row.

Specified by:

first in interface Results

Returns:

true if there are any results.

last

public boolean last()

Move cursor to the last result row.

Specified by:

last in interface Results

Returns:

true if there are any results.

next

public boolean next()

Move cursor to the next result row.

Specified by:

next in interface Results

Returns:

true if there is a result under the cursor under the move.

previous

public boolean previous()

Move cursor to the previous result row.

Specified by:

previous in interface Results

Returns:

true if there is a result under the cursor under the move.

isFirst

public boolean isFirst()

Is the cursor on the first row in the result set?

Specified by:

isFirst in interface Results

Returns:

true if the cursor is on the first row.

isLast

public boolean isLast()

Is the cursor on the last row in the result set?

Specified by:

isLast in interface Results

Returns:

true if the cursor is on the first row.

get

public java.lang.Object[] get()

Get the array of objects at the current result row.

Specified by:

get in interface Results

Returns:

Object array or null.

get

public java.lang.Object[] get(boolean forceOnlyId)

Get the array of objects at the current result row when forceOnlyId is false. Get the array of primary keys of the objects at the current result row when forceOnlyId is true.

Specified by:

get in interface Results

Parameters:

forceOnlyId - Indicates whether it's only the primary keys that must be returned, or all data found is returned.

Returns:

Object array or null.

get

public java.lang.Object get(int column)

Get the object at the current result row, at the specified column.

Specified by:

get in interface Results

Parameters:

column - Zero-based index column of the desired object.

Returns:

Object at column or null.

getID

public java.lang.Long getID(int column)

Get the primary key ID at the current result row, at the specified column.

Specified by:

getID in interface Results

Parameters:

column - Zero-based index column of the desired ID.

Returns:

ID of the record or null.

getRowNumber

public int getRowNumber()

Get the row number currently under the cursor.

Specified by:

getRowNumber in interface Results

Returns:

Zero-based index of the current row, or -1 if the cursor is not currently on a result.

setRowNumber

public boolean setRowNumber(int row)

Set the row number currently under the cursor.

Specified by:

setRowNumber in interface Results

Parameters:

row - Zero-based index of the row to be set as the current row.

Returns:

true if there is a row at the specified row number; else false.

scroll

public boolean scroll(int rows)

Scroll the cursor ahead by the specified number of rows. If the number is negative, the cursor is moved backward. This may put the cursor off the end (either end) of the query's results.

Specified by:

scroll in interface Results

Parameters:

rows - Number of rows to jump ahead or back.

Returns:

true if there is a row at the new location; else false.

reset

public void reset()

Reset the cursor to its natural starting position, before the first result row.

Specified by:

reset in interface Results

sessionClosing

public void sessionClosing()

Invoked when the current Hibernate session is about to close. Gives the implementation an opportunity to perform appropriate processing in response to this event.

Specified by:

sessionClosing in interface Results

cleanup

public void cleanup()

Close the wrapped ScrollableResults object.

Specified by:

cleanup in interface Results