org.omnifaces.persistence.model.dto

Class Page

java.lang.Object

org.omnifaces.persistence.model.dto.Page

public final class Page
extends Object

This class basically defines a paged view of a database based on a given offset, limit, ordering, required criteria and optional criteria. This is used by BaseEntityService.getPage(Page, boolean) methods.

Author:

Bauke Scholtz

See Also:

BaseEntityService, Criteria

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Page.Builder The page builder.

Field Summary

Fields

Modifier and Type	Field and Description
static Page	ALL
static Page	ONE

Constructor Summary

Constructors

Constructor and Description
Page(Integer offset, Integer limit, LinkedHashMap<String,Boolean> ordering, Map<String,Object> requiredCriteria, Map<String,Object> optionalCriteria) Creates a new Page.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
int	getLimit() Returns the limit.
int	getOffset() Returns the offset.
Map<String,Object>	getOptionalCriteria() Returns the optional criteria.
Map<String,Boolean>	getOrdering() Returns the ordering.
Map<String,Object>	getRequiredCriteria() Returns the required criteria.
int	hashCode()
static Page	of(int offset, int limit) Use this if you want a page of given offset and limit.
String	toString() Identity is important as this is used as value of org.hibernate.cacheRegion hint in BaseEntityService.getPage(Page, boolean).
static Page.Builder	with() Use this if you want to build a page.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final Page ALL

ONE

public static final Page ONE

Constructor Detail

Page

public Page(Integer offset,
            Integer limit,
            LinkedHashMap<String,Boolean> ordering,
            Map<String,Object> requiredCriteria,
            Map<String,Object> optionalCriteria)

Creates a new Page. You can for convenience also use the with() builder.

Parameters:

offset - Zero-based offset of the page. May not be negative. Defaults to 0.

limit - Maximum amount of records to be matched. May not be less than 1. Defaults to Integer.MAX_VALUE.

ordering - Ordering of results. Map key represents property name and map value represents whether to sort ascending. Defaults to {"id",false}.

requiredCriteria - Required criteria. Map key represents property name and map value represents criteria. Each entity must match all of given criteria.

optionalCriteria - Optional criteria. Map key represents property name and map value represents criteria. Each entity must match at least one of given criteria.

Method Detail

getOffset

public int getOffset()

Returns the offset. Defaults to 0.

Returns:

The offset.

getLimit

public int getLimit()

Returns the limit. Defaults to Integer.MAX_VALUE.

Returns:

The limit.

getOrdering

public Map<String,Boolean> getOrdering()

Returns the ordering. Map key represents property name and map value represents whether to sort ascending. Defaults to {"id",false}.

Returns:

The ordering.

getRequiredCriteria

public Map<String,Object> getRequiredCriteria()

Returns the required criteria. Map key represents property name and map value represents criteria. Each entity must match all of given criteria.

Returns:

The required criteria.

getOptionalCriteria

public Map<String,Object> getOptionalCriteria()

Returns the optional criteria. Map key represents property name and map value represents criteria. Each entity must match at least one of given criteria.

Returns:

The optional criteria.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Identity is important as this is used as value of org.hibernate.cacheRegion hint in BaseEntityService.getPage(Page, boolean). Hence the criteria hashmaps are printed as treemaps.

Overrides:

toString in class Object

with

public static Page.Builder with()

Use this if you want to build a page.

Returns:

A new page builder.

of

public static Page of(int offset,
                      int limit)

Use this if you want a page of given offset and limit.

Parameters:

offset - Zero-based offset of the page. May not be negative. Defaults to 0.

limit - Maximum amount of records to be matched. May not be less than 1. Defaults to Integer.MAX_VALUE.

Returns:

A new page of given offset and limit.