Interface JpaCriteriaQuery<T>

All Superinterfaces:

AbstractQuery<T>, CommonAbstractCriteria, CriteriaQuery<T>, CriteriaSelect<T>, JpaCriteriaBase, JpaCriteriaNode, JpaCriteriaSelect<T>, JpaCteContainer, JpaQueryableCriteria<T>, JpaSelectCriteria<T>, Serializable

All Known Implementing Classes:

CriteriaDefinition, SqmSelectStatement

public interface JpaCriteriaQuery<T>
extends CriteriaQuery<T>, JpaQueryableCriteria<T>, JpaSelectCriteria<T>, JpaCriteriaSelect<T>

Extension of the JPA CriteriaQuery

Method Summary

Modifier and Type	Method	Description
JpaCriteriaQuery<Long>	createCountQuery()	A query that returns the number of results of this query.
JpaCriteriaQuery<Boolean>	createExistsQuery()	A query that returns true if this query has any results.
JpaCriteriaQuery<T>	distinct(boolean distinct)	Set whether duplicate query results are eliminated.
JpaCriteriaQuery<T>	fetch(Number fetch)	Set the query fetch limit.
JpaCriteriaQuery<T>	fetch(Number fetch, FetchClauseType fetchClauseType)	Set the query fetch limit.
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch)	Set the query fetch limit.
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)	Set the query fetch limit.
<X> JpaRoot<X>	from(EntityType<X> entity)	Create a query root for the given entity type.
<X> JpaRoot<X>	from(Class<X> entityClass)	Create a query root for the given entity type.
HibernateCriteriaBuilder	getCriteriaBuilder()	Return the criteria builder that created this query.
JpaExpression<Number>	getFetch()	Return the query fetch expression.
FetchClauseType	getFetchClauseType()	Return the fetch clause type.
JpaExpression<Number>	getOffset()	Return the query offset expression.
Set<ParameterExpression<?>>	getParameters()
<E> JpaRoot<? extends E>	getRoot(int position, Class<E> type)	Get a query root element at the given position with the given type.
<E> JpaRoot<? extends E>	getRoot(String alias, Class<E> type)	Get a query root element with the given alias and the given type.
List<Root<?>>	getRootList()	Return the roots as a list.
JpaCriteriaQuery<T>	groupBy(Expression<?>... grouping)	Set the grouping expressions.
JpaCriteriaQuery<T>	groupBy(List<Expression<?>> grouping)	Set the grouping expressions.
JpaCriteriaQuery<T>	having(BooleanExpression... restrictions)	Set the group restriction.
JpaCriteriaQuery<T>	having(Expression<Boolean> restriction)	Set the group restriction.
JpaCriteriaQuery<T>	having(List<? extends Expression<Boolean>> restrictions)	Set the group restriction.
JpaCriteriaQuery<T>	multiselect(Selection<?>... selections)	Deprecated.
JpaCriteriaQuery<T>	multiselect(List<Selection<?>> selectionList)	Deprecated.
JpaCriteriaQuery<T>	offset(Number offset)	Set the query offset.
JpaCriteriaQuery<T>	offset(JpaExpression<? extends Number> offset)	Set the query offset.
JpaCriteriaQuery<T>	orderBy(Order... o)	Set the ordering expressions.
JpaCriteriaQuery<T>	orderBy(List<Order> o)	Set the ordering expressions.
JpaCriteriaQuery<T>	select(Selection<? extends T> selection)	Set the query selection.
<U> JpaSubQuery<U>	subquery(EntityType<U> type)	Create a subquery for the given entity type.
JpaCriteriaQuery<T>	where(BooleanExpression... restrictions)	Set the restriction.
JpaCriteriaQuery<T>	where(Expression<Boolean> restriction)	Set the restriction.
JpaCriteriaQuery<T>	where(List<? extends Expression<Boolean>> restrictions)	Set the restriction.

Methods inherited from interface AbstractQuery

getGroupList, getResultType, getRoots, isDistinct

Methods inherited from interface CriteriaQuery

getOrderList

Methods inherited from interface JpaCriteriaBase

subquery

Methods inherited from interface JpaCteContainer

getCteCriteria, getCteCriterias, with, with, withRecursiveUnionAll, withRecursiveUnionAll, withRecursiveUnionDistinct, withRecursiveUnionDistinct

Methods inherited from interface JpaSelectCriteria

from, from, from, getGroupRestriction, getQueryPart, getQuerySpec, getRestriction, getSelection

Method Details

createCountQuery

@Nonnull
JpaCriteriaQuery<Long> createCountQuery()

A query that returns the number of results of this query.

Since:

6.4

See Also:

• SelectionQuery.getResultCount()

createExistsQuery

@Incubating(since="6.3")
@Nonnull
JpaCriteriaQuery<Boolean> createExistsQuery()

A query that returns true if this query has any results.

Since:

7.1

getOffset

@Nullable
JpaExpression<Number> getOffset()

Return the query offset expression.

offset

@Nonnull
JpaCriteriaQuery<T> offset(@Nullable
 JpaExpression<? extends Number> offset)

Set the query offset.

offset

@Nonnull
JpaCriteriaQuery<T> offset(@Nullable
 Number offset)

Set the query offset.

getFetch

@Nullable
JpaExpression<Number> getFetch()

Return the query fetch expression.

fetch

@Nonnull
JpaCriteriaQuery<T> fetch(@Nullable
 JpaExpression<? extends Number> fetch)

Set the query fetch limit.

fetch

@Nonnull
JpaCriteriaQuery<T> fetch(@Nullable
 JpaExpression<? extends Number> fetch,
 @Nonnull
 FetchClauseType fetchClauseType)

Set the query fetch limit.

fetch

@Nonnull
JpaCriteriaQuery<T> fetch(@Nullable
 Number fetch)

Set the query fetch limit.

fetch

@Nonnull
JpaCriteriaQuery<T> fetch(@Nullable
 Number fetch,
 @Nonnull
 FetchClauseType fetchClauseType)

Set the query fetch limit.

getFetchClauseType

@Nonnull
FetchClauseType getFetchClauseType()

Return the fetch clause type.

getRootList

@Nonnull
List<Root<?>> getRootList()

Return the roots as a list.

Specified by:

getRootList in interface AbstractQuery<T>

getRoot

@Nonnull
<E> JpaRoot<? extends E> getRoot(int position,
 @Nonnull
 Class<E> type)

Get a query root element at the given position with the given type.

Parameters:

position - the position of this root element

type - the type of the root entity

Throws:

IllegalArgumentException - if the root entity at the given position is not of the given type, or if there are not enough root entities in the query

getRoot

@Nonnull
<E> JpaRoot<? extends E> getRoot(@Nonnull
 String alias,
 @Nonnull
 Class<E> type)

Get a query root element with the given alias and the given type.

Parameters:

alias - the identification variable of the root element

type - the type of the root entity

Throws:

IllegalArgumentException - if the root entity with the given alias is not of the given type, or if there is no root entities with the given alias

getParameters

@Nonnull
Set<ParameterExpression<?>> getParameters()

Specified by:

getParameters in interface CommonAbstractCriteria

API Note:

Warning! This actually walks the criteria tree looking for parameters nodes.

from

@Nonnull
<X> JpaRoot<X> from(@Nonnull
 Class<X> entityClass)

Create a query root for the given entity type.

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

from

@Nonnull
<X> JpaRoot<X> from(@Nonnull
 EntityType<X> entity)

Create a query root for the given entity type.

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

distinct

@Nonnull
JpaCriteriaQuery<T> distinct(boolean distinct)

Set whether duplicate query results are eliminated.

Specified by:

distinct in interface AbstractQuery<T>

Specified by:

distinct in interface CriteriaQuery<T>

Specified by:

distinct in interface JpaSelectCriteria<T>

select

@Nonnull
JpaCriteriaQuery<T> select(@Nonnull
 Selection<? extends T> selection)

Set the query selection.

Specified by:

select in interface CriteriaQuery<T>

multiselect

@Nonnull
@Deprecated
JpaCriteriaQuery<T> multiselect(@Nonnull
 Selection<?>... selections)

Deprecated.

Set the compound query selection.

Specified by:

multiselect in interface CriteriaQuery<T>

multiselect

@Nonnull
@Deprecated
JpaCriteriaQuery<T> multiselect(@Nonnull
 List<Selection<?>> selectionList)

Deprecated.

Set the compound query selection.

Specified by:

multiselect in interface CriteriaQuery<T>

where

@Nonnull
JpaCriteriaQuery<T> where(@Nonnull
 Expression<Boolean> restriction)

Set the restriction.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

where

@Nonnull
JpaCriteriaQuery<T> where(@Nonnull
 BooleanExpression... restrictions)

Set the restriction.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

where

@Nonnull
JpaCriteriaQuery<T> where(@Nonnull
 List<? extends Expression<Boolean>> restrictions)

Set the restriction.

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

groupBy

@Nonnull
JpaCriteriaQuery<T> groupBy(@Nonnull
 Expression<?>... grouping)

Set the grouping expressions.

Specified by:

groupBy in interface AbstractQuery<T>

Specified by:

groupBy in interface CriteriaQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

groupBy

@Nonnull
JpaCriteriaQuery<T> groupBy(@Nonnull
 List<Expression<?>> grouping)

Set the grouping expressions.

Specified by:

groupBy in interface AbstractQuery<T>

Specified by:

groupBy in interface CriteriaQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

having

@Nonnull
JpaCriteriaQuery<T> having(@Nonnull
 Expression<Boolean> restriction)

Set the group restriction.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

having

@Nonnull
JpaCriteriaQuery<T> having(@Nonnull
 BooleanExpression... restrictions)

Set the group restriction.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

having

@Nonnull
JpaCriteriaQuery<T> having(@Nonnull
 List<? extends Expression<Boolean>> restrictions)

Set the group restriction.

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

orderBy

@Nonnull
JpaCriteriaQuery<T> orderBy(@Nonnull
 Order... o)

Set the ordering expressions.

Specified by:

orderBy in interface CriteriaQuery<T>

orderBy

@Nonnull
JpaCriteriaQuery<T> orderBy(@Nonnull
 List<Order> o)

Set the ordering expressions.

Specified by:

orderBy in interface CriteriaQuery<T>

subquery

@Nonnull
<U> JpaSubQuery<U> subquery(@Nonnull
 EntityType<U> type)

Create a subquery for the given entity type.

Specified by:

subquery in interface CommonAbstractCriteria

getCriteriaBuilder

@Nonnull
HibernateCriteriaBuilder getCriteriaBuilder()

Return the criteria builder that created this query.