com.deliveredtechnologies.rulebook

Class StandardDecision<T,U>

java.lang.Object

com.deliveredtechnologies.rulebook.StandardDecision<T,U>

All Implemented Interfaces:

Decision<T,U>, Rule<T>

Direct Known Subclasses:

RuleAdapter

public class StandardDecision<T,U>
extends java.lang.Object
implements Decision<T,U>

StandardDecision is the standard implementation of Decision.

Constructor Summary

Constructors

Constructor and Description
StandardDecision()

Method Summary

Modifier and Type	Method and Description
static StandardDecision<java.lang.Object,java.lang.Object>	create() This create() method is another convenience method to create a non-type specific StandardDecision.
static <T,U> StandardDecision<T,U>	create(java.lang.Class<T> factType, java.lang.Class<U> returnType) This create() method is a convenience method to avoid using new and generic syntax.
FactMap<T>	getFactMap() The getFactMap() method gets the factMap of stored facts.
U	getResult() The getResult() method gets the stored Result value from the execution of the StandardDecision.
java.lang.Object	getThen() Method getThen() gets an instance of a functional interface responsbile for the action to be performed by the Rule.
java.util.function.Predicate<FactMap<T>>	getWhen() Method getWhen() gets the Predicate that evaluates the condition of the Rule.
StandardDecision<T,U>	given(Fact<T>... facts) The given() method accepts Facts for the StandardDecision.
StandardDecision<T,U>	given(FactMap<T> facts) The given() method accepts Facts for the StandardDecision.
StandardDecision<T,U>	given(java.util.List<Fact<T>> facts) The given() method accepts Facts for the StandardDecision.
void	run() The run() method runs the Predicate supplied by the when() method.
void	setNextRule(Rule<T> rule) The setNextRule() method sets the next rule in the chain.
void	setResult(Result<U> result) The setResult() method sets the stored Result.
StandardDecision<T,U>	then(java.util.function.BiFunction<FactMap<T>,Result<U>,RuleState> action) The then() method accepts a Function that performs an action based on Facts, optionally sets a Result, and then returns a RuleState of either NEXT or BREAK.
StandardDecision<T,U>	then(java.util.function.Function<FactMap<T>,RuleState> action) The then() method accepts a Function that performs an action based on Facts and then returns a RuleState of either NEXT or BREAK.
StandardDecision<T,U>	when(java.util.function.Predicate<FactMap<T>> test) The when() method accepts a Predicate that returns true or false based on Facts.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardDecision

public StandardDecision()

Method Detail

create

public static <T,U> StandardDecision<T,U> create(java.lang.Class<T> factType,
                                                 java.lang.Class<U> returnType)

This create() method is a convenience method to avoid using new and generic syntax.

Type Parameters:

T - the class type of the objects in the Facts used

U - the class type of object stored in the Result

Parameters:

factType - the type of object stored in facts for this Decision

returnType - the type of the stored Result

Returns:

a new instance of StandardDecision

create

public static StandardDecision<java.lang.Object,java.lang.Object> create()

This create() method is another convenience method to create a non-type specific StandardDecision.

Returns:

a new instance of StandardDecision

run

public void run()

The run() method runs the Predicate supplied by the when() method. If it evaluates to true then the BiFunction supplied by the then() method is executed. If the BiFuction is not available then the Function is called instead. If the then() method returns a BREAK RuleState then no further rules are evaluated, otherwise the next rule in the chain is evaluated.

Specified by:

run in interface Rule<T>

given

public StandardDecision<T,U> given(Fact<T>... facts)

The given() method accepts Facts for the StandardDecision.

Specified by:

given in interface Rule<T>

Parameters:

facts - Facts to be used by the Rule

Returns:

the current object for chaining other methods

given

public StandardDecision<T,U> given(java.util.List<Fact<T>> facts)

The given() method accepts Facts for the StandardDecision.

Specified by:

given in interface Rule<T>

Parameters:

facts - a List of Facts to be used by the Rule

Returns:

the current object

given

public StandardDecision<T,U> given(FactMap<T> facts)

The given() method accepts Facts for the StandardDecision.

Specified by:

given in interface Rule<T>

Parameters:

facts - a FactMap

Returns:

the current object

when

public StandardDecision<T,U> when(java.util.function.Predicate<FactMap<T>> test)

The when() method accepts a Predicate that returns true or false based on Facts.

Specified by:

when in interface Rule<T>

Parameters:

test - the condition(s) to be evaluated against the Facts

Returns:

true, if the then() statement should be evaluated, otherwise false

then

public StandardDecision<T,U> then(java.util.function.Function<FactMap<T>,RuleState> action)

The then() method accepts a Function that performs an action based on Facts and then returns a RuleState of either NEXT or BREAK.

Specified by:

then in interface Rule<T>

Parameters:

action - the action to be performed

Returns:

NEXT if the next Rule should be run, otherwise BREAK

then

public StandardDecision<T,U> then(java.util.function.BiFunction<FactMap<T>,Result<U>,RuleState> action)

The then() method accepts a Function that performs an action based on Facts, optionally sets a Result, and then returns a RuleState of either NEXT or BREAK.

Specified by:

then in interface Decision<T,U>

Parameters:

action - the action to be performed

Returns:

NEXT if the next Decision should be run, otherwise BREAK

setNextRule

public void setNextRule(Rule<T> rule)

The setNextRule() method sets the next rule in the chain.

Specified by:

setNextRule in interface Rule<T>

Parameters:

rule - the next Rule to add to the chain

getResult

public U getResult()

The getResult() method gets the stored Result value from the execution of the StandardDecision.

Specified by:

getResult in interface Decision<T,U>

Returns:

the stored Result value

setResult

public void setResult(Result<U> result)

The setResult() method sets the stored Result.

Specified by:

setResult in interface Decision<T,U>

Parameters:

result - the instantiated result

getFactMap

public FactMap<T> getFactMap()

The getFactMap() method gets the factMap of stored facts.

Returns:

the factMap of stored facts

getWhen

public java.util.function.Predicate<FactMap<T>> getWhen()

Description copied from interface: Rule

Method getWhen() gets the Predicate that evaluates the condition of the Rule.

Specified by:

getWhen in interface Rule<T>

Returns:

a Predicate object

getThen

public java.lang.Object getThen()

Description copied from interface: Rule

Method getThen() gets an instance of a functional interface responsbile for the action to be performed by the Rule.

Specified by:

getThen in interface Rule<T>

Returns:

a functional interface Object