com.goldencode.p2j.persist

Class PreselectQuery.TemplateResults

java.lang.Object

com.goldencode.p2j.persist.PreselectQuery.TemplateResults

All Implemented Interfaces:

Results

Enclosing class:

PreselectQuery

private static class PreselectQuery.TemplateResults
extends java.lang.Object
implements Results

Special Results implementation for template records. Since a query on rowid/recid will return only a single row, this class is built around its Long rowid and provide fast access for a PreselectQuery aware of this query type to iterate on this single-row result.

Field Summary

Fields

Modifier and Type	Field and Description
private int	cursor The position of the cursor.
private java.lang.Long	templateRowid The id of the template record to be loaded.

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

LOG

Constructor Summary

Constructors

Constructor and Description
TemplateResults(java.lang.Long templateRowid) The constructor.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Clean up and release any resources which this object is holding, such as open result sets.
boolean	first() Move cursor to the first results row.
java.lang.Object[]	get() Get the array of objects at the current result row.
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 results set?
boolean	isLast() Is the cursor on the last row in the results set?
boolean	last() Move cursor to the last results row.
boolean	next() Move cursor to the next results row.
private void	normalize() Internal worker that keeps the correctness of cursor position: always in one of the positions: -1 = before the first record, 0 = the only record is selected, +1, after the last record.
boolean	previous() Move cursor to the previous results 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, get, getNumberOfLoadedRows, isAutoFetch, isResultSetCached

Field Detail

templateRowid

private final java.lang.Long templateRowid

The id of the template record to be loaded.

cursor

private int cursor

The position of the cursor. This set of results always contain a single record, at position 0. The natural starting position is -1, before the first row. The value 1 is just after the last row. The class will maintain one of these three states.

Constructor Detail

TemplateResults

public TemplateResults(java.lang.Long templateRowid)

The constructor. Builds a Results specific to a template rowid.

Parameters:

templateRowid - The rowid of the template record. Immutable.

Method Detail

first

public boolean first()

Move cursor to the first results row.

Specified by:

first in interface Results

Returns:

true if there are any results.

last

public boolean last()

Move cursor to the last results row.

Specified by:

last in interface Results

Returns:

true if there are any results.

next

public boolean next()

Move cursor to the next results 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 results 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 results 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 results 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(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. In this case this is a no-op since the template record is not linked to Hibernate.

Specified by:

sessionClosing in interface Results

cleanup

public void cleanup()

Clean up and release any resources which this object is holding, such as open result sets. In this case it does nothing as no resources are held.

Specified by:

cleanup in interface Results

normalize

private void normalize()

Internal worker that keeps the correctness of cursor position: always in one of the positions: -1 = before the first record, 0 = the only record is selected, +1, after the last record.