org.drools.core.rule

Class Pattern

java.lang.Object

org.drools.core.rule.Pattern

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, RuleConditionElement, Acceptor, AcceptsClassObjectType, RuleComponent

Direct Known Subclasses:

XpathBackReference.RelativePattern

public class Pattern
extends Object
implements RuleConditionElement, AcceptsClassObjectType, Externalizable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pattern()
Pattern(int index, int offset, ObjectType objectType, String identifier)
Pattern(int index, int offset, ObjectType objectType, String identifier, boolean isInternalFact)
Pattern(int index, ObjectType objectType)
Pattern(int index, ObjectType objectType, String identifier)

Method Summary

Modifier and Type	Method and Description
void	addBehavior(Behavior behavior)
void	addConstraint(Constraint constraint)
void	addConstraint(int index, Constraint constraint)
void	addConstraints(Collection<Constraint> constraints)
void	addDeclaration(Declaration decl)
Declaration	addDeclaration(String identifier)
Pattern	clone() Returns a clone from itself
boolean	equals(Object object)
Map<String,AnnotationDefinition>	getAnnotations()
XpathBackReference	getBackRefDeclarations()
List<Behavior>	getBehaviors()
List<MvelConstraint>	getCombinableConstraints()
List<Constraint>	getConstraints()
Declaration	getDeclaration()
Map<String,Declaration>	getDeclarations()
int	getIndex()
Map<String,Declaration>	getInnerDeclarations() Returns a Map of declarations that are visible inside this conditional element
Collection<String>	getListenedProperties()
List<RuleConditionElement>	getNestedElements() Returs a list of RuleConditionElement's that are nested inside the current element
ObjectType	getObjectType()
int	getOffset() The offset of the fact related to this pattern inside the tuple
Map<String,Declaration>	getOuterDeclarations() Returns a Map of declarations that are visible outside this conditional element.
static InternalReadAccessor	getReadAcessor(ObjectType objectType)
Declaration[]	getRequiredDeclarations()
PatternSource	getSource()
List<Class<?>>	getXpathBackReferenceClasses()
XpathConstraint	getXpathConstraint()
Declaration	getXPathDeclaration()
int	hashCode()
boolean	hasNegativeConstraint()
boolean	hasXPath()
boolean	isBound()
boolean	isCompatibleWithAccumulateReturnType(Class<?> returnType)
static boolean	isCompatibleWithAccumulateReturnType(Class<?> patternType, Class<?> returnType)
boolean	isCompatibleWithFromReturnType(Class<?> returnType)
static boolean	isCompatibleWithFromReturnType(Class<?> patternType, Class<?> returnType)
boolean	isPassive()
boolean	isPatternScopeDelimiter() Returns true in case this RuleConditionElement delimits a pattern visibility scope.
void	readExternal(ObjectInput in)
void	removeConstraint(Constraint constraint)
void	resetDeclarations()
Declaration	resolveDeclaration(String identifier) Resolves the given identifier in the current scope and returns the Declaration object for the declaration.
void	setBackRefDeclarations(XpathBackReference backRefDeclarations)
void	setBehaviors(List<Behavior> behaviors)
void	setClassObjectType(ClassObjectType objectType)
void	setHasNegativeConstraint(boolean negative)
void	setListenedProperties(Collection<String> listenedProperties)
void	setObjectType(ObjectType objectType)
void	setOffset(int offset)
void	setPassive(boolean passive)
void	setSource(PatternSource source)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pattern

public Pattern()

Pattern

public Pattern(int index,
               ObjectType objectType)

Pattern

public Pattern(int index,
               ObjectType objectType,
               String identifier)

Pattern

public Pattern(int index,
               int offset,
               ObjectType objectType,
               String identifier)

Pattern

public Pattern(int index,
               int offset,
               ObjectType objectType,
               String identifier,
               boolean isInternalFact)

Method Detail

hasNegativeConstraint

public boolean hasNegativeConstraint()

setHasNegativeConstraint

public void setHasNegativeConstraint(boolean negative)

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getReadAcessor

public static InternalReadAccessor getReadAcessor(ObjectType objectType)

setClassObjectType

public void setClassObjectType(ClassObjectType objectType)

Specified by:

setClassObjectType in interface AcceptsClassObjectType

getRequiredDeclarations

public Declaration[] getRequiredDeclarations()

clone

public Pattern clone()

Description copied from interface: RuleConditionElement

Returns a clone from itself

Specified by:

clone in interface RuleConditionElement

Overrides:

clone in class Object

Returns:

getObjectType

public ObjectType getObjectType()

setObjectType

public void setObjectType(ObjectType objectType)

getSource

public PatternSource getSource()

setSource

public void setSource(PatternSource source)

isPassive

public boolean isPassive()

setPassive

public void setPassive(boolean passive)

getConstraints

public List<Constraint> getConstraints()

addConstraint

public void addConstraint(int index,
                          Constraint constraint)

addConstraints

public void addConstraints(Collection<Constraint> constraints)

addConstraint

public void addConstraint(Constraint constraint)

removeConstraint

public void removeConstraint(Constraint constraint)

getCombinableConstraints

public List<MvelConstraint> getCombinableConstraints()

hasXPath

public boolean hasXPath()

getXpathConstraint

public XpathConstraint getXpathConstraint()

getXPathDeclaration

public Declaration getXPathDeclaration()

addDeclaration

public Declaration addDeclaration(String identifier)

addDeclaration

public void addDeclaration(Declaration decl)

resetDeclarations

public void resetDeclarations()

isBound

public boolean isBound()

getDeclaration

public Declaration getDeclaration()

getIndex

public int getIndex()

getOffset

public int getOffset()

The offset of the fact related to this pattern inside the tuple

Returns:

the offset

setOffset

public void setOffset(int offset)

getDeclarations

public Map<String,Declaration> getDeclarations()

getInnerDeclarations

public Map<String,Declaration> getInnerDeclarations()

Description copied from interface: RuleConditionElement

Returns a Map of declarations that are visible inside this conditional element

Specified by:

getInnerDeclarations in interface RuleConditionElement

Returns:

getOuterDeclarations

public Map<String,Declaration> getOuterDeclarations()

Description copied from interface: RuleConditionElement

Returns a Map of declarations that are visible outside this conditional element.

Specified by:

getOuterDeclarations in interface RuleConditionElement

Returns:

resolveDeclaration

public Declaration resolveDeclaration(String identifier)

Description copied from interface: RuleConditionElement

Resolves the given identifier in the current scope and returns the Declaration object for the declaration. Returns null if identifier can not be resolved.

Specified by:

resolveDeclaration in interface RuleConditionElement

Returns:

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getNestedElements

public List<RuleConditionElement> getNestedElements()

Description copied from interface: RuleConditionElement

Returs a list of RuleConditionElement's that are nested inside the current element

Specified by:

getNestedElements in interface RuleConditionElement

Returns:

isPatternScopeDelimiter

public boolean isPatternScopeDelimiter()

Description copied from interface: RuleConditionElement

Returns true in case this RuleConditionElement delimits a pattern visibility scope. For instance, AND CE is not a scope delimiter, while NOT CE is a scope delimiter

Specified by:

isPatternScopeDelimiter in interface RuleConditionElement

Returns:

getBehaviors

public List<Behavior> getBehaviors()

Returns:

the behaviors

setBehaviors

public void setBehaviors(List<Behavior> behaviors)

Parameters:

behaviors - the behaviors to set

addBehavior

public void addBehavior(Behavior behavior)

getListenedProperties

public Collection<String> getListenedProperties()

setListenedProperties

public void setListenedProperties(Collection<String> listenedProperties)

getAnnotations

public Map<String,AnnotationDefinition> getAnnotations()

getBackRefDeclarations

public XpathBackReference getBackRefDeclarations()

setBackRefDeclarations

public void setBackRefDeclarations(XpathBackReference backRefDeclarations)

getXpathBackReferenceClasses

public List<Class<?>> getXpathBackReferenceClasses()

isCompatibleWithAccumulateReturnType

public boolean isCompatibleWithAccumulateReturnType(Class<?> returnType)

isCompatibleWithFromReturnType

public boolean isCompatibleWithFromReturnType(Class<?> returnType)

isCompatibleWithAccumulateReturnType

public static boolean isCompatibleWithAccumulateReturnType(Class<?> patternType,
                                                           Class<?> returnType)

isCompatibleWithFromReturnType

public static boolean isCompatibleWithFromReturnType(Class<?> patternType,
                                                     Class<?> returnType)