org.apache.deltaspike.data.api.criteria

Interface Criteria<C,R>

Type Parameters:

C - Entity type.

R - Result type.

public interface Criteria<C,R>

Criteria API utilities.

Method Summary

Modifier and Type	Method and Description
<P extends Comparable<? super P>> Criteria<C,R>	between(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P lower, P upper) Between predicate.
javax.persistence.TypedQuery<R>	createQuery() Creates a JPA query object to be executed.
Criteria<C,R>	distinct() Apply a distinct on the query.
<P extends Collection<?>> Criteria<C,R>	empty(javax.persistence.metamodel.SingularAttribute<? super C,P> att) Empty predicate.
<P> Criteria<C,R>	eq(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P value) Equals predicate.
<P> Criteria<C,R>	eqIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att, String value) Equals predicate, case insensitive.
<P,E> Criteria<C,R>	fetch(javax.persistence.metamodel.PluralAttribute<? super C,P,E> att) Fetch join an attribute.
<P,E> Criteria<C,R>	fetch(javax.persistence.metamodel.PluralAttribute<? super C,P,E> att, javax.persistence.criteria.JoinType joinType) Fetch join an attribute.
<P,E> Criteria<C,R>	fetch(javax.persistence.metamodel.SingularAttribute<? super C,P> att) Fetch join an attribute.
<P,E> Criteria<C,R>	fetch(javax.persistence.metamodel.SingularAttribute<? super C,P> att, javax.persistence.criteria.JoinType joinType) Fetch join an attribute.
R	getAnyResult() Executes the query and returns a single result.
R	getOptionalResult() Executes the query which has a single result.
List<R>	getResultList() Executes the query and returns the result list.
R	getSingleResult() Executes the query which has a single result.
<P extends Comparable<? super P>> Criteria<C,R>	gt(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P value) Greater than predicate.
<P extends Comparable<? super P>> Criteria<C,R>	gtOrEq(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P value) Greater than or equals predicate.
<P> Criteria<C,R>	in(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P... values) In predicte.
<P> Criteria<C,R>	isNull(javax.persistence.metamodel.SingularAttribute<? super C,P> att) IsNull predicate.
<P,E> Criteria<C,R>	join(javax.persistence.metamodel.CollectionAttribute<? super C,P> att, Criteria<P,P> criteria) Join a collection attribute with another Criteria.
<P,E> Criteria<C,R>	join(javax.persistence.metamodel.ListAttribute<? super C,P> att, Criteria<P,P> criteria) Join a collection attribute with another Criteria.
<P,E> Criteria<C,R>	join(javax.persistence.metamodel.MapAttribute<? super C,E,P> att, Criteria<P,P> criteria) Join a collection attribute with another Criteria.
<P,E> Criteria<C,R>	join(javax.persistence.metamodel.SetAttribute<? super C,P> att, Criteria<P,P> criteria) Join a collection attribute with another Criteria.
<P,E> Criteria<C,R>	join(javax.persistence.metamodel.SingularAttribute<? super C,P> att, Criteria<P,P> criteria) Join an attribute with another Criteria.
<P> Criteria<C,R>	like(javax.persistence.metamodel.SingularAttribute<? super C,String> att, String value) Like predicate.
<P> Criteria<C,R>	likeIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att, String value) Like predicate, case insensitive.
<P extends Comparable<? super P>> Criteria<C,R>	lt(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P value) Less than predicate.
<P extends Comparable<? super P>> Criteria<C,R>	ltOrEq(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P value) Less than or equals predicate.
<P extends Collection<?>> Criteria<C,R>	notEmpty(javax.persistence.metamodel.SingularAttribute<? super C,P> att) Not empty predicate.
<P> Criteria<C,R>	notEq(javax.persistence.metamodel.SingularAttribute<? super C,P> att, P value) Not Equals predicate.
<P> Criteria<C,R>	notEqIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att, String value) Not Equals predicate, case insensitive.
<P> Criteria<C,R>	notLike(javax.persistence.metamodel.SingularAttribute<? super C,String> att, String value) Not like predicate.
<P> Criteria<C,R>	notLikeIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att, String value) Not like predicate, case insensitive.
<P> Criteria<C,R>	notNull(javax.persistence.metamodel.SingularAttribute<? super C,P> att) NotNull predicate.
Criteria<C,R>	or(Collection<Criteria<C,R>> criteria) Boolean OR with another Criteria.
Criteria<C,R>	or(Criteria<C,R>... criteria) Boolean OR with another Criteria.
<P> Criteria<C,R>	orderAsc(javax.persistence.metamodel.SingularAttribute<? super C,P> att) Apply sorting by an attribute, ascending direction.
<P> Criteria<C,R>	orderDesc(javax.persistence.metamodel.SingularAttribute<? super C,P> att) Apply sorting by an attribute, descending direction.
List<javax.persistence.criteria.Predicate>	predicates(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.Path<C> path) Return the list of predicates applicable for this Criteria instance.
<N> Criteria<C,N>	select(Class<N> resultClass, QuerySelection<? super C,?>... selection) Create a select query.
Criteria<C,Object[]>	select(QuerySelection<? super C,?>... selection) Create a select query.

Method Detail

getResultList

List<R> getResultList()

Executes the query and returns the result list.

Returns:

List of entities matching the query.

getSingleResult

R getSingleResult()

Executes the query which has a single result.

Returns:

Entity matching the search query.

getOptionalResult

R getOptionalResult()

Executes the query which has a single result. Returns null if there is no result.

Returns:

Entity matching the search query, or null if there is none.

getAnyResult

R getAnyResult()

Executes the query and returns a single result. If there are multiple results, the first received is returned.

Returns:

Entity matching the search query.

createQuery

javax.persistence.TypedQuery<R> createQuery()

Creates a JPA query object to be executed.

Returns:

A TypedQuery object ready to return results.

or

Criteria<C,R> or(Criteria<C,R>... criteria)

Boolean OR with another Criteria.

Parameters:

criteria - The right side of the boolean OR.

Returns:

Fluent API: Criteria instance.

or

Criteria<C,R> or(Collection<Criteria<C,R>> criteria)

Boolean OR with another Criteria.

Parameters:

criteria - The right side of the boolean OR.

Returns:

Fluent API: Criteria instance.

join

<P,E> Criteria<C,R> join(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                         Criteria<P,P> criteria)

Join an attribute with another Criteria.

Parameters:

att - The attribute to join.

criteria - The join criteria.

Returns:

Fluent API: Criteria instance.

join

<P,E> Criteria<C,R> join(javax.persistence.metamodel.ListAttribute<? super C,P> att,
                         Criteria<P,P> criteria)

Join a collection attribute with another Criteria.

Parameters:

att - The attribute to join.

criteria - The join criteria.

Returns:

Fluent API: Criteria instance.

join

<P,E> Criteria<C,R> join(javax.persistence.metamodel.CollectionAttribute<? super C,P> att,
                         Criteria<P,P> criteria)

Join a collection attribute with another Criteria.

Parameters:

att - The attribute to join.

criteria - The join criteria.

Returns:

Fluent API: Criteria instance.

join

<P,E> Criteria<C,R> join(javax.persistence.metamodel.SetAttribute<? super C,P> att,
                         Criteria<P,P> criteria)

Join a collection attribute with another Criteria.

Parameters:

att - The attribute to join.

criteria - The join criteria.

Returns:

Fluent API: Criteria instance.

join

<P,E> Criteria<C,R> join(javax.persistence.metamodel.MapAttribute<? super C,E,P> att,
                         Criteria<P,P> criteria)

Join a collection attribute with another Criteria.

Parameters:

att - The attribute to join.

criteria - The join criteria.

Returns:

Fluent API: Criteria instance.

fetch

<P,E> Criteria<C,R> fetch(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

Fetch join an attribute.

Parameters:

att - The attribute to fetch.

Returns:

Fluent API: Criteria instance.

fetch

<P,E> Criteria<C,R> fetch(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                          javax.persistence.criteria.JoinType joinType)

Fetch join an attribute.

Parameters:

att - The attribute to fetch.

joinType - The JoinType to use.

Returns:

Fluent API: Criteria instance.

fetch

<P,E> Criteria<C,R> fetch(javax.persistence.metamodel.PluralAttribute<? super C,P,E> att)

Fetch join an attribute.

Parameters:

att - The attribute to fetch.

Returns:

Fluent API: Criteria instance.

fetch

<P,E> Criteria<C,R> fetch(javax.persistence.metamodel.PluralAttribute<? super C,P,E> att,
                          javax.persistence.criteria.JoinType joinType)

Fetch join an attribute.

Parameters:

att - The attribute to fetch.

joinType - The JoinType to use.

Returns:

Fluent API: Criteria instance.

orderAsc

<P> Criteria<C,R> orderAsc(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

Apply sorting by an attribute, ascending direction.

Parameters:

att - The attribute to order for.

Returns:

Fluent API: Criteria instance.

orderDesc

<P> Criteria<C,R> orderDesc(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

Apply sorting by an attribute, descending direction.

Parameters:

att - The attribute to order for.

Returns:

Fluent API: Criteria instance.

select

<N> Criteria<C,N> select(Class<N> resultClass,
                         QuerySelection<? super C,?>... selection)

Create a select query.

Parameters:

resultClass - The query result class.

selection - List of selects (attributes, scalars...)

Returns:

Fluent API: Criteria instance.

select

Criteria<C,Object[]> select(QuerySelection<? super C,?>... selection)

Create a select query.

Parameters:

selection - List of selects (attributes, scalars...)

Returns:

Fluent API: Criteria instance.

distinct

Criteria<C,R> distinct()

Apply a distinct on the query.

Returns:

Fluent API: Criteria instance.

eq

<P> Criteria<C,R> eq(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                     P value)

Equals predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

eqIgnoreCase

<P> Criteria<C,R> eqIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att,
                               String value)

Equals predicate, case insensitive.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

notEq

<P> Criteria<C,R> notEq(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                        P value)

Not Equals predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

notEqIgnoreCase

<P> Criteria<C,R> notEqIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att,
                                  String value)

Not Equals predicate, case insensitive.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

like

<P> Criteria<C,R> like(javax.persistence.metamodel.SingularAttribute<? super C,String> att,
                       String value)

Like predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

likeIgnoreCase

<P> Criteria<C,R> likeIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att,
                                 String value)

Like predicate, case insensitive.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

notLike

<P> Criteria<C,R> notLike(javax.persistence.metamodel.SingularAttribute<? super C,String> att,
                          String value)

Not like predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

notLikeIgnoreCase

<P> Criteria<C,R> notLikeIgnoreCase(javax.persistence.metamodel.SingularAttribute<? super C,String> att,
                                    String value)

Not like predicate, case insensitive.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

lt

<P extends Comparable<? super P>> Criteria<C,R> lt(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                                                   P value)

Less than predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

ltOrEq

<P extends Comparable<? super P>> Criteria<C,R> ltOrEq(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                                                       P value)

Less than or equals predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

gt

<P extends Comparable<? super P>> Criteria<C,R> gt(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                                                   P value)

Greater than predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

gtOrEq

<P extends Comparable<? super P>> Criteria<C,R> gtOrEq(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                                                       P value)

Greater than or equals predicate.

Parameters:

att - The attribute to compare with.

value - The comparison value.

Returns:

Fluent API: Criteria instance.

between

<P extends Comparable<? super P>> Criteria<C,R> between(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                                                        P lower,
                                                        P upper)

Between predicate.

Parameters:

att - The attribute to compare with.

lower - The lower bound comparison value.

upper - The upper bound comparison value.

Returns:

Fluent API: Criteria instance.

isNull

<P> Criteria<C,R> isNull(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

IsNull predicate.

Parameters:

att - The null attribute.

Returns:

Fluent API: Criteria instance.

notNull

<P> Criteria<C,R> notNull(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

NotNull predicate.

Parameters:

att - The non-null attribute.

Returns:

Fluent API: Criteria instance.

empty

<P extends Collection<?>> Criteria<C,R> empty(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

Empty predicate.

Parameters:

att - The collection attribute to check for emptyness.

Returns:

Fluent API: Criteria instance.

notEmpty

<P extends Collection<?>> Criteria<C,R> notEmpty(javax.persistence.metamodel.SingularAttribute<? super C,P> att)

Not empty predicate.

Parameters:

att - The collection attribute to check for non-emptyness.

Returns:

Fluent API: Criteria instance.

in

<P> Criteria<C,R> in(javax.persistence.metamodel.SingularAttribute<? super C,P> att,
                     P... values)

In predicte.

Parameters:

att - The attribute to check for.

values - The values for the in predicate.

Returns:

predicates

List<javax.persistence.criteria.Predicate> predicates(javax.persistence.criteria.CriteriaBuilder builder,
                                                      javax.persistence.criteria.Path<C> path)

Return the list of predicates applicable for this Criteria instance.

Parameters:

builder - A CriteriaBuilder used to instantiate the Predicates.

path - Current path.

Returns:

List of predicates applicable to this Criteria.