EclipseLink 2.0.0_ 2.0.0.v20090626-r4569 API Reference

javax.persistence.criteria
Interface Predicate

All Superinterfaces:
Expression<java.lang.Boolean>, Selection<java.lang.Boolean>, TupleElement<java.lang.Boolean>
All Known Subinterfaces:
QueryBuilder.In<T>

public interface Predicate
extends Expression<java.lang.Boolean>

The type of a simple or compound predicate: a conjunction or disjunction of restrictions. A simple predicate is considered to be a conjunction with a single conjunct. since Java Persistence 2.0


Nested Class Summary
static class Predicate.BooleanOperator
           
 
Method Summary
 Predicate add(Expression<java.lang.Boolean> exp)
          Add another operand to the predicate.
 java.util.List<Expression<java.lang.Boolean>> getExpressions()
          Return the top-level conjuncts or disjuncts of the predicate.
 Predicate.BooleanOperator getOperator()
          Return the boolean operator for the predicate.
 boolean isNegated()
          Has negation been applied to the predicate.
 Predicate negate()
          Apply negation to the predicate.
 
Methods inherited from interface javax.persistence.criteria.Expression
as, in, in, in, in, isNotNull, isNull
 
Methods inherited from interface javax.persistence.criteria.Selection
setAlias
 
Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType
 

Method Detail

getOperator

Predicate.BooleanOperator getOperator()
Return the boolean operator for the predicate. If the predicate is simple, this is AND.

Returns:
boolean operator for the predicate

isNegated

boolean isNegated()
Has negation been applied to the predicate.

Returns:
boolean indicating if the predicate has been negated

getExpressions

java.util.List<Expression<java.lang.Boolean>> getExpressions()
Return the top-level conjuncts or disjuncts of the predicate.

Returns:
list boolean expressions forming the predicate

add

Predicate add(Expression<java.lang.Boolean> exp)
Add another operand to the predicate. Whether the operand is added as a conjunct or disjunct is determined by the predicate operator.

Returns:
the resulting compound predicate

negate

Predicate negate()
Apply negation to the predicate.

Returns:
the negated predicate

EclipseLink 2.0.0_ 2.0.0.v20090626-r4569 API Reference