com.goldencode.p2j.persist

Class SimpleResults

java.lang.Object

com.goldencode.p2j.persist.SimpleResults

All Implemented Interfaces:

FullResults, Results

Direct Known Subclasses:

FilteredResults, Presorter.IncrementalResults, Presorter.SortedResults

class SimpleResults
extends java.lang.Object
implements FullResults

A simple implementation of Results which stores row data in a list provided to the constructor. The row data consists of a list of array objects. Each object in the array is either a Record object (a DMO instance) or a Long which represents a DMO's primary key ID. Note that this implementation may have a heavy memory requirement for large results sets, especially if the entire DMO is stored and not just its primary key ID.

Field Summary

Fields

Modifier and Type	Field and Description
private int	position Index of current position in results list; -1 is off end
private java.util.List<java.lang.Object[]>	rows Results list; each row is an array of primary keys or DMOs

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

LOG

Constructor Summary

Constructors

Constructor and Description
SimpleResults(java.util.List<java.lang.Object[]> rows) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addRow(java.lang.Object[] row, boolean beforeRow) Add a new row.
void	cleanup() Clear the internal list of result rows.
boolean	deleteRow() Delete the current row.
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	getNumberOfLoadedRows() Returns the number of rows which have been loaded by this Results.
int	getRowNumber() Get the row number currently under the cursor.
protected java.util.List<java.lang.Object[]>	getRows() Get the list of row data which backs this results object.
boolean	isEmpty() Check if this has records.
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	isResultSetCached() Indicate whether the full result set is cached in this object.
boolean	last() Move cursor to the last results row.
boolean	next() Move cursor to the next results row.
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() Required by the Results interface, but this is a no-op implementation.
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

get, isAutoFetch

Field Detail

rows

private final java.util.List<java.lang.Object[]> rows

Results list; each row is an array of primary keys or DMOs

position

private int position

Index of current position in results list; -1 is off end

Constructor Detail

SimpleResults

public SimpleResults(java.util.List<java.lang.Object[]> rows)

Constructor.

Parameters:

rows - List of row data.

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()

Required by the Results interface, but this is a no-op implementation.

Specified by:

sessionClosing in interface Results

cleanup

public void cleanup()

Clear the internal list of result rows.

Specified by:

cleanup in interface Results

isResultSetCached

public boolean isResultSetCached()

Indicate whether the full result set is cached in this object.

Specified by:

isResultSetCached in interface Results

Returns:

true if all results are contained this object; false if not or if unknown (such as for a scrolling or cursored result set. Return value for this default implementation is true.

getNumberOfLoadedRows

public int getNumberOfLoadedRows()

Returns the number of rows which have been loaded by this Results.

Specified by:

getNumberOfLoadedRows in interface Results

Returns:

See above.

deleteRow

public boolean deleteRow()

Delete the current row.

Specified by:

deleteRow in interface Results

Returns:

true if the row was deleted. false if there is no row at the current position.

addRow

public void addRow(java.lang.Object[] row,
                   boolean beforeRow)

Add a new row.

Specified by:

addRow in interface Results

Parameters:

row - Row data.

beforeRow - true if the current position is before the row. false if the current position is on the row.

getRows

protected java.util.List<java.lang.Object[]> getRows()

Get the list of row data which backs this results object.

Returns:

List of rows.

isEmpty

public boolean isEmpty()

Check if this has records. This is part of the FullRecords implementation.

Specified by:

isEmpty in interface FullResults

Returns:

true if there are rows inside this results.