org.eclipse.emf.query.conditions.eobjects
Class EObjectCondition

java.lang.Object
  

org.eclipse.emf.query.conditions.Condition
      
org.eclipse.emf.query.conditions.eobjects.EObjectCondition

Direct Known Subclasses:

AbstractOCLCondition, ENot, EObjectConditionAdapter, EObjectConditionDelegator, EObjectContainmentFeatureCondition, EObjectReferencerCondition, EObjectStructuralFeatureCondition, EObjectTypeRelationCondition, IN, OCLCondition

public abstract class EObjectCondition
extends 
Condition

A subclass and the counterpart of a Condition object to be used on EObject arguments. It is the abstract base class for all EObjectCondition objects. It provides the basic functionality and support for EObject conditions and their logical connectives to combine other EObjectCondition object together. It answers whether a given EObject satisfies it or not. An EObjectCondition object also answers whether the contents/children of a given EObject argument are to be pruned -never visited- or not, in other words, an EObjectCondition is consulted on whether or not to apply it on the children of a given EObject, if the answer is false, then this EObject will not be applied on the children of that particular EObject. It is important for clients to know that pruning is treated as a hint only and is used solely to improve query performance and should not be relied on for correctness of the EObjectCondition evaluation. An EObjectCondition could not be consulted at all on pruning issue, and, its response -if it gets consulted- might not be honoured by the query -especially when having an EObjectCondition logically combined with another. This class is intended to be subclassed by clients.

See Also:

PruneHandler

Field Summary
static  EObjectCondition	E_FALSE           A constant EObjectCondition object used to indicate a never satisfied condition
static  EObjectCondition	E_TRUE           A constant EObjectCondition object used to indicate an always satisfied condition

 

Fields inherited from class org.eclipse.emf.query.conditions. Condition
FALSE, TRUE

 

Constructor Summary
EObjectCondition ()           A simple constructor.
EObjectCondition ( PruneHandler pruneHandler)           A constructor that takes in a PruneHandler instance to use for pruning.

 

Method Summary
EObjectCondition	AND ( EObjectCondition condition)           This operation acts like a logical AND between this EObjectCondition and the argument EObjectCondition.
EObjectCondition	EQUIVALENT ( EObjectCondition condition)           This operation acts like a logical Equivalent (if-and-only-if)/( <->) between this EObjectCondition and the argument EObjectCondition.
PruneHandler	getPruneHandler ()           A getter for the PrunHandler
EObjectCondition	IMPLIES ( EObjectCondition condition)           This operation acts like a logical Implies (if-then)/(->) between this EObjectCondition and the argument EObjectCondition.
abstract  boolean	isSatisfied ( EObject eObject)           Answers whether the argument eObject satisfies this EObjectCondition
boolean	isSatisfied ( Object object)           Overrides the parent's implementation by simply checking if the argument object is an instance of EObject first, and if so, it forwards the actual evaluation to the appropriate overloaded version.
EObjectCondition	OR ( EObjectCondition condition)           This operation acts like a logical OR between this EObjectCondition and the argument EObjectCondition.
boolean	shouldPrune ( EObject eObject)           Answers whether or not we should apply this EObjectCondition on the children of the argument eObject.
EObjectCondition	XOR ( EObjectCondition condition)           This operation acts like a logical XOR between this EObjectCondition and the argument EObjectCondition.

 

Methods inherited from class org.eclipse.emf.query.conditions. Condition
AND, EQUIVALENT, IMPLIES, OR, XOR

 

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

 

Field Detail

E_TRUE

public static final 
EObjectCondition E_TRUE

A constant EObjectCondition object used to indicate an always satisfied condition

E_FALSE

public static final 
EObjectCondition E_FALSE

A constant EObjectCondition object used to indicate a never satisfied condition

EObjectCondition

public EObjectCondition()

A simple constructor. It defaults to using the PruneHandler.NEVER and matches any EObject.

See Also:

PruneHandler

EObjectCondition

public EObjectCondition(
PruneHandler pruneHandler)

A constructor that takes in a PruneHandler instance to use for pruning. This constructor will match any kind of EObject, so it is only safe for conditions with E == EObject.

Parameters:

pruneHandler - The PruneHandler to use for pruning

See Also:

PruneHandler

getPruneHandler

public final 
PruneHandler getPruneHandler()

A getter for the PrunHandler

Returns:

PruneHandler the prune handler used by this EObjectCondition

shouldPrune

public boolean shouldPrune(
EObject eObject)

Answers whether or not we should apply this EObjectCondition on the children of the argument eObject. This call is forwarded to the installed PruneHandler.

Parameters:

eObject - the EObject to check to see whether to visit its children or not

Returns:

boolean true if we should prune and false otherwise

public boolean isSatisfied(
Object object)

public abstract boolean isSatisfied(
EObject eObject)

public 
EObjectCondition AND(
EObjectCondition condition)

public 
EObjectCondition OR(
EObjectCondition condition)

public 
EObjectCondition XOR(
EObjectCondition condition)

public 
EObjectCondition IMPLIES(
EObjectCondition condition)

public 
EObjectCondition EQUIVALENT(
EObjectCondition condition)