org.drools.rule
Class Rule

java.lang.Object
  org.drools.rule.Rule

All Implemented Interfaces:

java.io.Serializable

public class Rule
extends java.lang.Object
implements java.io.Serializable

A Rule contains a set of Conditions and a Consequence.

The Conditions describe the circumstances that representrepresent a match for this rule. The Consequence gets fired when the Conditions match.

See Also:

Condition, Consequence, Serialized Form

Constructor Summary

Rule(java.lang.String name)
Construct a Rule for the given name with null for the parent RuleSet Rules will nearly always want to be in a RuleSet.

Rule(java.lang.String name, RuleSet ruleSet)
Construct a Rule with the given name for the specified ruleSet parent

Method Summary

void	addCondition(Condition condition) Add a Condition to this rule.
Declaration	addParameterDeclaration(java.lang.String identifier, ObjectType objectType) Add a root fact object parameter Declaration for this Rule.
void	checkValidity() Check the validity of this rule, and throw exceptions if it fails validity tests.
java.lang.String	dump(java.lang.String indent)
java.util.Map	getApplicationData()
java.util.List	getConditions() Retrieve the List of Conditions for this rule.
int	getConditionSize()
Consequence	getConsequence() Retrieve the Consequence associated with this Rule.
java.lang.String	getDocumentation() Retrieve the documentation.
Duration	getDuration() Retrieve the truthness duration object.
Importer	getImporter()
long	getLoadOrder()
java.lang.String	getName() Retrieve the name of this rule.
Declaration	getParameterDeclaration(java.lang.String identifier) Retrieve a parameter Declaration by identifier.
java.util.List	getParameterDeclarations() Retrieve the set of all root fact object parameter Declarations.
RuleSet	getRuleSet()
int	getSalience() Retrieve the Rule salience.
java.lang.String	getXorGroup()
boolean	isNoLoop()
boolean	isValid() Determine if this rule is internally consistent and valid.
void	setApplicationData(java.util.Map applicationData)
void	setConsequence(Consequence consequence) Set the Consequence that is associated with the successful match of this rule.
void	setDocumentation(java.lang.String documentation) Set the documentation.
void	setDuration(Duration duration) Set the truthness duration object.
void	setDuration(long seconds) Set the truthness duration.
void	setImporter(Importer importer)
void	setNoLoop(boolean noLoop)
void	setSalience(int salience) Set the Rule salience.
void	setXorGroup(java.lang.String xorGroup)

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(java.lang.String name,
            RuleSet ruleSet)

Construct a Rule with the given name for the specified ruleSet parent

Parameters:

name - The name of this rule.

Rule

public Rule(java.lang.String name)

Construct a Rule for the given name with null for the parent RuleSet Rules will nearly always want to be in a RuleSet. This is more of a convenience constructor for the times you dont, ie during unit testing.

Parameters:

name - The name of this rule.

Method Detail

setDocumentation

public void setDocumentation(java.lang.String documentation)

Set the documentation.

Parameters:

documentation - - The documentation.

getDocumentation

public java.lang.String getDocumentation()

Retrieve the documentation.

Returns:

The documentation or null if none.

setDuration

public void setDuration(long seconds)

Set the truthness duration. This causes a delay before the firing of the Consequence if the rule is still true at the end of the duration.

This is merely a convenience method for calling setDuration(Duration)with a FixedDuration.

Parameters:

seconds - - The number of seconds the rule must hold true in order to fire.

See Also:

setDuration(Duration), FixedDuration

setDuration

public void setDuration(Duration duration)

Set the truthness duration object. This causes a delay before the firing of the Consequence if the rule is still true at the end of the duration.

Parameters:

duration - The truth duration object.

getDuration

public Duration getDuration()

Retrieve the truthness duration object.

Returns:

The truthness duration object.

isValid

public boolean isValid()

Determine if this rule is internally consistent and valid. No exception is thrown.

A Rule must include at least one parameter declaration and one condition.

Returns:

true if this rule is valid, else false.

checkValidity

public void checkValidity()
                   throws InvalidRuleException

Check the validity of this rule, and throw exceptions if it fails validity tests.

Possibly exceptions include:

 NoParameterDeclarationException
 NoConsequenceException
 

A Rule must include at least one parameter declaration and one condition.

Throws:

InvalidRuleException - if this rule is in any way invalid.

getRuleSet

public RuleSet getRuleSet()

getName

public java.lang.String getName()

Retrieve the name of this rule.

Returns:

The name of this rule.

getSalience

public int getSalience()

Retrieve the Rule salience.

Returns:

The salience.

setSalience

public void setSalience(int salience)

Set the Rule salience.

Parameters:

salience - The salience.

isNoLoop

public boolean isNoLoop()

setNoLoop

public void setNoLoop(boolean noLoop)

addParameterDeclaration

public Declaration addParameterDeclaration(java.lang.String identifier,
                                           ObjectType objectType)
                                    throws InvalidRuleException

Add a root fact object parameter Declaration for this Rule.

Parameters:

identifier - The identifier.

objectType - The type.

Returns:

The declaration.

Throws:

InvalidRuleException

getParameterDeclaration

public Declaration getParameterDeclaration(java.lang.String identifier)

Retrieve a parameter Declaration by identifier.

Parameters:

identifier - The identifier.

Returns:

The declaration or null if no declaration matches the identifier.

getParameterDeclarations

public java.util.List getParameterDeclarations()

Retrieve the set of all root fact object parameter Declarations.

Returns:

The Set of Declarations in order which specify the root fact objects.

addCondition

public void addCondition(Condition condition)

Add a Condition to this rule.

Parameters:

condition - The Condition to add.

getConditions

public java.util.List getConditions()

Retrieve the List of Conditions for this rule.

Returns:

The List of Conditions.

getConditionSize

public int getConditionSize()

setConsequence

public void setConsequence(Consequence consequence)

Set the Consequence that is associated with the successful match of this rule.

Parameters:

consequence - The Consequence to attach to this Rule.

getConsequence

public Consequence getConsequence()

Retrieve the Consequence associated with this Rule.

Returns:

The Consequence.

getLoadOrder

public long getLoadOrder()

getXorGroup

public java.lang.String getXorGroup()

setXorGroup

public void setXorGroup(java.lang.String xorGroup)

getImporter

public Importer getImporter()

setImporter

public void setImporter(Importer importer)

setApplicationData

public void setApplicationData(java.util.Map applicationData)

getApplicationData

public java.util.Map getApplicationData()

dump

public java.lang.String dump(java.lang.String indent)