Package org.hibernate.query.criteria

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)
JpaCriteriaQuery<T>	fetch(Number fetch)
JpaCriteriaQuery<T>	fetch(Number fetch, FetchClauseType fetchClauseType)
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch)
JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)
<X> JpaRoot<X>	from(EntityType<X> entity)
<X> JpaRoot<X>	from(Class<X> entityClass)
HibernateCriteriaBuilder	getCriteriaBuilder()
JpaExpression<Number>	getFetch()
FetchClauseType	getFetchClauseType()
JpaExpression<Number>	getOffset()
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<? extends JpaRoot<?>>	getRootList()	Return the roots as a list.
JpaCriteriaQuery<T>	groupBy(Expression<?>... grouping)
JpaCriteriaQuery<T>	groupBy(List<Expression<?>> grouping)
JpaCriteriaQuery<T>	having(Expression<Boolean> restriction)
JpaCriteriaQuery<T>	having(Predicate... restrictions)
JpaCriteriaQuery<T>	having(List<Predicate> restrictions)
JpaCriteriaQuery<T>	multiselect(Selection<?>... selections)	Deprecated.
JpaCriteriaQuery<T>	multiselect(List<Selection<?>> selectionList)	Deprecated.
JpaCriteriaQuery<T>	offset(Number offset)
JpaCriteriaQuery<T>	offset(JpaExpression<? extends Number> offset)
JpaCriteriaQuery<T>	orderBy(Order... o)
JpaCriteriaQuery<T>	orderBy(List<Order> o)
JpaCriteriaQuery<T>	select(Selection<? extends T> selection)
<U> JpaSubQuery<U>	subquery(EntityType<U> type)
JpaCriteriaQuery<T>	where(Expression<Boolean> restriction)
JpaCriteriaQuery<T>	where(Predicate... restrictions)
JpaCriteriaQuery<T>	where(List<Predicate> restrictions)

Methods inherited from interface jakarta.persistence.criteria.AbstractQuery

getGroupList, getResultType, getRoots, isDistinct

Methods inherited from interface jakarta.persistence.criteria.CriteriaQuery

getOrderList

Methods inherited from interface org.hibernate.query.criteria.JpaCriteriaBase

subquery

Methods inherited from interface org.hibernate.query.criteria.JpaCteContainer

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

Methods inherited from interface org.hibernate.query.criteria.JpaSelectCriteria

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

Method Details

createCountQuery

JpaCriteriaQuery<Long> createCountQuery()

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

Since:

6.4

See Also:

• SelectionQuery.getResultCount()

createExistsQuery

@Incubating
JpaCriteriaQuery<Boolean> createExistsQuery()

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

Since:

7.1

getOffset

JpaExpression<Number> getOffset()

offset

JpaCriteriaQuery<T> offset(JpaExpression<? extends Number> offset)

offset

JpaCriteriaQuery<T> offset(Number offset)

getFetch

JpaExpression<Number> getFetch()

fetch

JpaCriteriaQuery<T> fetch(JpaExpression<? extends Number> fetch)

fetch

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

fetch

JpaCriteriaQuery<T> fetch(Number fetch)

fetch

JpaCriteriaQuery<T> fetch(Number fetch,
 FetchClauseType fetchClauseType)

getFetchClauseType

FetchClauseType getFetchClauseType()

getRootList

List<? extends JpaRoot<?>> getRootList()

Return the roots as a list.

getRoot

<E> JpaRoot<? extends E> getRoot(int position,
 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

<E> JpaRoot<? extends E> getRoot(String alias,
 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

Set<ParameterExpression<?>> getParameters()

Specified by:

getParameters in interface CommonAbstractCriteria

API Note:

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

from

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

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

from

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

Specified by:

from in interface AbstractQuery<T>

Specified by:

from in interface JpaSelectCriteria<T>

distinct

JpaCriteriaQuery<T> distinct(boolean distinct)

Specified by:

distinct in interface AbstractQuery<T>

Specified by:

distinct in interface CriteriaQuery<T>

Specified by:

distinct in interface JpaSelectCriteria<T>

select

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

Specified by:

select in interface CriteriaQuery<T>

multiselect

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

Deprecated.

Specified by:

multiselect in interface CriteriaQuery<T>

multiselect

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

Deprecated.

Specified by:

multiselect in interface CriteriaQuery<T>

where

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

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

where

JpaCriteriaQuery<T> where(Predicate... restrictions)

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

Specified by:

where in interface JpaSelectCriteria<T>

where

JpaCriteriaQuery<T> where(List<Predicate> restrictions)

Specified by:

where in interface AbstractQuery<T>

Specified by:

where in interface CriteriaQuery<T>

groupBy

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

Specified by:

groupBy in interface AbstractQuery<T>

Specified by:

groupBy in interface CriteriaQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

groupBy

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

Specified by:

groupBy in interface AbstractQuery<T>

Specified by:

groupBy in interface CriteriaQuery<T>

Specified by:

groupBy in interface JpaSelectCriteria<T>

having

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

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

having

JpaCriteriaQuery<T> having(Predicate... restrictions)

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

Specified by:

having in interface JpaSelectCriteria<T>

having

JpaCriteriaQuery<T> having(List<Predicate> restrictions)

Specified by:

having in interface AbstractQuery<T>

Specified by:

having in interface CriteriaQuery<T>

orderBy

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

Specified by:

orderBy in interface CriteriaQuery<T>

orderBy

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

Specified by:

orderBy in interface CriteriaQuery<T>

subquery

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

Specified by:

subquery in interface CommonAbstractCriteria

getCriteriaBuilder

HibernateCriteriaBuilder getCriteriaBuilder()