com.revolsys.jdbc.io

Class JdbcQueryResultPager

java.lang.Object

com.revolsys.jdbc.io.JdbcQueryResultPager

All Implemented Interfaces:

ResultPager<Record>, AutoCloseable

public class JdbcQueryResultPager
extends Object
implements ResultPager<Record>

Constructor Summary

Constructors

Constructor and Description
JdbcQueryResultPager(JdbcRecordStore recordStore, Map<String,Object> properties, Query query)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected void	finalize()
int	getEndIndex() Get the index of the last object in the current page.
List<Record>	getList() Get the list of objects in the current page.
int	getNextPageNumber() Get the page number of the next page.
int	getNumPages() Get the number of pages.
int	getNumResults() Get the total number of results returned.
int	getPageNumber() Get the page number of the current page.
int	getPageSize() Get the number of objects to display in a page.
int	getPreviousPageNumber() Get the page number of the previous page.
Query	getQuery()
RecordDefinition	getRecordDefinition()
RecordFactory	getRecordFactory()
JdbcRecordStore	getRecordStore()
protected String	getSql()
int	getStartIndex() Get the index of the first object in the current page.
boolean	hasNextPage() Check to see if there is a next page.
boolean	hasPreviousPage() Check to see if there is a previous page.
boolean	isClosed()
boolean	isFirstPage() Check to see if this is the first page.
boolean	isLastPage() Check to see if this is the last page.
protected void	setNumResults(int numResults)
void	setPageNumber(int pageNumber) Set the current page number.
void	setPageNumberAndSize(int pageSize, int pageNumber)
void	setPageSize(int pageSize) Set the number of objects per page.
protected void	setResults(List<Record> results)
protected void	updateNumPages()
protected void	updateResults() Update the cached results for the current page.

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcQueryResultPager

public JdbcQueryResultPager(JdbcRecordStore recordStore,
                    Map<String,Object> properties,
                    Query query)

Method Detail

close

@PreDestroy
public void close()

Specified by:

close in interface ResultPager<Record>

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getEndIndex

public int getEndIndex()

Get the index of the last object in the current page.

Specified by:

getEndIndex in interface ResultPager<Record>

Returns:

The index of the last object in the current page.

getList

public List<Record> getList()

Get the list of objects in the current page.

Specified by:

getList in interface ResultPager<Record>

Returns:

The list of objects in the current page.

getNextPageNumber

public int getNextPageNumber()

Get the page number of the next page.

Specified by:

getNextPageNumber in interface ResultPager<Record>

Returns:

Thepage number of the next page.

getNumPages

public int getNumPages()

Get the number of pages.

Specified by:

getNumPages in interface ResultPager<Record>

Returns:

The number of pages.

getNumResults

public int getNumResults()

Get the total number of results returned.

Specified by:

getNumResults in interface ResultPager<Record>

Returns:

The total number of results returned.

getPageNumber

public int getPageNumber()

Get the page number of the current page. Index starts at 1.

Specified by:

getPageNumber in interface ResultPager<Record>

Returns:

The page number of the current page.

getPageSize

public int getPageSize()

Get the number of objects to display in a page.

Specified by:

getPageSize in interface ResultPager<Record>

Returns:

The number of objects to display in a page.

getPreviousPageNumber

public int getPreviousPageNumber()

Get the page number of the previous page.

Specified by:

getPreviousPageNumber in interface ResultPager<Record>

Returns:

Thepage number of the previous page.

getQuery

public Query getQuery()

getRecordDefinition

public RecordDefinition getRecordDefinition()

getRecordFactory

public RecordFactory getRecordFactory()

getRecordStore

public JdbcRecordStore getRecordStore()

getSql

protected String getSql()

getStartIndex

public int getStartIndex()

Get the index of the first object in the current page. Index starts at 1.

Specified by:

getStartIndex in interface ResultPager<Record>

Returns:

The index of the first object in the current page.

hasNextPage

public boolean hasNextPage()

Check to see if there is a next page.

Specified by:

hasNextPage in interface ResultPager<Record>

Returns:

True if there is a next page.

hasPreviousPage

public boolean hasPreviousPage()

Check to see if there is a previous page.

Specified by:

hasPreviousPage in interface ResultPager<Record>

Returns:

True if there is a previous page.

isClosed

public boolean isClosed()

isFirstPage

public boolean isFirstPage()

Check to see if this is the first page.

Specified by:

isFirstPage in interface ResultPager<Record>

Returns:

True if this is the first page.

isLastPage

public boolean isLastPage()

Check to see if this is the last page.

Specified by:

isLastPage in interface ResultPager<Record>

Returns:

True if this is the last page.

setNumResults

protected void setNumResults(int numResults)

setPageNumber

public void setPageNumber(int pageNumber)

Set the current page number.

Specified by:

setPageNumber in interface ResultPager<Record>

Parameters:

pageNumber - The current page number.

setPageNumberAndSize

public void setPageNumberAndSize(int pageSize,
                        int pageNumber)

Specified by:

setPageNumberAndSize in interface ResultPager<Record>

setPageSize

public void setPageSize(int pageSize)

Set the number of objects per page.

Specified by:

setPageSize in interface ResultPager<Record>

Parameters:

pageSize - The number of objects per page.

setResults

protected void setResults(List<Record> results)

updateNumPages

protected void updateNumPages()

updateResults

protected void updateResults()

Update the cached results for the current page.