Package org.hibernate.query.specification.internal

Class SelectionSpecificationImpl<T>

java.lang.Object

org.hibernate.query.specification.internal.SelectionSpecificationImpl<T>

All Implemented Interfaces:

TypedQueryReference<T>, QuerySpecification<T>, SelectionSpecification<T>

public class SelectionSpecificationImpl<T>
extends Object
implements SelectionSpecification<T>, TypedQueryReference<T>

Standard implementation of SelectionSpecification

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.specification.SelectionSpecification

SelectionSpecification.Augmentation<T>

Constructor Summary

Constructors

Constructor	Description
SelectionSpecificationImpl(CriteriaQuery<T> criteriaQuery)
SelectionSpecificationImpl(Class<T> resultType)
SelectionSpecificationImpl(String hql, Class<T> resultType)

Method Summary

Modifier and Type	Method	Description
SelectionSpecification<T>	augment(SelectionSpecification.Augmentation<T> augmentation)	Add an augmentation to the specification.
CriteriaQuery<T>	buildCriteria(CriteriaBuilder builder)	Build a criteria query satisfying this specification, using the given CriteriaBuilder.
SelectionQuery<T>	createQuery(EntityManager entityManager)	Finalize the building and create executable query instance.
SelectionQuery<T>	createQuery(Session session)	Finalize the building and create executable query instance.
SelectionQuery<T>	createQuery(SharedSessionContract session)
SelectionQuery<T>	createQuery(StatelessSession session)	Finalize the building and create executable query instance.
SelectionSpecification<T>	fetch(Path<T,?> fetchPath)	Add a fetch path to the specification.
Map<String,Object>	getHints()
String	getName()
Class<T>	getResultType()
TypedQueryReference<T>	reference()	Obtain a reference to this specification which may be passed along to EntityManager.createQuery(TypedQueryReference).
final SelectionSpecification<T>	resort(List<? extends Order<? super T>> orders)	Sets the sorting for this selection specification.
final SelectionSpecification<T>	resort(Order<? super T> order)	Sets the ordering for this selection specification.
SelectionSpecification<T>	restrict(Restriction<? super T> restriction)	Adds a restriction to the query specification.
SelectionSpecification<T>	sort(Order<? super T> order)	Adds an ordering to the selection specification.
SelectionSpecification<T>	validate(CriteriaBuilder builder)	Validate the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SelectionSpecificationImpl

public SelectionSpecificationImpl(Class<T> resultType)

SelectionSpecificationImpl

public SelectionSpecificationImpl(String hql,
 Class<T> resultType)

SelectionSpecificationImpl

public SelectionSpecificationImpl(CriteriaQuery<T> criteriaQuery)

Method Details

getName

public String getName()

Specified by:

getName in interface TypedQueryReference<T>

getResultType

public Class<T> getResultType()

Specified by:

getResultType in interface TypedQueryReference<T>

getHints

public Map<String,Object> getHints()

Specified by:

getHints in interface TypedQueryReference<T>

reference

public TypedQueryReference<T> reference()

Description copied from interface: QuerySpecification

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

Specified by:

reference in interface QuerySpecification<T>

Specified by:

reference in interface SelectionSpecification<T>

restrict

public SelectionSpecification<T> restrict(Restriction<? super T> restriction)

Description copied from interface: QuerySpecification

Adds a restriction to the query specification.

Specified by:

restrict in interface QuerySpecification<T>

Specified by:

restrict in interface SelectionSpecification<T>

Parameters:

restriction - The restriction predicate to be added.

Returns:

this for method chaining.

augment

public SelectionSpecification<T> augment(SelectionSpecification.Augmentation<T> augmentation)

Description copied from interface: SelectionSpecification

Add an augmentation to the specification.

For example:

 SelectionSpecification.create(Book.class)
       .augment((builder, query, book) ->
               // augment the query via JPA Criteria API
               query.where(builder.like(book.get(Book_.title), titlePattern)),
                           builder.greaterThan(book.get(Book_.pages), minPages))
                   .orderBy(builder.asc(book.get(Book_.isbn)))
       .createQuery(session)
       .getResultList();
 

For complicated cases, a CriteriaDefinition may be used within an augmentation to eliminate repetitive explicit references to the CriteriaBuilder.

 SelectionSpecification.create(Book.class)
       .augment((builder, query, book) ->
           // eliminate explicit references to 'builder'
           new CriteriaDefinition<>(query) {{
               where(like(entity.get(BasicEntity_.title), titlePattern),
                     greaterThan(book.get(Book_.pages), minPages));
               orderBy(asc(book.get(Book_.isbn)));
           }}
       )
       .createQuery(session)
       .getResultList();
 

Specified by:

augment in interface SelectionSpecification<T>

Parameters:

augmentation - A function capable of modifying or augmenting a criteria query.

Returns:

this for method chaining.

fetch

public SelectionSpecification<T> fetch(Path<T,?> fetchPath)

Description copied from interface: SelectionSpecification

Add a fetch path to the specification.

Specified by:

fetch in interface SelectionSpecification<T>

Parameters:

fetchPath - The path to fetch

Returns:

this for method chaining.

sort

public SelectionSpecification<T> sort(Order<? super T> order)

Description copied from interface: SelectionSpecification

Adds an ordering to the selection specification. Appended to any previous ordering.

Specified by:

sort in interface SelectionSpecification<T>

Parameters:

order - The ordering fragment to be added.

Returns:

this for method chaining.

resort

public final SelectionSpecification<T> resort(Order<? super T> order)

Description copied from interface: SelectionSpecification

Sets the ordering for this selection specification. If ordering was already defined, this method drops the previous ordering in favor of the passed orders.

Specified by:

resort in interface SelectionSpecification<T>

Parameters:

order - The ordering fragment to be used.

Returns:

this for method chaining.

resort

public final SelectionSpecification<T> resort(List<? extends Order<? super T>> orders)

Description copied from interface: SelectionSpecification

Sets the sorting for this selection specification. If sorting was already defined, this method drops the previous sorting in favor of the passed orders.

Specified by:

resort in interface SelectionSpecification<T>

Parameters:

orders - The sorting fragments to be used.

Returns:

this for method chaining.

createQuery

public SelectionQuery<T> createQuery(Session session)

Description copied from interface: QuerySpecification

Finalize the building and create executable query instance.

Specified by:

createQuery in interface QuerySpecification<T>

Specified by:

createQuery in interface SelectionSpecification<T>

createQuery

public SelectionQuery<T> createQuery(StatelessSession session)

Description copied from interface: QuerySpecification

Finalize the building and create executable query instance.

Specified by:

createQuery in interface QuerySpecification<T>

Specified by:

createQuery in interface SelectionSpecification<T>

createQuery

public SelectionQuery<T> createQuery(SharedSessionContract session)

createQuery

public SelectionQuery<T> createQuery(EntityManager entityManager)

Description copied from interface: QuerySpecification

Finalize the building and create executable query instance.

Specified by:

createQuery in interface QuerySpecification<T>

Specified by:

createQuery in interface SelectionSpecification<T>

buildCriteria

public CriteriaQuery<T> buildCriteria(CriteriaBuilder builder)

Description copied from interface: SelectionSpecification

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.

Specified by:

buildCriteria in interface QuerySpecification<T>

Specified by:

buildCriteria in interface SelectionSpecification<T>

Returns:

a new criteria query

validate

public SelectionSpecification<T> validate(CriteriaBuilder builder)

Description copied from interface: QuerySpecification

Validate the query.

Specified by:

validate in interface QuerySpecification<T>

Specified by:

validate in interface SelectionSpecification<T>

Returns:

this if everything is fine