Top Description Interfaces Classes Enums
[default module]

Package org.hibernate.query.criteria

Annotations
@Incubating
Imports
jakarta.persistence.criteria.Subquery, .AbstractQuery, org.hibernate.Incubating

The JPA-standard criteria query API defines all the operations needed express any query written in standard JPQL. This package extends the JPA-defined API, allowing any query written in HQL to be expressed via the criteria API.

The gateway to this functionality is org.hibernate.query.criteria.HibernateCriteriaBuilder, which extends jakarta.persistence.criteria.CriteriaBuilder.

Types defined in this package extend the equivalent types in jakarta.persistence.criteria with additional operations. For example, org.hibernate.query.criteria.JpaCriteriaQuery adds the methods:

The very useful operation org.hibernate.query.criteria.HibernateCriteriaBuilder#createQuery(java.lang.String, java.lang.Class) transforms a given HQL query string to an equivalent criteria query.

The class org.hibernate.query.criteria.CriteriaDefinition is a helpful utility that makes it easier to construct criteria queries.

See Also
org.hibernate.query.criteria.HibernateCriteriaBuilder, org.hibernate.query.criteria.JpaCriteriaQuery, org.hibernate.query.criteria.JpaCriteriaUpdate, org.hibernate.query.criteria.JpaCriteriaDelete, org.hibernate.query.criteria.JpaCriteriaInsertValues, org.hibernate.query.criteria.JpaCriteriaInsertSelect, org.hibernate.query.criteria.JpaCteCriteria, org.hibernate.query.criteria.JpaSubQuery, org.hibernate.query.criteria.JpaExpression, org.hibernate.query.criteria.HibernateCriteriaBuilder#createQuery(java.lang.String, java.lang.Class), org.hibernate.query.criteria.CriteriaDefinition

Interface Summary

Modifier and TypeInterface and Description
public interface
HibernateCriteriaBuilder

A JPA CriteriaBuilder is a source of objects which may be composed to express a criteria query.

public interface
public interface
JpaCollectionJoin<O, T>

Specialization of JpaJoin for java.util.Collection typed attribute joins

public interface
public interface
public interface
public interface
JpaCriteriaInsertSelect<T>

A representation of SqmInsertSelectStatement at the org.hibernate.query.criteria level, even though JPA does not define support for insert-select criteria.

public interface
JpaCriteriaInsertValues<T>

A representation of SqmInsertValuesStatement at the org.hibernate.query.criteria level, even though JPA does not define support for insert-values criteria.

public interface
JpaCriteriaNode

Base contract for nodes making up the criteria tree

public interface
JpaCriteriaQuery<T>

Extension of the JPA CriteriaQuery

public interface
public interface
public interface
JpaCteContainer

Common contract for criteria parts that can hold CTEs (common table expressions).

public interface
JpaCteCriteria<T>

A CTE (common table expression) criteria.

public interface
JpaCteCriteriaAttribute

Describes the attribute of a JpaCteCriteriaType.

public interface
JpaCteCriteriaType<T>

A CTE (common table expression) criteria type.

public interface
public interface
public interface
public interface
public interface
JpaExpression<T>

API extension to the JPA Expression contract

public interface
JpaFetch<O, T>

public interface
public interface
JpaFrom<O, T>

API extension to the JPA From contract

public interface
JpaFunction<
The type of the function result.
T
>

Contract for expressions which model a SQL function call.

public interface
public interface
JpaJoin<O, T>

Consolidates the Join and Fetch hierarchies since that is how we implement them.

public interface
JpaJoinedFrom<O, T>

Exists within the hierarchy mainly to support "entity joins".

public interface
JpaListJoin<O, T>

Specialization of JpaJoin for java.util.List typed attribute joins

public interface
public interface
JpaMapJoin<O, K, V>

Specialization of JpaJoin for java.util.Map typed attribute joins

public interface
public interface
public interface
JpaPath<T>

API extension to the JPA Path contract

public interface
JpaPluralJoin<O, C, E>

Specialization of JpaJoin for java.util.Set typed attribute joins

public interface
public interface
JpaQueryableCriteria<T>

Common contract for the forms of criteria that are "queryable" - can be converted into a Query.

public interface
JpaQueryGroup<T>

A query group i.e. query parts connected with a set operator.

public interface
JpaQueryPart<T>

Models a query part i.e. the commonalities between a query group and a query specification.

public interface
JpaQueryStructure<T>

Models a SELECT query.

public interface
public interface
public interface
JpaSearchOrder

Represents the search order for a recursive CTE (common table expression).

public interface
JpaSelectCriteria<T>

Commonality between a JPA JpaCriteriaQuery and JpaSubQuery, mainly in the form of delegation to JpaQueryStructure

public interface
JpaSelection<T>

API extension to the JPA Selection contract

public interface
JpaSetJoin<O, T>

Specialization of JpaJoin for java.util.Set typed attribute joins

public interface
public interface
public interface
JpaTupleElement<T>

API extension to the JPA TupleElement contract

public interface
JpaWindow

Common contract for window parts used in window and aggregate functions.

public interface
JpaWindowFrame

Common contract for a JpaWindow frame specification.

Class Summary

Modifier and TypeClass and Description
public abstract class
CriteriaDefinition<
the query result type
R
>

A utility class that makes it easier to build criteria queries.

Enum Summary

Modifier and TypeEnum and Description
public enum
ValueHandlingMode

This enum defines how values passed to JPA Criteria API are handled.