org.hibernate.jpa.criteria.predicate

Class CompoundPredicate

java.lang.Object

org.hibernate.jpa.criteria.AbstractNode

org.hibernate.jpa.criteria.expression.AbstractTupleElement<X>

org.hibernate.jpa.criteria.expression.SelectionImpl<T>

org.hibernate.jpa.criteria.expression.ExpressionImpl<Boolean>

org.hibernate.jpa.criteria.predicate.AbstractPredicateImpl

org.hibernate.jpa.criteria.predicate.CompoundPredicate

All Implemented Interfaces:

Serializable, Expression<Boolean>, Predicate, Selection<Boolean>, TupleElement<Boolean>, ExpressionImplementor<Boolean>, ParameterContainer, PredicateImplementor, Renderable, SelectionImplementor<Boolean>, TupleElementImplementor<Boolean>

public class CompoundPredicate
extends AbstractPredicateImpl
implements Serializable

A compound predicate is a grouping of other predicates in order to convert either a conjunction (logical AND) or a disjunction (logical OR).

Author:

Steve Ebersole

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.persistence.criteria.Predicate

Predicate.BooleanOperator

Nested classes/interfaces inherited from interface org.hibernate.jpa.criteria.ParameterContainer

ParameterContainer.Helper

Constructor Summary

Constructors

Constructor and Description
CompoundPredicate(CriteriaBuilderImpl criteriaBuilder, Predicate.BooleanOperator operator) Constructs an empty conjunction or disjunction.
CompoundPredicate(CriteriaBuilderImpl criteriaBuilder, Predicate.BooleanOperator operator, Expression<Boolean>... expressions) Constructs a conjunction or disjunction over the given expressions.
CompoundPredicate(CriteriaBuilderImpl criteriaBuilder, Predicate.BooleanOperator operator, List<Expression<Boolean>> expressions) Constructs a conjunction or disjunction over the given expressions.

Method Summary

Modifier and Type	Method and Description
List<Expression<Boolean>>	getExpressions() Return the top-level conjuncts or disjuncts of the predicate.
Predicate.BooleanOperator	getOperator() Return the boolean operator for the predicate.
boolean	isJunction() Is this a conjunction or disjunction?
Predicate	not() Create negation of compound predicate by using logic rules: 1.
void	registerParameters(ParameterRegistry registry) Register any parameters contained within this query component with the given registry.
String	render(boolean isNegated, RenderingContext renderingContext) Form of Renderable.render(org.hibernate.jpa.criteria.compile.RenderingContext) used when the predicate is wrapped in a negated wrapper.
static String	render(PredicateImplementor predicate, RenderingContext renderingContext)
String	render(RenderingContext renderingContext)
String	renderProjection(RenderingContext renderingContext)
static Predicate.BooleanOperator	reverseOperator(Predicate.BooleanOperator operator)

Methods inherited from class org.hibernate.jpa.criteria.predicate.AbstractPredicateImpl

getCompoundSelectionItems, isCompoundSelection, isNegated

Methods inherited from class org.hibernate.jpa.criteria.expression.ExpressionImpl

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, in, in, in, in, isNotNull, isNull

Methods inherited from class org.hibernate.jpa.criteria.expression.SelectionImpl

alias, getValueHandlers

Methods inherited from class org.hibernate.jpa.criteria.expression.AbstractTupleElement

forceConversion, getAlias, getJavaType, getValueHandler, resetJavaType, setAlias

Methods inherited from class org.hibernate.jpa.criteria.AbstractNode

criteriaBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.jpa.criteria.predicate.PredicateImplementor

criteriaBuilder

Methods inherited from interface javax.persistence.criteria.Expression

as, in, in, in, in, isNotNull, isNull

Methods inherited from interface javax.persistence.criteria.Selection

alias

Methods inherited from interface javax.persistence.TupleElement

getAlias, getJavaType

Methods inherited from interface org.hibernate.jpa.criteria.SelectionImplementor

getValueHandlers

Methods inherited from interface org.hibernate.jpa.criteria.TupleElementImplementor

getValueHandler

Constructor Detail

CompoundPredicate

public CompoundPredicate(CriteriaBuilderImpl criteriaBuilder,
                         Predicate.BooleanOperator operator)

Constructs an empty conjunction or disjunction.

Parameters:

criteriaBuilder - The query builder from which this originates.

operator - Indicates whether this predicate will function as a conjunction or disjunction.

CompoundPredicate

public CompoundPredicate(CriteriaBuilderImpl criteriaBuilder,
                         Predicate.BooleanOperator operator,
                         Expression<Boolean>... expressions)

Constructs a conjunction or disjunction over the given expressions.

Parameters:

criteriaBuilder - The query builder from which this originates.

operator - Indicates whether this predicate will function as a conjunction or disjunction.

expressions - The expressions to be grouped.

CompoundPredicate

public CompoundPredicate(CriteriaBuilderImpl criteriaBuilder,
                         Predicate.BooleanOperator operator,
                         List<Expression<Boolean>> expressions)

Constructs a conjunction or disjunction over the given expressions.

Parameters:

criteriaBuilder - The query builder from which this originates.

operator - Indicates whether this predicate will function as a conjunction or disjunction.

expressions - The expressions to be grouped.

Method Detail

getOperator

public Predicate.BooleanOperator getOperator()

Description copied from interface: Predicate

Return the boolean operator for the predicate. If the predicate is simple, this is AND.

Specified by:

getOperator in interface Predicate

Returns:

boolean operator for the predicate

getExpressions

public List<Expression<Boolean>> getExpressions()

Description copied from interface: Predicate

Return the top-level conjuncts or disjuncts of the predicate. Returns empty list if there are no top-level conjuncts or disjuncts of the predicate. Modifications to the list do not affect the query.

Specified by:

getExpressions in interface Predicate

Returns:

list of boolean expressions forming the predicate

registerParameters

public void registerParameters(ParameterRegistry registry)

Description copied from interface: ParameterContainer

Register any parameters contained within this query component with the given registry.

Specified by:

registerParameters in interface ParameterContainer

Parameters:

registry - The parameter registry with which to register.

render

public String render(RenderingContext renderingContext)

Specified by:

render in interface Renderable

isJunction

public boolean isJunction()

Description copied from interface: PredicateImplementor

Is this a conjunction or disjunction?

Specified by:

isJunction in interface PredicateImplementor

Returns:

true if this predicate is a junction (AND/OR); false otherwise

render

public String render(boolean isNegated,
                     RenderingContext renderingContext)

Description copied from interface: PredicateImplementor

Form of Renderable.render(org.hibernate.jpa.criteria.compile.RenderingContext) used when the predicate is wrapped in a negated wrapper. Allows passing down the negation flag.

Note that this form is no-op in compound (junction) predicates. The reason being that compound predicates are more complex and the negation is applied during its creation.

Specified by:

render in interface PredicateImplementor

Parameters:

isNegated - Should the predicate be negated.

renderingContext - The context for rendering

Returns:

The rendered predicate fragment.

renderProjection

public String renderProjection(RenderingContext renderingContext)

Specified by:

renderProjection in interface Renderable

not

public Predicate not()

Create negation of compound predicate by using logic rules: 1. not (x || y) is (not x && not y) 2. not (x && y) is (not x || not y)

Specified by:

not in interface Predicate

Overrides:

not in class AbstractPredicateImpl

Returns:

negated predicate

reverseOperator

public static Predicate.BooleanOperator reverseOperator(Predicate.BooleanOperator operator)

render

public static String render(PredicateImplementor predicate,
                            RenderingContext renderingContext)