net.bobosse.gwt.rulesengine.client.impl.rules

Class AbstractRule

java.lang.Object

net.bobosse.gwt.rulesengine.client.impl.rules.AbstractRule

All Implemented Interfaces:

HasFollowing<Rule>, HasPreceeding<Rule>, Rule

Direct Known Subclasses:

NullOrEmptyRule, RegexRule

public abstract class AbstractRule
extends Object
implements Rule

AbstractRule implements action, active status, name and salience manipulation. The rest is for subclasses, ie execute() interface method.
This implementation creates active Rule by default.

Author:

sesa202001

Constructor Summary

Constructors

Constructor and Description
AbstractRule(String name, int salience)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activate() Set rule state to active
boolean	addCommand(RuledCommand action) Add an RuledCommand to fire when rule matches
void	clearCommands() Remove all actions triggered by this Rule when it matches.
void	executeCommands() call each RuledCommand execute() method
List<RuledCommand>	getCommands()
Object	getFact()
List<Rule>	getFollowing()
String	getName()
List<Rule>	getPreceeding()
Report	getReport()
int	getSalience() Rule salience is an int between -100 an 100.
boolean	isActive()
boolean	passivate() Set rule state to passive (will not be processed)
boolean	removeCommand(RuledCommand action) Remove an RuledCommand to fire when rule matches
protected void	setFact(Object fact)
void	setFollowingRules(List<Rule> fRules)
void	setPreceedingRules(List<Rule> pRules)
protected void	setReport(Report context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.bobosse.gwt.rulesengine.client.Rule

execute

Constructor Detail

AbstractRule

public AbstractRule(String name,
            int salience)

Method Detail

getName

public String getName()

Specified by:

getName in interface Rule

Returns:

rule's name

executeCommands

public final void executeCommands()

call each RuledCommand execute() method

Specified by:

executeCommands in interface Rule

addCommand

public final boolean addCommand(RuledCommand action)

Description copied from interface: Rule

Add an RuledCommand to fire when rule matches

Specified by:

addCommand in interface Rule

Returns:

removeCommand

public final boolean removeCommand(RuledCommand action)

Description copied from interface: Rule

Remove an RuledCommand to fire when rule matches

Specified by:

removeCommand in interface Rule

Returns:

getCommands

public final List<RuledCommand> getCommands()

Specified by:

getCommands in interface Rule

Returns:

list of RuledCommand to fire when rule matches

getSalience

public int getSalience()

Description copied from interface: Rule

Rule salience is an int between -100 an 100. Higher is this value, higher is the priority of the rule. High priority rules will be executed first.

Specified by:

getSalience in interface Rule

Returns:

rule's salience

isActive

public boolean isActive()

Specified by:

isActive in interface Rule

Returns:

true if rule is active, false otherwise

activate

public boolean activate()

Description copied from interface: Rule

Set rule state to active

Specified by:

activate in interface Rule

Returns:

previous active status

passivate

public boolean passivate()

Description copied from interface: Rule

Set rule state to passive (will not be processed)

Specified by:

passivate in interface Rule

Returns:

previous active status

clearCommands

public void clearCommands()

Description copied from interface: Rule

Remove all actions triggered by this Rule when it matches.

Specified by:

clearCommands in interface Rule

getFact

public Object getFact()

Specified by:

getFact in interface Rule

Returns:

what is tested by this rule during current session. If null, throw an IllegalStateException.

setFact

protected void setFact(Object fact)

setReport

protected void setReport(Report context)

getReport

public Report getReport()

Specified by:

getReport in interface Rule

Returns:

where processing information should be stored. As this is mandatory, throw an IllegalStateException if null.

setFollowingRules

public void setFollowingRules(List<Rule> fRules)

setPreceedingRules

public void setPreceedingRules(List<Rule> pRules)

getFollowing

public List<Rule> getFollowing()

Specified by:

getFollowing in interface HasFollowing<Rule>

getPreceeding

public List<Rule> getPreceeding()

Specified by:

getPreceeding in interface HasPreceeding<Rule>