sirius.biz.web

Class SQLPageHelper<E extends sirius.db.jdbc.SQLEntity>

java.lang.Object

sirius.biz.web.BasePageHelper<E,sirius.db.jdbc.constraints.SQLConstraint,sirius.db.jdbc.SmartQuery<E>,SQLPageHelper<E>>

sirius.biz.web.SQLPageHelper<E>

Type Parameters:

E - the generic type of the entities being queried

public class SQLPageHelper<E extends sirius.db.jdbc.SQLEntity>
extends BasePageHelper<E,sirius.db.jdbc.constraints.SQLConstraint,sirius.db.jdbc.SmartQuery<E>,SQLPageHelper<E>>

Implements a page helper for smart queries.

Field Summary

Fields inherited from class sirius.biz.web.BasePageHelper

baseQuery, ctx, DEFAULT_PAGE_SIZE, facets, pageSize, searchFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLPageHelper(sirius.db.jdbc.SmartQuery<E> query)

Method Summary

Modifier and Type	Method and Description
SQLPageHelper<E>	addQueryFacet(String name, String title, Function<sirius.db.jdbc.SmartQuery<E>,sirius.db.jdbc.SQLQuery> queryTransformer) Adds a query based filter which uses the given query to determine which filter items are shown.
static <E extends sirius.db.jdbc.SQLEntity> SQLPageHelper<E>	withQuery(sirius.db.jdbc.SmartQuery<E> baseQuery) Creates a new instance with the given base query.

Methods inherited from class sirius.biz.web.BasePageHelper

addBooleanFacet, addFacet, addFacet, addFilterFacet, addTimeFacet, applyFacets, asPage, createTimeFacet, enforcePaging, executeQuery, fillPage, setupPaging, withContext, withPageSize, withSearchFields

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLPageHelper

protected SQLPageHelper(sirius.db.jdbc.SmartQuery<E> query)

Method Detail

withQuery

public static <E extends sirius.db.jdbc.SQLEntity> SQLPageHelper<E> withQuery(sirius.db.jdbc.SmartQuery<E> baseQuery)

Creates a new instance with the given base query.

Type Parameters:

E - the generic entity type being queried

Parameters:

baseQuery - the initial query to execute

Returns:

a new instance operating on the given base query

addQueryFacet

public SQLPageHelper<E> addQueryFacet(String name,
                                      String title,
                                      Function<sirius.db.jdbc.SmartQuery<E>,sirius.db.jdbc.SQLQuery> queryTransformer)

Adds a query based filter which uses the given query to determine which filter items are shown.

Parameters:

name - the name of the field to filter on

title - the title of the filter shown to the user

queryTransformer - used to generate the sub-query which determines which filter values to show

Returns:

the helper itself for fluent method calls