Package org.hibernate.query.specification

Interface QuerySpecification<T>

Type Parameters:

T - The root entity type.

All Known Subinterfaces:

MutationSpecification<T>, SelectionSpecification<T>

All Known Implementing Classes:

MutationSpecificationImpl, SelectionSpecificationImpl

@Incubating
public interface QuerySpecification<T>

Commonality for all query specifications which allow iterative, programmatic building of a query. A specification allows restrictions, sorting, and fetching to be added to a predefined HQL or criteria query.

• createQuery(EntityManager) obtains an executable query object associated with the given session.
• buildCriteria(CriteriaBuilder) transforms the specification to a criteria query.
• validate(CriteriaBuilder) validates the query without executing it.

This is the abstract base type of SelectionSpecification and MutationSpecification.

Since:

7.0

API Note:

Query specifications only support a single root entity.

Method Summary

Modifier and Type	Method	Description
CommonAbstractCriteria	buildCriteria(CriteriaBuilder builder)	Build a criteria query satisfying this specification, using the given CriteriaBuilder.
CommonQueryContract	createQuery(EntityManager entityManager)	Finalize the building and create executable query instance.
CommonQueryContract	createQuery(Session session)	Finalize the building and create executable query instance.
CommonQueryContract	createQuery(StatelessSession session)	Finalize the building and create executable query instance.
TypedQueryReference<?>	reference()	Obtain a reference to this specification which may be passed along to EntityManager.createQuery(TypedQueryReference).
QuerySpecification<T>	restrict(Restriction<? super T> restriction)	Adds a restriction to the query specification.
QuerySpecification<T>	validate(CriteriaBuilder builder)	Validate the query.

Method Details

restrict

QuerySpecification<T> restrict(Restriction<? super T> restriction)

Adds a restriction to the query specification.

Parameters:

restriction - The restriction predicate to be added.

Returns:

this for method chaining.

createQuery

CommonQueryContract createQuery(Session session)

Finalize the building and create executable query instance.

createQuery

CommonQueryContract createQuery(StatelessSession session)

Finalize the building and create executable query instance.

createQuery

CommonQueryContract createQuery(EntityManager entityManager)

Finalize the building and create executable query instance.

buildCriteria

CommonAbstractCriteria buildCriteria(CriteriaBuilder builder)

Build a criteria query satisfying this specification, using the given CriteriaBuilder.

If the returned criteria query is mutated, the mutations will not be not reflected in this specification.

Returns:

a new criteria query

validate

QuerySpecification<T> validate(CriteriaBuilder builder)

Validate the query.

Returns:

this if everything is fine

Throws:

Exception - if it ain't all good

reference

TypedQueryReference<?> reference()

Obtain a reference to this specification which may be passed along to EntityManager.createQuery(TypedQueryReference).