org.bremersee.pagebuilder.model

Class PageRequestDto

java.lang.Object

org.bremersee.pagebuilder.model.PageRequestDto

All Implemented Interfaces:

Serializable, Comparable<PageRequest>, PageRequest

Direct Known Subclasses:

PageRequestLinkDto

public class PageRequestDto
extends Object
implements PageRequest, Comparable<PageRequest>

A page request defines which page is requested (by it's page number), how many elements the page may have and how the elements are sorted. Furthermore a query value can be specified and custom extensions, which may be handled by the business logic.

Author:

Christian Bremer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageRequestDto() Default constructor.
PageRequestDto(int pageNumber, int pageSize) Creates a page request by the page number and size.
PageRequestDto(int pageNumber, int pageSize, org.bremersee.comparator.model.ComparatorItem comparatorItem) Creates a page request by the page number, size and comparator item.
PageRequestDto(int pageNumber, int pageSize, org.bremersee.comparator.model.ComparatorItem comparatorItem, String query) Creates a page request by the page number, size, comparator item and a query value.
PageRequestDto(int pageNumber, int pageSize, org.bremersee.comparator.model.ComparatorItem comparatorItem, String query, Map<String,Object> extensions) Creates a page request by the page number, size, comparator item, a query value and custom extensions.
PageRequestDto(PageRequest pageRequest) Creates a page request by another page request.

Method Summary

Modifier and Type	Method and Description
int	compareTo(PageRequest pageRequest)
boolean	equals(Object obj)
org.bremersee.comparator.model.ComparatorItem	getComparatorItem() Returns the comparator item (may be null).
Map<String,Object>	getExtensions() Returns a custom extension (may be null).
int	getFirstResult() Returns the first result (offset).
int	getPageNumber() Returns the requested page number (starting with 0).
int	getPageSize() Returns the maximum number of elements on the page (is always greater than 0).
String	getQuery() Returns the search query (may be null).
int	hashCode()
void	setComparatorItem(org.bremersee.comparator.model.ComparatorItem comparatorItem) Sets the comparator item (may be null).
void	setExtensions(Map<String,Object> extensions) Sets a custom extension (may be null).
protected void	setFirstResult(Integer firstResult) Sets the first result (offset).
void	setPageNumber(int pageNumber) Sets the requested page number (starting with 0).
void	setPageSize(int pageSize) Sets the maximum number of elements on the page (must be greater than 0).
void	setQuery(String query) Sets the search query (may be null).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageRequestDto

public PageRequestDto()

Default constructor.

PageRequestDto

public PageRequestDto(PageRequest pageRequest)

Creates a page request by another page request.

Parameters:

pageRequest - the other page request (may by null)

PageRequestDto

public PageRequestDto(int pageNumber,
                      int pageSize)

Creates a page request by the page number and size.

Parameters:

pageNumber - the page number

pageSize - the page size

PageRequestDto

public PageRequestDto(int pageNumber,
                      int pageSize,
                      org.bremersee.comparator.model.ComparatorItem comparatorItem)

Creates a page request by the page number, size and comparator item.

Parameters:

pageNumber - the page number

pageSize - the page size

comparatorItem - the comparator item (may be null)

PageRequestDto

public PageRequestDto(int pageNumber,
                      int pageSize,
                      org.bremersee.comparator.model.ComparatorItem comparatorItem,
                      String query)

Creates a page request by the page number, size, comparator item and a query value.

Parameters:

pageNumber - the page number

pageSize - the page size

comparatorItem - the comparator item (may be null)

query - the query value

PageRequestDto

public PageRequestDto(int pageNumber,
                      int pageSize,
                      org.bremersee.comparator.model.ComparatorItem comparatorItem,
                      String query,
                      Map<String,Object> extensions)

Creates a page request by the page number, size, comparator item, a query value and custom extensions.

Parameters:

pageNumber - the page number

pageSize - the page size

comparatorItem - the comparator item (may be null)

query - the query value

extensions - the custom extensions

Method Detail

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(PageRequest pageRequest)

Specified by:

compareTo in interface Comparable<PageRequest>

getPageNumber

public int getPageNumber()

Returns the requested page number (starting with 0).

Specified by:

getPageNumber in interface PageRequest

setPageNumber

public void setPageNumber(int pageNumber)

Sets the requested page number (starting with 0).

getPageSize

public int getPageSize()

Returns the maximum number of elements on the page (is always greater than 0).

Specified by:

getPageSize in interface PageRequest

setPageSize

public void setPageSize(int pageSize)

Sets the maximum number of elements on the page (must be greater than 0).

getFirstResult

public int getFirstResult()

Returns the first result (offset).

Specified by:

getFirstResult in interface PageRequest

setFirstResult

protected void setFirstResult(Integer firstResult)

Sets the first result (offset).

getComparatorItem

public org.bremersee.comparator.model.ComparatorItem getComparatorItem()

Returns the comparator item (may be null).

Specified by:

getComparatorItem in interface PageRequest

setComparatorItem

public void setComparatorItem(org.bremersee.comparator.model.ComparatorItem comparatorItem)

Sets the comparator item (may be null).

getQuery

public String getQuery()

Returns the search query (may be null).

Specified by:

getQuery in interface PageRequest

setQuery

public void setQuery(String query)

Sets the search query (may be null).

getExtensions

public Map<String,Object> getExtensions()

Returns a custom extension (may be null).

Specified by:

getExtensions in interface PageRequest

setExtensions

public void setExtensions(Map<String,Object> extensions)

Sets a custom extension (may be null).