Predicate (Castor JavaDoc)

java.lang.Object
- org.castor.cpa.persistence.sql.query.condition.Condition
- - org.castor.cpa.persistence.sql.query.condition.Predicate

All Implemented Interfaces:

QueryObject

Direct Known Subclasses:

IsNullPredicate
```
public abstract class Predicate
extends Condition
```
Abstract base class for all predicates.

Version:

$Revision$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Ahmad Hassan, Ralf Joachim

Constructor Summary

Constructors
Modifier Constructor Description

protected Predicate(Expression expression, boolean evaluateTo)
Construct a predicate with given expression.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`evaluateTo()`	Returns if the predicate should evaluate to `true` or `false`.
`Expression`	`expression()`	Expression to apply the predicate to.
`Condition`	`not()`	Builder method to invert a condition.

Methods inherited from class org.castor.cpa.persistence.sql.query.condition.Condition
and, or

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.castor.cpa.persistence.sql.query.QueryObject
accept

- Constructor Detail
  - Predicate
```
protected Predicate(Expression expression,
                    boolean evaluateTo)
```
    Construct a predicate with given expression.
    
    Parameters:
    
    expression - Expression to apply the predicate to.
    
    evaluateTo - What is the expected result of the evaluation?
- Method Detail
  - expression
```
public final Expression expression()
```
    Expression to apply the predicate to.
    
    Returns:
    
    Expression to apply the predicate to.
  - evaluateTo
```
public final boolean evaluateTo()
```
    Returns if the predicate should evaluate to true or false.
    
    Returns:
    
    true if the predicate should evaluate to true, false otherwise.
  - not
```
public final Condition not()
```
    Description copied from class: Condition
    
    Builder method to invert a condition. A condition that evaluated to TRUE before calling this method will evaluate to FALSE thereafter.
    
    Specified by:
    
    not in class Condition
    
    Returns:
    
    Negated condition.