org.bridje.orm

Class Paging

java.lang.Object

org.bridje.orm.Paging

public class Paging
extends Object

An object holding the paging information for a query.

Method Summary

Modifier and Type	Method and Description
static Paging	fromString(String value) Create a paging object out of it string representation.
Page	getCurrent() The current page in this object.
Page	getPage(int value) Gets the page by the given value.
int	getPageCount() The number of pages in this paging object.
Page[]	getPages() An array with all the page of this paging object.
List<Page>	getPagesAsList() A list with all the page of this paging object.
int	getPageSize() The size in records for the pages of this paging object.
Page[]	getPagesSection(int sectionSize) Gets a section of the paging object.
List<Page>	getPagesSectionAsList(int sectionSize) Gets a section of the paging object.
int	getRecordCount() The number of records for the query.
boolean	isFirst() Determines if the current page is the first page of this object.
boolean	isLast() Determines if the current page is the last page of this object.
void	next() Move this object to the next page.
static Paging	of(int count, int size) Creates a paging object out of the number of records and the size of the pages.
static Paging	of(int count, int size, int current) Creates a paging object out of the number of records, the size of the pages, and the current page.
void	prev() Move this object to the previous page.
void	setCurrent(int current) The current page in this object.
void	setCurrent(Page current) The current page in this object.
Limit	toLimit() Creates a new SQL Limit object out of this paging object.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getRecordCount

public int getRecordCount()

The number of records for the query.

Returns:

The number of records for the query.

getPageSize

public int getPageSize()

The size in records for the pages of this paging object.

Returns:

The size in records for the pages of this paging object.

getPages

public Page[] getPages()

An array with all the page of this paging object.

Returns:

An array with all the page of this paging object.

getPagesSection

public Page[] getPagesSection(int sectionSize)

Gets a section of the paging object.

Parameters:

sectionSize - The size in pages of the section to get.

Returns:

An array of pages that represent the section.

getPagesAsList

public List<Page> getPagesAsList()

A list with all the page of this paging object.

Returns:

A list with all the page of this paging object.

getPagesSectionAsList

public List<Page> getPagesSectionAsList(int sectionSize)

Gets a section of the paging object.

Parameters:

sectionSize - The size in pages of the section to get.

Returns:

A list of pages that represent the section.

getPageCount

public int getPageCount()

The number of pages in this paging object.

Returns:

The number of pages in this paging object.

getCurrent

public Page getCurrent()

The current page in this object.

Returns:

The current page in this object.

setCurrent

public void setCurrent(Page current)

The current page in this object.

Parameters:

current - The current page in this object.

setCurrent

public void setCurrent(int current)

The current page in this object.

Parameters:

current - The current page in this object.

next

public void next()

Move this object to the next page.

prev

public void prev()

Move this object to the previous page.

isFirst

public boolean isFirst()

Determines if the current page is the first page of this object.

Returns:

true if the current page is the first page of this object, false otherwise.

isLast

public boolean isLast()

Determines if the current page is the last page of this object.

Returns:

true if the current page is the last page of this object, false otherwise.

getPage

public Page getPage(int value)

Gets the page by the given value.

Parameters:

value - The value of the page to look for.

Returns:

The page found or null if it does not exists.

of

public static Paging of(int count,
                        int size)

Creates a paging object out of the number of records and the size of the pages.

Parameters:

count - The number of records,

size - The size of the pages.

Returns:

The new paging object.

of

public static Paging of(int count,
                        int size,
                        int current)

Creates a paging object out of the number of records, the size of the pages, and the current page.

Parameters:

count - The number of records,

size - The size of the pages.

current - The current page.

Returns:

The new paging object.

toString

public String toString()

Overrides:

toString in class Object

fromString

public static Paging fromString(String value)

Create a paging object out of it string representation.

Parameters:

value - The string representation of the paging objectt.

Returns:

The new paging object.

toLimit

public Limit toLimit()

Creates a new SQL Limit object out of this paging object.

Returns:

The new SQL Limit object.