T
- The query result typeBaseQueryBuilder<T,X>
, BaseWhereBuilder<T>
, CommonQueryBuilder<T>
, ConfigurationSource
, CorrelationQueryBuilder<T>
, FetchBuilder<T>
, FromBuilder<T>
, FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
, KeysetQueryBuilder<T>
, OrderByBuilder<T>
, ParameterHolder<T>
, Queryable<T,X>
, QueryBuilder<T,X>
, SelectBuilder<T>
, ServiceProvider
, WhereBuilder<T>
public interface PaginatedCriteriaBuilder<T> extends FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
Modifier and Type | Method | Description |
---|---|---|
<Y> PaginatedCriteriaBuilder<Y> |
copy(Class<Y> resultClass) |
Copies this query builder into a new one, using it's projection as an overridable default.
|
int |
getHighestKeysetOffset() |
Returns the offset of the highest keyset relative to the page size.
|
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.
|
PaginatedTypedQuery<T> |
getQuery() |
Returns the paginated typed query for the built query.
|
PagedList<T> |
getResultList() |
Execute the query and return the result as a type PagedList.
|
boolean |
isKeysetExtraction() |
Returns whether keyset extraction is enabled or not.
|
boolean |
isWithCountQuery() |
Returns whether count query execution is enabled or not.
|
<Y> PaginatedCriteriaBuilder<Y> |
selectNew(ObjectBuilder<Y> builder) |
Applies the given object builder to this query.
|
<Y> SelectObjectBuilder<PaginatedCriteriaBuilder<Y>> |
selectNew(Class<Y> clazz) |
Starts a
SelectObjectBuilder for the given class. |
PaginatedCriteriaBuilder<T> |
withCountQuery(boolean withCountQuery) |
Enables or disables execution of the count query which determines whether
PagedList.getTotalSize() is available. |
PaginatedCriteriaBuilder<T> |
withHighestKeysetOffset(int offset) |
Sets the offset for the highest keyset which influences which element of a page is returned by
KeysetPage.getHighest() . |
PaginatedCriteriaBuilder<T> |
withKeysetExtraction(boolean keysetExtraction) |
Enable or disables keyset extraction which influences whether
PagedList.getKeysetPage() is available. |
getResultType
where, whereCase, whereExists, whereExists, whereNotExists, whereNotExists, whereSimpleCase, whereSubqueries, whereSubquery, whereSubquery, whereSubquery, whereSubquery
getCriteriaBuilderFactory, getMetamodel, isCacheable, registerMacro, setCacheable, setProperties, setProperty
getProperties, getProperty
fetch, fetch
from, from, fromIdentifiableValues, fromIdentifiableValues, fromNew, fromNew, fromOld, fromOld, fromValues, fromValues, getFrom, getFromByPath, getPath, 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
getCountQuery, innerJoinFetch, innerJoinFetchDefault, join, joinDefault, leftJoinFetch, leftJoinFetchDefault, page, page, page, rightJoinFetch, rightJoinFetchDefault, selectNew
afterKeyset, afterKeyset, afterKeyset, beforeKeyset, beforeKeyset, beforeKeyset
orderBy, orderByAsc, orderByAsc, orderByDesc, orderByDesc
containsParameter, getParameter, getParameters, getParameterValue, isParameterSet, setParameter, setParameter, setParameter, setParameterType
getQueryString, getSingleResult
getEntityManager
select, select, selectCase, selectCase, selectSimpleCase, selectSimpleCase, selectSubqueries, selectSubqueries, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery, selectSubquery
getService
setWhereExpression, setWhereExpressionSubqueries, whereOr
PaginatedTypedQuery<T> getQuery()
String getPageCountQueryString()
String getPageIdQueryString()
PaginatedCriteriaBuilder<T> withKeysetExtraction(boolean keysetExtraction)
PagedList.getKeysetPage()
is available.keysetExtraction
- true to enable, false to disable keyset extractionboolean isKeysetExtraction()
PaginatedCriteriaBuilder<T> withCountQuery(boolean withCountQuery)
PagedList.getTotalSize()
is available.withCountQuery
- true to enable, false to disable the count query executionboolean isWithCountQuery()
PaginatedCriteriaBuilder<T> withHighestKeysetOffset(int offset)
KeysetPage.getHighest()
.
This is usually used when loading N + 1 rows to know there are further rows but only needing N rows.offset
- the offset for the highest keyset relative to the page sizeint getHighestKeysetOffset()
PagedList<T> getResultList()
getResultList
in interface Queryable<T,X extends FullQueryBuilder<T,X>>
<Y> PaginatedCriteriaBuilder<Y> copy(Class<Y> resultClass)
FullQueryBuilder
copy
in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
Y
- The type of the result classresultClass
- The result class of the query<Y> SelectObjectBuilder<PaginatedCriteriaBuilder<Y>> selectNew(Class<Y> clazz)
FullQueryBuilder
SelectObjectBuilder
for the given class. The types of the parameter arguments used in the
SelectObjectBuilder
must match a constructor of the given class.selectNew
in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
Y
- The new query result type specified by the given classclazz
- The class which should be used for the select new select clause<Y> PaginatedCriteriaBuilder<Y> selectNew(ObjectBuilder<Y> builder)
FullQueryBuilder
selectNew
in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
Y
- The new query result type specified by the given classbuilder
- The object builder which transforms the result set into objects of type Y
Copyright © 2014–2018 Blazebit. All rights reserved.