org.jeasy.rules.core

Class CompositeRule

java.lang.Object

org.jeasy.rules.core.BasicRule

org.jeasy.rules.core.CompositeRule

All Implemented Interfaces:

Comparable<Rule>, Rule

public class CompositeRule
extends BasicRule

Class representing a composite rule composed of a set of rules. A composite rule is triggered if ALL conditions of its composing rules are satisfied. When a composite rule is applied, actions of ALL composing rules are performed.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Object,Rule>	proxyRules
protected Set<Rule>	rules The set of composing rules.

Fields inherited from class org.jeasy.rules.core.BasicRule

description, name, priority

Fields inherited from interface org.jeasy.rules.api.Rule

DEFAULT_DESCRIPTION, DEFAULT_NAME, DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CompositeRule() Create a new CompositeRule.
CompositeRule(String name) Create a new CompositeRule.
CompositeRule(String name, String description) Create a new CompositeRule.
CompositeRule(String name, String description, int priority) Create a new CompositeRule.

Method Summary

Modifier and Type	Method and Description
void	addRule(Object rule) Add a rule to the composite rule.
boolean	evaluate(Facts facts) A composite rule is triggered if ALL conditions of all composing rules are evaluated to true.
void	execute(Facts facts) When a composite rule is applied, ALL actions of composing rules are performed in their natural order.
void	removeRule(Object rule) Remove a rule from the composite rule.

Methods inherited from class org.jeasy.rules.core.BasicRule

compareTo, equals, getDescription, getName, getPriority, hashCode, setDescription, setPriority, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

rules

protected Set<Rule> rules

The set of composing rules.

proxyRules

protected Map<Object,Rule> proxyRules

Constructor Detail

CompositeRule

public CompositeRule()

Create a new CompositeRule.

CompositeRule

public CompositeRule(String name)

Create a new CompositeRule.

Parameters:

name - rule name

CompositeRule

public CompositeRule(String name,
                     String description)

Create a new CompositeRule.

Parameters:

name - rule name

description - rule description

CompositeRule

public CompositeRule(String name,
                     String description,
                     int priority)

Create a new CompositeRule.

Parameters:

name - rule name

description - rule description

priority - rule priority

Method Detail

evaluate

public boolean evaluate(Facts facts)

A composite rule is triggered if ALL conditions of all composing rules are evaluated to true.

Specified by:

evaluate in interface Rule

Overrides:

evaluate in class BasicRule

Returns:

true if ALL conditions of composing rules are evaluated to true

execute

public void execute(Facts facts)
             throws Exception

When a composite rule is applied, ALL actions of composing rules are performed in their natural order.

Specified by:

execute in interface Rule

Overrides:

execute in class BasicRule

Throws:

Exception - thrown if an exception occurs during actions performing

addRule

public void addRule(Object rule)

Add a rule to the composite rule.

Parameters:

rule - the rule to add

removeRule

public void removeRule(Object rule)

Remove a rule from the composite rule.

Parameters:

rule - the rule to remove