Package jakarta.persistence.criteria

package jakarta.persistence.criteria
Defines the Jakarta Persistence Criteria Query API. Criteria queries allow programmatic construction or manipulation of Jakarta Persistence queries.
  • CriteriaBuilder is the entry point for constructing queries, expressions, predicates, projections, and ordering criteria.
  • CriteriaQuery represents a top-level query slection query.
  • CriteriaUpdate and CriteriaDelete represents update and delete statements, respectively.
  • Expression and its subtypes represent expressions of various types.
  • Selection represents a projected value in a query result list.
  • Order represents an ordering criterion.

This example demonstrates the use of the Criteria API: 

var builder = factory.getCriteriaBuilder();
var query = builder.createQuery(Book.class);
// specify the root entity of the query
var book = query.from(Book.class);
// fetch an association belonging to the root entity
book.fetch(Book_.authors, JoinType.LEFT);
if (titlePattern != null) {
    // add a restriction to the query
    query.where(book.get(Book_.title).like("%Persistence%"));
}
var books = agent.createQuery(query).getResultList();

The example demonstrates the use of the static metamodel type Book_ corresponding to the entity type Book to obtain references to persistent members of Book. Use of the static metamodel is usually preferred to passing string-valued attribute names during query construction.

Since:
2.0
  • Class
    Description
    AbstractQuery<T>
    The AbstractQuery interface defines functionality that is common to both top-level queries and subqueries.
    BooleanExpression
    Type for boolean query expressions.
    BooleanPath
    Represents a simple or compound attribute path from a bound type or collection, and is a "primitive" expression of a boolean type.
    CollectionJoin<Z,E>
    The CollectionJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a Collection.
    CommonAbstractCriteria
    The CommonAbstractCriteria interface defines functionality that is common to both top-level criteria queries and subqueries as well as to update and delete criteria operations.
    ComparableExpression<C extends Comparable<? super C>>
    Type for comparable query expressions.
    CompoundSelection<X>
    The CompoundSelection interface defines a compound selection item (a tuple, array, or result of a constructor).
    CriteriaBuilder
    Used to construct criteria queries, compound selections, expressions, predicates, orderings.
    CriteriaBuilder.Case<R>
    Interface used to build general case expressions.
    CriteriaBuilder.Coalesce<T>
    Interface used to build coalesce expressions.
    CriteriaBuilder.In<T>
    Interface used to build in predicates.
    CriteriaBuilder.SimpleCase<C,R>
    Interface used to build simple case expressions.
    CriteriaBuilder.Trimspec
    Used to specify how strings are trimmed.
    CriteriaDelete<T>
    The CriteriaDelete interface defines functionality for performing bulk delete operations using the Criteria API
    CriteriaQuery<T>
    The CriteriaQuery interface defines functionality that is specific to top-level queries.
    CriteriaSelect<T>
    Abstracts over top-level queries and unions and intersections of top-level queries.
    CriteriaStatement<T>
    Declares operations common to CriteriaUpdate and CriteriaDelete.
    CriteriaUpdate<T>
    The CriteriaUpdate interface defines functionality for performing bulk update operations using the Criteria API.
    Expression<T>
    Type for query expressions.
    Fetch<Z,X>
    Represents a join-fetched association or attribute.
    FetchParent<Z,X>
    Represents an element of the from clause which may function as the parent of Fetches.
    From<Z,X>
    Represents a bound type, usually an entity that appears in the from clause, but may also be an embeddable belonging to an entity in the from clause.
    Join<Z,X>
    A join to an entity, embeddable, or basic type.
    JoinType
    Defines the three varieties of join.
    ListJoin<Z,E>
    The ListJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a List.
    LocalDateField<N>
    Each instance represents a type of field which can be extracted from a LocalDate.
    LocalDateTimeField<N>
    Each instance represents a type of field which can be extracted from a LocalDateTime.
    LocalTimeField<N>
    Each instance represents a type of field which can be extracted from a LocalTime.
    MapJoin<Z,K,V>
    The MapJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a Map.
    Nulls
    Specifies the precedence of null values within query result sets.
    NumericExpression<N extends Number & Comparable<N>>
    Type for number query expressions.
    Order
    An object that defines an ordering over the query results.
    ParameterExpression<T>
    Type of criteria query parameter expressions.
    Path<X>
    Represents a simple or compound attribute path from a bound type or collection, and is a "primitive" expression.
    PluralExpression<C,E>
    Type for collection query expressions.
    PluralJoin<Z,C,E>
    The PluralJoin interface defines functionality that is common to joins to all collection types.
    Predicate
    The type of a simple or compound predicate: a conjunction or disjunction of restrictions.
    Predicate.BooleanOperator
     
    Root<X>
    A root type in the from clause.
    Selection<X>
    The Selection interface defines an item that is to be returned in a query result.
    SetJoin<Z,E>
    The SetJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a Set.
    Subquery<T>
    The Subquery interface defines functionality that is specific to subqueries.
    TemporalExpression<T extends Temporal & Comparable<? super T>>
    Type for temporal query expressions.
    TemporalField<N, T extends Temporal>
    Each instance represents a type of field which can be extracted from a date, time, or datetime.
    TextExpression
    Type for string query expressions.