com.blazebit.persistence

Interface PaginatedCriteriaBuilder<T>

Type Parameters:

T - The query result type

All Superinterfaces:

BaseQueryBuilder<T,PaginatedCriteriaBuilder<T>>, BaseWhereBuilder<PaginatedCriteriaBuilder<T>>, CommonQueryBuilder<PaginatedCriteriaBuilder<T>>, ConfigurationSource, FetchBuilder<PaginatedCriteriaBuilder<T>>, FromBuilder<PaginatedCriteriaBuilder<T>>, FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>, KeysetQueryBuilder<PaginatedCriteriaBuilder<T>>, OrderByBuilder<PaginatedCriteriaBuilder<T>>, ParameterHolder<PaginatedCriteriaBuilder<T>>, Queryable<T,PaginatedCriteriaBuilder<T>>, QueryBuilder<T,PaginatedCriteriaBuilder<T>>, SelectBuilder<PaginatedCriteriaBuilder<T>>, ServiceProvider, WhereBuilder<PaginatedCriteriaBuilder<T>>

public interface PaginatedCriteriaBuilder<T>
extends FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>

A builder for paginated criteria queries.

Since:

1.0.0

Author:

Christian Beikov

Method Summary

Modifier and Type	Method and Description
<Y> PaginatedCriteriaBuilder<Y>	copy(Class<Y> resultClass) Copies this query builder into a new one, using it's projection as an overridable default.
String	getPageCountQueryString() Returns the query string that selects the count of elements.
String	getPageIdQueryString() Returns the query string that selects the id of the elements.
PagedList<T>	getResultList() Execute the query and return the result as a type PagedList.
boolean	isKeysetExtraction() Returns whether keyset extraction is enabled or not.
<Y> SelectObjectBuilder<PaginatedCriteriaBuilder<Y>>	selectNew(Class<Y> clazz) Starts a SelectObjectBuilder for the given class.
<Y> PaginatedCriteriaBuilder<Y>	selectNew(ObjectBuilder<Y> builder) Applies the given object builder to this query.
PaginatedCriteriaBuilder<T>	withKeysetExtraction(boolean keysetExtraction) Enable or disables keyset extraction which influences whether PagedList.getKeysetPage() is available.

Methods inherited from interface com.blazebit.persistence.FullQueryBuilder

innerJoinFetch, innerJoinFetchDefault, join, joinDefault, leftJoinFetch, leftJoinFetchDefault, page, page, page, rightJoinFetch, rightJoinFetchDefault, selectNew

Methods inherited from interface com.blazebit.persistence.QueryBuilder

getEntityManager

Methods inherited from interface com.blazebit.persistence.BaseQueryBuilder

getResultType

Methods inherited from interface com.blazebit.persistence.CommonQueryBuilder

getCriteriaBuilderFactory, getMetamodel, registerMacro, setProperties, setProperty

Methods inherited from interface com.blazebit.persistence.spi.ServiceProvider

getService

Methods inherited from interface com.blazebit.persistence.spi.ConfigurationSource

getProperties, getProperty

Methods inherited from interface com.blazebit.persistence.ParameterHolder

containsParameter, getParameter, getParameters, getParameterValue, isParameterSet, setParameter, setParameter, setParameter, setParameterType

Methods inherited from interface com.blazebit.persistence.FromBuilder

from, from, fromIdentifiableValues, fromIdentifiableValues, fromNew, fromNew, fromOld, fromOld, fromValues, fromValues, getFrom, getFromByPath, getRoots, innerJoin, innerJoinDefault, innerJoinDefaultOn, innerJoinOn, innerJoinOn, innerJoinOn, join, joinDefault, joinDefaultOn, joinOn, joinOn, joinOn, leftJoin, leftJoinDefault, leftJoinDefaultOn, leftJoinOn, leftJoinOn, leftJoinOn, rightJoin, rightJoinDefault, rightJoinDefaultOn, rightJoinOn, rightJoinOn, rightJoinOn

Methods inherited from interface com.blazebit.persistence.KeysetQueryBuilder

afterKeyset, afterKeyset, afterKeyset, beforeKeyset, beforeKeyset, beforeKeyset

Methods inherited from interface com.blazebit.persistence.WhereBuilder

whereExpression, whereExpressionSubqueries, whereOr

Methods inherited from interface com.blazebit.persistence.BaseWhereBuilder

where, whereCase, whereExists, whereExists, whereNotExists, whereNotExists, whereSimpleCase, whereSubqueries, whereSubquery, whereSubquery, whereSubquery, whereSubquery

Methods inherited from interface com.blazebit.persistence.OrderByBuilder

orderBy, orderByAsc, orderByAsc, orderByDesc, orderByDesc

Methods inherited from interface com.blazebit.persistence.SelectBuilder

select, select, selectCase, selectCase, selectSimpleCase, selectSimpleCase, selectSubqueries, selectSubqueries, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery

Methods inherited from interface com.blazebit.persistence.Queryable

getQuery, getQueryString, getSingleResult

Methods inherited from interface com.blazebit.persistence.FetchBuilder

fetch, fetch

Method Detail

getPageCountQueryString

String getPageCountQueryString()

Returns the query string that selects the count of elements.

Returns:

The query string

getPageIdQueryString

String getPageIdQueryString()

Returns the query string that selects the id of the elements.

Returns:

The query string

withKeysetExtraction

PaginatedCriteriaBuilder<T> withKeysetExtraction(boolean keysetExtraction)

Enable or disables keyset extraction which influences whether PagedList.getKeysetPage() is available.

Parameters:

keysetExtraction - true to enable, false to disable keyset extraction

Returns:

The query builder for chaining calls

isKeysetExtraction

boolean isKeysetExtraction()

Returns whether keyset extraction is enabled or not.

Returns:

true when enabled, false otherwise

getResultList

PagedList<T> getResultList()

Execute the query and return the result as a type PagedList.

Specified by:

getResultList in interface Queryable<T,PaginatedCriteriaBuilder<T>>

Returns:

The paged list of the results

copy

<Y> PaginatedCriteriaBuilder<Y> copy(Class<Y> resultClass)

Description copied from interface: FullQueryBuilder

Copies this query builder into a new one, using it's projection as an overridable default.

Specified by:

copy in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>

Type Parameters:

Y - The type of the result class

Parameters:

resultClass - The result class of the query

Returns:

A new query builder

selectNew

<Y> SelectObjectBuilder<PaginatedCriteriaBuilder<Y>> selectNew(Class<Y> clazz)

Description copied from interface: FullQueryBuilder

Starts a SelectObjectBuilder for the given class. The types of the parameter arguments used in the SelectObjectBuilder must match a constructor of the given class.

Specified by:

selectNew in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>

Type Parameters:

Y - The new query result type specified by the given class

Parameters:

clazz - The class which should be used for the select new select clause

Returns:

The select object builder for the given class

selectNew

<Y> PaginatedCriteriaBuilder<Y> selectNew(ObjectBuilder<Y> builder)

Description copied from interface: FullQueryBuilder

Applies the given object builder to this query. The object builder provides the select clauses and is used to transform the result set tuples.

Specified by:

selectNew in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>

Type Parameters:

Y - The new query result type specified by the given class

Parameters:

builder - The object builder which transforms the result set into objects of type Y

Returns:

The query builder for chaining calls