org.jeasy.rules.core

Class DefaultRulesEngine

java.lang.Object

org.jeasy.rules.core.DefaultRulesEngine

All Implemented Interfaces:

RulesEngine

public final class DefaultRulesEngine
extends java.lang.Object
implements RulesEngine

Default RulesEngine implementation. This implementation handles a set of rules with unique name. Rules are fired according to their natural order which is priority by default.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Constructor Summary

Constructors

Constructor and Description
DefaultRulesEngine() Create a new DefaultRulesEngine with default parameters.
DefaultRulesEngine(RulesEngineParameters parameters) Create a new DefaultRulesEngine.

Method Summary

Modifier and Type	Method and Description
java.util.Map<Rule,java.lang.Boolean>	check(Rules rules, Facts facts) Check rules without firing them.
void	fire(Rules rules, Facts facts) Fire all registered rules on given facts.
RulesEngineParameters	getParameters() Return the rules engine parameters.
java.util.List<RuleListener>	getRuleListeners() Return the list of registered rule listeners.
java.util.List<RulesEngineListener>	getRulesEngineListeners() Return the list of registered rules engine listeners.
void	registerRuleListener(RuleListener ruleListener) Register a rule listener.
void	registerRuleListeners(java.util.List<RuleListener> ruleListeners) Register a list of rule listener.
void	registerRulesEngineListener(RulesEngineListener rulesEngineListener) Register a rules engine listener.
void	registerRulesEngineListeners(java.util.List<RulesEngineListener> rulesEngineListeners) Register a list of rules engine listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRulesEngine

public DefaultRulesEngine()

Create a new DefaultRulesEngine with default parameters.

DefaultRulesEngine

public DefaultRulesEngine(RulesEngineParameters parameters)

Create a new DefaultRulesEngine.

Parameters:

parameters - of the engine

Method Detail

getParameters

public RulesEngineParameters getParameters()

Description copied from interface: RulesEngine

Return the rules engine parameters.

Specified by:

getParameters in interface RulesEngine

Returns:

The rules engine parameters

getRuleListeners

public java.util.List<RuleListener> getRuleListeners()

Description copied from interface: RulesEngine

Return the list of registered rule listeners.

Specified by:

getRuleListeners in interface RulesEngine

Returns:

the list of registered rule listeners

getRulesEngineListeners

public java.util.List<RulesEngineListener> getRulesEngineListeners()

Description copied from interface: RulesEngine

Return the list of registered rules engine listeners.

Specified by:

getRulesEngineListeners in interface RulesEngine

Returns:

the list of registered rules engine listeners

fire

public void fire(Rules rules,
                 Facts facts)

Description copied from interface: RulesEngine

Fire all registered rules on given facts.

Specified by:

fire in interface RulesEngine

check

public java.util.Map<Rule,java.lang.Boolean> check(Rules rules,
                                                   Facts facts)

Description copied from interface: RulesEngine

Check rules without firing them.

Specified by:

check in interface RulesEngine

Returns:

a map with the result of evaluation of each rule

registerRuleListener

public void registerRuleListener(RuleListener ruleListener)

Register a rule listener.

Parameters:

ruleListener - to register

registerRuleListeners

public void registerRuleListeners(java.util.List<RuleListener> ruleListeners)

Register a list of rule listener.

Parameters:

ruleListeners - to register

registerRulesEngineListener

public void registerRulesEngineListener(RulesEngineListener rulesEngineListener)

Register a rules engine listener.

Parameters:

rulesEngineListener - to register

registerRulesEngineListeners

public void registerRulesEngineListeners(java.util.List<RulesEngineListener> rulesEngineListeners)

Register a list of rules engine listener.

Parameters:

rulesEngineListeners - to register