T
- The query result typeBaseQueryBuilder<T,X>
, BaseWhereBuilder<T>
, CommonQueryBuilder<T>
, ConfigurationSource
, CorrelationQueryBuilder<T>
, FetchBuilder<T>
, FromBaseBuilder<T>
, FromBuilder<T>
, FromProvider
, FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
, KeysetQueryBuilder<T>
, OrderByBuilder<T>
, ParameterHolder<T>
, Queryable<T,X>
, QueryBuilder<T,X>
, SelectBuilder<T>
, ServiceProvider
, WhereBuilder<T>
, WindowContainerBuilder<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.
|
CriteriaBuilder<Object[]> |
createPageIdQuery() |
Creates and returns a new
CriteriaBuilder that can be used to query the id values for the current page. |
javax.persistence.TypedQuery<Long> |
getCountQuery() |
Returns the count query that selects the count of root elements.
|
String |
getCountQueryString() |
Delegates to
getPageCountQueryString() . |
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.
|
boolean |
isWithExtractAllKeysets() |
Returns whether keyset extraction is enabled or not.
|
boolean |
isWithForceIdQuery() |
Returns whether id query use is forced.
|
boolean |
isWithInlineCountQuery() |
Returns whether count query should be inlined.
|
boolean |
isWithInlineIdQuery() |
Returns whether id query should be inlined.
|
<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> |
withExtractAllKeysets(boolean withExtractAllKeysets) |
Enable or disables keyset extraction for all rows which influences whether
PagedList.getKeysetPage() is available. |
PaginatedCriteriaBuilder<T> |
withForceIdQuery(boolean withForceIdQuery) |
Forces the use of an id query even if the pagination would not need it.
|
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> |
withInlineCountQuery(boolean withInlineCountQuery) |
Forces the inlining of an count query into the object or id query.
|
PaginatedCriteriaBuilder<T> |
withInlineIdQuery(boolean withInlineIdQuery) |
Forces the inlining of an id query into the object query.
|
PaginatedCriteriaBuilder<T> |
withKeysetExtraction(boolean keysetExtraction) |
Enable or disables keyset extraction which influences whether
PagedList.getKeysetPage() is available. |
getResultType
where, whereCase, whereExists, whereExists, whereExpression, whereExpressionSubqueries, whereNotExists, whereNotExists, whereSimpleCase, whereSubqueries, whereSubquery, whereSubquery, whereSubquery, whereSubquery
getCriteriaBuilderFactory, getMetamodel, isCacheable, registerMacro, setCacheable, setProperties, setProperty
getProperties, getProperty
fetch, fetch
fromEntitySubquery, fromEntitySubquery, fromEntitySubquery, fromSubquery, fromSubquery
from, from, from, from, fromIdentifiableValues, fromIdentifiableValues, fromIdentifiableValues, fromIdentifiableValues, fromNew, fromNew, fromOld, fromOld, fromValues, fromValues, fromValues, fromValues, getFrom, getFromByPath, getPath, getRoots, innerJoin, innerJoinDefault, innerJoinDefaultOn, innerJoinLateralEntitySubquery, innerJoinLateralEntitySubquery, innerJoinLateralEntitySubquery, innerJoinLateralOnEntitySubquery, innerJoinLateralOnEntitySubquery, innerJoinLateralOnEntitySubquery, innerJoinLateralOnSubquery, innerJoinLateralOnSubquery, innerJoinLateralOnSubquery, innerJoinLateralSubquery, innerJoinLateralSubquery, innerJoinLateralSubquery, innerJoinOn, innerJoinOn, innerJoinOn, innerJoinOn, innerJoinOn, innerJoinOnEntitySubquery, innerJoinOnEntitySubquery, innerJoinOnEntitySubquery, innerJoinOnEntitySubquery, innerJoinOnSubquery, innerJoinOnSubquery, join, joinDefault, joinDefaultOn, joinLateralEntitySubquery, joinLateralEntitySubquery, joinLateralEntitySubquery, joinLateralOnEntitySubquery, joinLateralOnEntitySubquery, joinLateralOnEntitySubquery, joinLateralOnSubquery, joinLateralOnSubquery, joinLateralOnSubquery, joinLateralSubquery, joinLateralSubquery, joinLateralSubquery, joinOn, joinOn, joinOn, joinOn, joinOn, joinOnEntitySubquery, joinOnEntitySubquery, joinOnEntitySubquery, joinOnEntitySubquery, joinOnSubquery, joinOnSubquery, leftJoin, leftJoinDefault, leftJoinDefaultOn, leftJoinLateralEntitySubquery, leftJoinLateralEntitySubquery, leftJoinLateralEntitySubquery, leftJoinLateralOnEntitySubquery, leftJoinLateralOnEntitySubquery, leftJoinLateralOnEntitySubquery, leftJoinLateralOnSubquery, leftJoinLateralOnSubquery, leftJoinLateralOnSubquery, leftJoinLateralSubquery, leftJoinLateralSubquery, leftJoinLateralSubquery, leftJoinOn, leftJoinOn, leftJoinOn, leftJoinOn, leftJoinOn, leftJoinOnEntitySubquery, leftJoinOnEntitySubquery, leftJoinOnEntitySubquery, leftJoinOnEntitySubquery, leftJoinOnSubquery, leftJoinOnSubquery, rightJoin, rightJoinDefault, rightJoinDefaultOn, rightJoinOn, rightJoinOn, rightJoinOn, rightJoinOn, rightJoinOn, rightJoinOnEntitySubquery, rightJoinOnEntitySubquery, rightJoinOnEntitySubquery, rightJoinOnEntitySubquery, rightJoinOnSubquery, rightJoinOnSubquery
createPageIdQuery, createPageIdQuery, createPageIdQuery, createPageIdQuery, innerJoinFetch, innerJoinFetchDefault, join, joinDefault, leftJoinFetch, leftJoinFetchDefault, page, page, page, pageAndNavigate, pageBy, pageBy, pageBy, pageBy, pageByAndNavigate, pageByAndNavigate, rightJoinFetch, rightJoinFetchDefault, selectNew
afterKeyset, afterKeyset, afterKeyset, beforeKeyset, beforeKeyset, beforeKeyset
orderBy, 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
window
PaginatedTypedQuery<T> getQuery()
javax.persistence.TypedQuery<Long> getCountQuery()
PaginatedTypedQuery.getTotalCount()
.getCountQuery
in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
String getCountQueryString()
getPageCountQueryString()
.getCountQueryString
in interface FullQueryBuilder<T,PaginatedCriteriaBuilder<T>>
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> withExtractAllKeysets(boolean withExtractAllKeysets)
PagedList.getKeysetPage()
is available.withExtractAllKeysets
- true to enable, false to disable keyset extraction for all rowsboolean isWithExtractAllKeysets()
PaginatedCriteriaBuilder<T> withCountQuery(boolean withCountQuery)
PagedList.getTotalSize()
is available.withCountQuery
- true to enable, false to disable the count query executionboolean isWithCountQuery()
PaginatedCriteriaBuilder<T> withForceIdQuery(boolean withForceIdQuery)
withForceIdQuery
- true to force id query use, false otherwiseboolean isWithForceIdQuery()
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()
PaginatedCriteriaBuilder<T> withInlineIdQuery(boolean withInlineIdQuery)
withInlineIdQuery
- true to inline the id query, false otherwiseboolean isWithInlineIdQuery()
PaginatedCriteriaBuilder<T> withInlineCountQuery(boolean withInlineCountQuery)
withInlineCountQuery
- true to inline the count query, false otherwiseboolean isWithInlineCountQuery()
CriteriaBuilder<Object[]> createPageIdQuery()
CriteriaBuilder
that can be used to query the id values for the current page.CriteriaBuilder
to query id valuesPagedList<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–2020 Blazebit. All rights reserved.