sirius.biz.web

Class BasePageHelper<E extends sirius.db.mixing.BaseEntity<?>,C extends sirius.db.mixing.query.constraints.Constraint,Q extends sirius.db.mixing.query.Query<Q,E,C>,B extends BasePageHelper<E,C,Q,B>>

java.lang.Object

sirius.biz.web.BasePageHelper<E,C,Q,B>

Type Parameters:

E - the generic type of the entities being queried

Direct Known Subclasses:

ElasticPageHelper, MongoPageHelper, SQLPageHelper

public abstract class BasePageHelper<E extends sirius.db.mixing.BaseEntity<?>,C extends sirius.db.mixing.query.constraints.Constraint,Q extends sirius.db.mixing.query.Query<Q,E,C>,B extends BasePageHelper<E,C,Q,B>>
extends Object

Helper class to build a query, bind it to values given in a WebContext and create a resulting Page which can be used to render a resulting table and filter box.

Field Summary

Fields

Modifier and Type	Field and Description
protected Q	baseQuery
protected sirius.web.http.WebContext	ctx
protected static int	DEFAULT_PAGE_SIZE
protected List<sirius.kernel.commons.Tuple<sirius.web.controller.Facet,BiConsumer<sirius.web.controller.Facet,Q>>>	facets
protected int	pageSize
protected List<sirius.db.mixing.query.QueryField>	searchFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePageHelper(Q query)

Method Summary

Modifier and Type	Method and Description
B	addBooleanFacet(String name, String title) Adds a boolean based filter which permits to filter on boolean values.
B	addFacet(sirius.web.controller.Facet facet, BiConsumer<sirius.web.controller.Facet,Q> filter) Adds a filter facet which a custom filter implementation.
B	addFacet(sirius.web.controller.Facet facet, BiConsumer<sirius.web.controller.Facet,Q> filter, BiConsumer<sirius.web.controller.Facet,Q> itemsComputer) Adds a filter facet with custom filter implementation and a custom item computer.
B	addFilterFacet(sirius.web.controller.Facet facet) Adds a filter facet which will show distinct values of the given property.
B	addTimeFacet(String name, String title, sirius.db.mixing.DateRange... ranges) Adds a time series based filter which permits to filter on certain time ranges.
protected void	applyFacets(sirius.web.controller.Page<E> result)
sirius.web.controller.Page<E>	asPage() Wraps the given data into a Page which can be used to render a table, filterbox and support pagination.
protected sirius.web.controller.Facet	createTimeFacet(String name, String title, sirius.db.mixing.DateRange[] ranges)
protected void	enforcePaging(sirius.web.controller.Page<E> result, List<E> items)
protected List<E>	executeQuery()
protected void	fillPage(sirius.kernel.commons.Watch w, sirius.web.controller.Page<E> result, List<E> items)
protected void	setupPaging(sirius.web.controller.Page<E> result)
B	withContext(sirius.web.http.WebContext ctx) Attaches a web context to the helper, to fetch filter and pagination values from.
B	withPageSize(int pageSize) Specifies the number of items shown on the page that gets rendered using this pageHelper.
B	withSearchFields(sirius.db.mixing.query.QueryField... searchFields) Specifies one or more search fields which will be searched if a query if given in the WebContext.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

protected static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

ctx

protected sirius.web.http.WebContext ctx

baseQuery

protected Q extends sirius.db.mixing.query.Query<Q,E,C> baseQuery

searchFields

protected List<sirius.db.mixing.query.QueryField> searchFields

facets

protected List<sirius.kernel.commons.Tuple<sirius.web.controller.Facet,BiConsumer<sirius.web.controller.Facet,Q extends sirius.db.mixing.query.Query<Q,E,C>>>> facets

pageSize

protected int pageSize

Constructor Detail

BasePageHelper

protected BasePageHelper(Q query)

Method Detail

withContext

public B withContext(sirius.web.http.WebContext ctx)

Attaches a web context to the helper, to fetch filter and pagination values from.

Parameters:

ctx - the request to attach

Returns:

the helper itself for fluent method calls

withSearchFields

public B withSearchFields(sirius.db.mixing.query.QueryField... searchFields)

Specifies one or more search fields which will be searched if a query if given in the WebContext.

Parameters:

searchFields - the fields to search in

Returns:

the helper itself for fluent method calls

addFilterFacet

public B addFilterFacet(sirius.web.controller.Facet facet)

Adds a filter facet which will show distinct values of the given property.

Parameters:

facet - the facet to add

Returns:

the helper itself for fluent method calls

addFacet

public B addFacet(sirius.web.controller.Facet facet,
                  BiConsumer<sirius.web.controller.Facet,Q> filter)

Adds a filter facet which a custom filter implementation.

Parameters:

facet - the facet to add

filter - the custom logic which determines how a filter value is applied to the query.

Returns:

the helper itself for fluent method calls

addFacet

public B addFacet(sirius.web.controller.Facet facet,
                  BiConsumer<sirius.web.controller.Facet,Q> filter,
                  BiConsumer<sirius.web.controller.Facet,Q> itemsComputer)

Adds a filter facet with custom filter implementation and a custom item computer.

Parameters:

facet - the facet to add

filter - the custom logic which determines how a filter value is applied to the query.

itemsComputer - the custom logic which determines the list of items in the filter

Returns:

the helper itself for fluent method calls

addTimeFacet

public B addTimeFacet(String name,
                      String title,
                      sirius.db.mixing.DateRange... ranges)

Adds a time series based filter which permits to filter on certain time ranges.

Parameters:

name - the name of the field to filter on

title - the title of the filter shown to the user

ranges - the ranges which are supported as filter values

Returns:

the helper itself for fluent method calls

createTimeFacet

protected sirius.web.controller.Facet createTimeFacet(String name,
                                                      String title,
                                                      sirius.db.mixing.DateRange[] ranges)

addBooleanFacet

public B addBooleanFacet(String name,
                         String title)

Adds a boolean based filter which permits to filter on boolean values.

Parameters:

name - the name of the field to filter on

title - the title of the filter shown to the user

Returns:

the helper itself for fluent method calls

withPageSize

public B withPageSize(int pageSize)

Specifies the number of items shown on the page that gets rendered using this pageHelper.

Parameters:

pageSize - the number of items shown per page

Returns:

the helper itself for fluent method calls

asPage

public sirius.web.controller.Page<E> asPage()

Wraps the given data into a Page which can be used to render a table, filterbox and support pagination.

Returns:

the given data wrapped as Page

fillPage

protected void fillPage(sirius.kernel.commons.Watch w,
                        sirius.web.controller.Page<E> result,
                        List<E> items)

enforcePaging

protected void enforcePaging(sirius.web.controller.Page<E> result,
                             List<E> items)

executeQuery

protected List<E> executeQuery()

setupPaging

protected void setupPaging(sirius.web.controller.Page<E> result)

applyFacets

protected void applyFacets(sirius.web.controller.Page<E> result)