com.deliveredtechnologies.rulebook.model.runner

Class RuleBookRunner

java.lang.Object

com.deliveredtechnologies.rulebook.model.runner.RuleBookRunner

All Implemented Interfaces:

RuleBook

public class RuleBookRunner
extends java.lang.Object
implements RuleBook

Runs the POJO Rules in a specified package as a RuleBook.

Constructor Summary

Constructors

Constructor and Description
RuleBookRunner(java.lang.Class<? extends RuleBook> ruleBookClass, java.lang.String rulePackage) Creates a new RuleBookRunner using the specified package and the supplied RuleBook.
RuleBookRunner(java.lang.String rulePackage) Creates a new RuleBookRunner using the specified package and the default RuleBook.

Method Summary

Modifier and Type	Method and Description
void	addRule(Rule rule) Add a Rule.
java.util.Optional<Result>	getResult() Get the Result of the RuleBook.
boolean	hasRules() The hasRules() method returns true if any Rules have been defined in the RuleBook.
void	run(NameValueReferableMap facts) Run the RuleBook given the facts supplied.
void	setDefaultResult(java.lang.Object result) Set the default Result value; this should be set for RuleBooks that are expected to produce a Result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.deliveredtechnologies.rulebook.model.RuleBook

defineRules

Constructor Detail

RuleBookRunner

public RuleBookRunner(java.lang.String rulePackage)

Creates a new RuleBookRunner using the specified package and the default RuleBook.

Parameters:

rulePackage - a package to scan for POJO Rules

RuleBookRunner

public RuleBookRunner(java.lang.Class<? extends RuleBook> ruleBookClass,
                      java.lang.String rulePackage)

Creates a new RuleBookRunner using the specified package and the supplied RuleBook.

Parameters:

ruleBookClass - the RuleBook type to use as a delegate for the RuleBookRunner

rulePackage - the package to scan for POJO rules

Method Detail

addRule

public void addRule(Rule rule)

Description copied from interface: RuleBook

Add a Rule.

Specified by:

addRule in interface RuleBook

Parameters:

rule - the Rule to add to the RuleBook

run

public void run(NameValueReferableMap facts)

Description copied from interface: RuleBook

Run the RuleBook given the facts supplied.

Specified by:

run in interface RuleBook

Parameters:

facts - the facts to be applied to the execution of the RuleBook

setDefaultResult

public void setDefaultResult(java.lang.Object result)

Description copied from interface: RuleBook

Set the default Result value; this should be set for RuleBooks that are expected to produce a Result.

Specified by:

setDefaultResult in interface RuleBook

Parameters:

result - the default Result value

getResult

public java.util.Optional<Result> getResult()

Description copied from interface: RuleBook

Get the Result of the RuleBook.

Specified by:

getResult in interface RuleBook

Returns:

the Result of the RuleBook

hasRules

public boolean hasRules()

Description copied from interface: RuleBook

The hasRules() method returns true if any Rules have been defined in the RuleBook.

Specified by:

hasRules in interface RuleBook

Returns:

true if any Rules have been defined in the RuleBook, otherwise false.