org.openksavi.sponge.core.rule

Class AbstractRuleAdapterRuntime

java.lang.Object

org.openksavi.sponge.core.rule.AbstractRuleAdapterRuntime

All Implemented Interfaces:

RuleAdapterRuntime

Direct Known Subclasses:

OrderedRuleAdapterRuntime, UnorderedRuleAdapterRuntime

public abstract class AbstractRuleAdapterRuntime
extends Object
implements RuleAdapterRuntime

Abstract rule adapter runtime.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openksavi.sponge.core.rule.RuleAdapterRuntime

RuleAdapterRuntime.NodeValue

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseRuleAdapter	adapter
protected Map<String,Event>	eventAliasMap Map of (event alias, event instance).
protected Tree<RuleAdapterRuntime.NodeValue>	eventTree Event tree.

Constructor Summary

Constructors

Constructor and Description
AbstractRuleAdapterRuntime(BaseRuleAdapter adapter)

Method Summary

Modifier and Type	Method and Description
boolean	acceptAsFirst(Event event)
protected void	buildEventTree(TreeNode<RuleAdapterRuntime.NodeValue> node, Event event) Continues building the event tree for the incoming event starting at the specified node.
protected boolean	checkConditions(TreeNode<RuleAdapterRuntime.NodeValue> node) Checks conditions for the given node (containing level and event).
void	clear() Clears event tree and event alias map.
protected RuleDefinition	getDefinition()
Event	getEvent(String eventAlias)
Map<String,Event>	getEventAliasMap() Returns event alias map.
protected abstract int	getEventIndex(TreeNode<RuleAdapterRuntime.NodeValue> node)
protected EventMode	getEventMode(TreeNode<RuleAdapterRuntime.NodeValue> node) Returns event mode.
List<Event>	getEventSequence() Returns event sequence.
Tree<RuleAdapterRuntime.NodeValue>	getEventTree() Returns the event tree.
protected abstract int	getExpectedEventIndex(TreeNode<RuleAdapterRuntime.NodeValue> node, Event event)
Event	getFirstEvent()
protected BaseRuleMeta	getMeta()
protected boolean	handleNoneEventHappenedButShouldNot(TreeNode<RuleAdapterRuntime.NodeValue> parentNode, TreeNode<RuleAdapterRuntime.NodeValue> node, Event event)
protected abstract boolean	isLeafLevel(TreeNode<RuleAdapterRuntime.NodeValue> node)
void	onEvent(Event event) Processes the incoming event.
protected void	prepareEventAliasMap(TreeNode<RuleAdapterRuntime.NodeValue> node) Clears and sets up event alias map (event alias - event instance).
boolean	runRule() Attempts to run (fire) this rule.
protected boolean	runRule(TreeNode<RuleAdapterRuntime.NodeValue> node) Attempts to run (fire) this rule for the specified node in the event tree.
protected abstract boolean	runRuleForNonFinalNode(TreeNode<RuleAdapterRuntime.NodeValue> node)
protected abstract boolean	shouldAddToEventTreeForFlaModes(TreeNode<RuleAdapterRuntime.NodeValue> newNode, Event event)
protected abstract boolean	shouldAddToEventTreeForNMode(TreeNode<RuleAdapterRuntime.NodeValue> parentNode, org.apache.commons.lang3.mutable.Mutable<TreeNode<RuleAdapterRuntime.NodeValue>> newNodeHolder, Event event) Checks if the event should be added to the event tree for mode NONE.
protected abstract boolean	shouldRunRule()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.core.rule.RuleAdapterRuntime

isCandidateForFirstEvent, validate

Field Detail

adapter

protected BaseRuleAdapter adapter

eventTree

protected Tree<RuleAdapterRuntime.NodeValue> eventTree

Event tree. Contains events that are used by this rule.

eventAliasMap

protected transient Map<String,Event> eventAliasMap

Map of (event alias, event instance).

Constructor Detail

AbstractRuleAdapterRuntime

public AbstractRuleAdapterRuntime(BaseRuleAdapter adapter)

Method Detail

getDefinition

protected RuleDefinition getDefinition()

getMeta

protected BaseRuleMeta getMeta()

checkConditions

protected boolean checkConditions(TreeNode<RuleAdapterRuntime.NodeValue> node)

Checks conditions for the given node (containing level and event).

Parameters:

node - event tree node.

Returns:

true if all conditions are met.

acceptAsFirst

public boolean acceptAsFirst(Event event)

Specified by:

acceptAsFirst in interface RuleAdapterRuntime

onEvent

public void onEvent(Event event)

Processes the incoming event.

Specified by:

onEvent in interface RuleAdapterRuntime

getEventIndex

protected abstract int getEventIndex(TreeNode<RuleAdapterRuntime.NodeValue> node)

shouldRunRule

protected abstract boolean shouldRunRule()

shouldAddToEventTreeForFlaModes

protected abstract boolean shouldAddToEventTreeForFlaModes(TreeNode<RuleAdapterRuntime.NodeValue> newNode,
                                                           Event event)

getExpectedEventIndex

protected abstract int getExpectedEventIndex(TreeNode<RuleAdapterRuntime.NodeValue> node,
                                             Event event)

shouldAddToEventTreeForNMode

protected abstract boolean shouldAddToEventTreeForNMode(TreeNode<RuleAdapterRuntime.NodeValue> parentNode,
                                                        org.apache.commons.lang3.mutable.Mutable<TreeNode<RuleAdapterRuntime.NodeValue>> newNodeHolder,
                                                        Event event)

Checks if the event should be added to the event tree for mode NONE. Holder allows returning changed newNode.

Parameters:

parentNode - parent event tree node.

newNodeHolder - new event tree node holder.

event - new event.

Returns:

true if the event should be added to the event tree.

buildEventTree

protected void buildEventTree(TreeNode<RuleAdapterRuntime.NodeValue> node,
                              Event event)

Continues building the event tree for the incoming event starting at the specified node.

Parameters:

node - event tree node.

event - incoming event.

getEventMode

protected EventMode getEventMode(TreeNode<RuleAdapterRuntime.NodeValue> node)

Returns event mode.

Parameters:

node - event tree node.

Returns:

event mode.

runRule

public boolean runRule()

Attempts to run (fire) this rule.

Specified by:

runRule in interface RuleAdapterRuntime

Returns:

true if this rule has been run all times it ought to. In that case it will be finished.

runRule

protected boolean runRule(TreeNode<RuleAdapterRuntime.NodeValue> node)

Attempts to run (fire) this rule for the specified node in the event tree.

Parameters:

node - event tree node.

Returns:

true if this rule has been run (fired) all times it ought to. In that case it will be finished.

isLeafLevel

protected abstract boolean isLeafLevel(TreeNode<RuleAdapterRuntime.NodeValue> node)

runRuleForNonFinalNode

protected abstract boolean runRuleForNonFinalNode(TreeNode<RuleAdapterRuntime.NodeValue> node)

clear

public void clear()

Clears event tree and event alias map.

Specified by:

clear in interface RuleAdapterRuntime

getEvent

public Event getEvent(String eventAlias)

Specified by:

getEvent in interface RuleAdapterRuntime

prepareEventAliasMap

protected void prepareEventAliasMap(TreeNode<RuleAdapterRuntime.NodeValue> node)

Clears and sets up event alias map (event alias - event instance).

Parameters:

node - the node for the last event.

getEventTree

public Tree<RuleAdapterRuntime.NodeValue> getEventTree()

Returns the event tree.

Specified by:

getEventTree in interface RuleAdapterRuntime

Returns:

the event tree.

getEventAliasMap

public Map<String,Event> getEventAliasMap()

Returns event alias map.

Specified by:

getEventAliasMap in interface RuleAdapterRuntime

Returns:

event alias map.

getEventSequence

public List<Event> getEventSequence()

Returns event sequence.

Specified by:

getEventSequence in interface RuleAdapterRuntime

Returns:

event sequence.

getFirstEvent

public Event getFirstEvent()

Specified by:

getFirstEvent in interface RuleAdapterRuntime

handleNoneEventHappenedButShouldNot

protected boolean handleNoneEventHappenedButShouldNot(TreeNode<RuleAdapterRuntime.NodeValue> parentNode,
                                                      TreeNode<RuleAdapterRuntime.NodeValue> node,
                                                      Event event)