org.hibernate.search.query.hibernate.impl

Class ScrollableResultsImpl

java.lang.Object

org.hibernate.search.query.hibernate.impl.ScrollableResultsImpl

All Implemented Interfaces:

Closeable, AutoCloseable, ScrollableResults

public class ScrollableResultsImpl
extends Object
implements ScrollableResults

Implements scrollable and paginated resultsets. Contrary to Query#iterate() or Query#list(), this implementation is exposed to returned null objects (if the index is out of date).

The following methods that change the value of 'current' will check and set its value to either 'afterLast' or 'beforeFirst' depending on direction. This is to prevent rogue values from setting it outside the boundaries of the results.

• next()
• previous()
• scroll(i)
• last()
• first()

Author:

Emmanuel Bernard, John Griffin, Sanne Grinovero

See Also:

Query

Constructor Summary

Constructors

Constructor and Description
ScrollableResultsImpl(int fetchSize, org.hibernate.search.query.engine.spi.DocumentExtractor extractor, Loader loader, SessionImplementor sessionImplementor)

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.
void	close() Release resources immediately.
boolean	first() Go to the first result.
Object[]	get() Get the current row of results.
Object	get(int i) This method is not supported on Lucene based queries
BigDecimal	getBigDecimal(int col) This method is not supported on Lucene based queries
BigInteger	getBigInteger(int col) This method is not supported on Lucene based queries
byte[]	getBinary(int col) This method is not supported on Lucene based queries
Blob	getBlob(int col) This method is not supported on Lucene based queries
Boolean	getBoolean(int col) This method is not supported on Lucene based queries
Byte	getByte(int col) This method is not supported on Lucene based queries
Calendar	getCalendar(int col) This method is not supported on Lucene based queries
Character	getCharacter(int col) This method is not supported on Lucene based queries
Clob	getClob(int col) This method is not supported on Lucene based queries
Date	getDate(int col) This method is not supported on Lucene based queries
Double	getDouble(int col) This method is not supported on Lucene based queries
Float	getFloat(int col) This method is not supported on Lucene based queries
Integer	getInteger(int col) This method is not supported on Lucene based queries
Locale	getLocale(int col) This method is not supported on Lucene based queries
Long	getLong(int col) This method is not supported on Lucene based queries
int	getRowNumber() Get the current position in the results.
Short	getShort(int col) This method is not supported on Lucene based queries
String	getString(int col) This method is not supported on Lucene based queries
String	getText(int col) This method is not supported on Lucene based queries
TimeZone	getTimeZone(int col) This method is not supported on Lucene based queries
Type	getType(int i) This method is not supported on Lucene based queries
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 java.lang.Object

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

Constructor Detail

ScrollableResultsImpl

public ScrollableResultsImpl(int fetchSize,
                             org.hibernate.search.query.engine.spi.DocumentExtractor extractor,
                             Loader loader,
                             SessionImplementor sessionImplementor)

Method Detail

next

public boolean next()

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

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

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

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

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

afterLast

public void afterLast()

Description copied from interface: ScrollableResults

Go to a location just after the last result.

Specified by:

afterLast 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.

close

public 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

get

public Object[] get()

Description copied from interface: ScrollableResults

Get the current row of results.

Specified by:

get in interface ScrollableResults

Returns:

The array of results

get

public Object get(int i)

This method is not supported on Lucene based queries

Specified by:

get in interface ScrollableResults

Parameters:

i - the column, numbered from zero

Returns:

The requested result object; may return null

Throws:

UnsupportedOperationException - always thrown

getType

public Type getType(int i)

This method is not supported on Lucene based queries

Specified by:

getType in interface ScrollableResults

Parameters:

i - the column, numbered from zero

Returns:

the Hibernate type

Throws:

UnsupportedOperationException - always thrown

getInteger

public Integer getInteger(int col)

This method is not supported on Lucene based queries

Specified by:

getInteger in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as an integer

Throws:

UnsupportedOperationException - always thrown

getLong

public Long getLong(int col)

This method is not supported on Lucene based queries

Specified by:

getLong in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a long

Throws:

UnsupportedOperationException - always thrown

getFloat

public Float getFloat(int col)

This method is not supported on Lucene based queries

Specified by:

getFloat in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a float

Throws:

UnsupportedOperationException - always thrown

getBoolean

public Boolean getBoolean(int col)

This method is not supported on Lucene based queries

Specified by:

getBoolean in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a boolean

Throws:

UnsupportedOperationException - always thrown

getDouble

public Double getDouble(int col)

This method is not supported on Lucene based queries

Specified by:

getDouble in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a double

Throws:

UnsupportedOperationException - always thrown

getShort

public Short getShort(int col)

This method is not supported on Lucene based queries

Specified by:

getShort in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a short

Throws:

UnsupportedOperationException - always thrown

getByte

public Byte getByte(int col)

This method is not supported on Lucene based queries

Specified by:

getByte in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a byte

Throws:

UnsupportedOperationException - always thrown

getCharacter

public Character getCharacter(int col)

This method is not supported on Lucene based queries

Specified by:

getCharacter in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a char

Throws:

UnsupportedOperationException - always thrown

getBinary

public byte[] getBinary(int col)

This method is not supported on Lucene based queries

Specified by:

getBinary in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a binary (byte[])

Throws:

UnsupportedOperationException - always thrown

getText

public String getText(int col)

This method is not supported on Lucene based queries

Specified by:

getText in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a String

Throws:

UnsupportedOperationException - always thrown

getBlob

public Blob getBlob(int col)

This method is not supported on Lucene based queries

Specified by:

getBlob in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a Blob

Throws:

UnsupportedOperationException - always thrown

getClob

public Clob getClob(int col)

This method is not supported on Lucene based queries

Specified by:

getClob in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a Clob

Throws:

UnsupportedOperationException - always thrown

getString

public String getString(int col)

This method is not supported on Lucene based queries

Specified by:

getString in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a String

Throws:

UnsupportedOperationException - always thrown

getBigDecimal

public BigDecimal getBigDecimal(int col)

This method is not supported on Lucene based queries

Specified by:

getBigDecimal in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a BigDecimal

Throws:

UnsupportedOperationException - always thrown

getBigInteger

public BigInteger getBigInteger(int col)

This method is not supported on Lucene based queries

Specified by:

getBigInteger in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a BigInteger

Throws:

UnsupportedOperationException - always thrown

getDate

public Date getDate(int col)

This method is not supported on Lucene based queries

Specified by:

getDate in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a Date

Throws:

UnsupportedOperationException - always thrown

getLocale

public Locale getLocale(int col)

This method is not supported on Lucene based queries

Specified by:

getLocale in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a Locale

Throws:

UnsupportedOperationException - always thrown

getCalendar

public Calendar getCalendar(int col)

This method is not supported on Lucene based queries

Specified by:

getCalendar in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a Calendar

Throws:

UnsupportedOperationException - always thrown

getTimeZone

public TimeZone getTimeZone(int col)

This method is not supported on Lucene based queries

Specified by:

getTimeZone in interface ScrollableResults

Parameters:

col - The column, numbered from zero

Returns:

The column value as a TimeZone

Throws:

UnsupportedOperationException - always thrown

getRowNumber

public int getRowNumber()

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

setRowNumber

public boolean setRowNumber(int rowNumber)

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