org.dvare.ruleengine

Class RuleEngine

java.lang.Object

org.dvare.ruleengine.RuleEngine

public class RuleEngine
extends Object

The RuleEngine class contains method for rule registering and rule firing.

Since:

2016-08-20

Version:

1.0

Author:

Muhammad Hammad

Constructor Summary

Constructors

Constructor and Description
RuleEngine(TextualRuleEngine textualRuleEngine)

Method Summary

Modifier and Type	Method and Description
void	clearRules() The clearRules method remove all rules from RuleBinding Engine.
Map<String,Boolean>	fireRules() The fireRules trigger all registered rules.
List<RuleResult>	getResults() The getResults returns RuleBinding Engine Detail Result.
Object	getRule(String ruleId) The getRule method returns rule from RuleBinding Engine.
List<Object>	getRules() The getRules method returns all rules from RuleBinding Engine.
String	registerRule(Object rule) The registerRule method is used to register rules in a RuleBinding Engine.
void	setSatisfyCondition(Integer satisfyCondition)
void	setStopOnFail(Boolean stopOnFail)
void	unregisterRule(String ruleId) The unregisterRule method is used to unregister rule from RuleBinding Engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleEngine

public RuleEngine(TextualRuleEngine textualRuleEngine)

Method Detail

registerRule

public String registerRule(Object rule)
                    throws IllegalRuleException

The registerRule method is used to register rules in a RuleBinding Engine. This method returns the unique id against every register rule which will use for unregistering rule and rule result.

Parameters:

rule - This param is any class which is annotated with @RuleBinding annotation and contains at least one method with @Condition annotation.

Returns:

returns the unique id of rule in RuleBinding Engine.

Throws:

IllegalRuleException - This method throws IllegalRuleException when the passed object is null or not annotated with @RuleBinding annotation or RuleBinding without Condition Method and Text Condition without TextualRuleEngine Param.

unregisterRule

public void unregisterRule(String ruleId)

The unregisterRule method is used to unregister rule from RuleBinding Engine.

Parameters:

ruleId - The ruleId is unique id returns while rule registering

getRule

public Object getRule(String ruleId)

The getRule method returns rule from RuleBinding Engine.

Parameters:

ruleId - The ruleId is unique id returns while rule registering

Returns:

rule from rule engine

getRules

public List<Object> getRules()

The getRules method returns all rules from RuleBinding Engine.

Returns:

List rule from rule engine

clearRules

public void clearRules()

The clearRules method remove all rules from RuleBinding Engine.

fireRules

public Map<String,Boolean> fireRules()

The fireRules trigger all registered rules.

Returns:

Map of ruleId and RuleBinding Result

getResults

public List<RuleResult> getResults()

The getResults returns RuleBinding Engine Detail Result.

Returns:

List of RuleResult and RuleBinding Result

See Also:

RuleResult

setSatisfyCondition

public void setSatisfyCondition(Integer satisfyCondition)

setStopOnFail

public void setStopOnFail(Boolean stopOnFail)