org.openksavi.sponge.core.rule

Class BaseRuleAdapter

java.lang.Object

org.openksavi.sponge.core.BaseProcessorAdapter<T>

org.openksavi.sponge.core.BaseEventProcessorAdapter<T>

org.openksavi.sponge.core.BaseEventSetProcessorAdapter<Rule>

org.openksavi.sponge.core.rule.AbstractRuleAdapter<Rule>

org.openksavi.sponge.core.rule.BaseRuleAdapter

All Implemented Interfaces:

Cloneable, ProcessorAdapterImplementor, EventProcessorAdapter<Rule>, EventProcessorOperations, EventSetProcessorAdapter<Rule>, EventSetProcessorOperations, ProcessorAdapter<Rule>, ProcessorOperations, RuleAdapter, RuleOperations, Descriptive

public class BaseRuleAdapter
extends AbstractRuleAdapter<Rule>

Base rule adapter.

Field Summary

Fields inherited from class org.openksavi.sponge.core.BaseEventSetProcessorAdapter

durationTriggered, group, lock

Fields inherited from interface org.openksavi.sponge.rule.RuleAdapter

DEFAULT_MODE

Constructor Summary

Constructors

Constructor and Description
BaseRuleAdapter(BaseRuleDefinition definition)

Method Summary

Modifier and Type	Method and Description
boolean	acceptAsFirst(Event event)
void	clear() Clears event tree and event alias map.
SpongeException	createValidationException(String text)
Event	getEvent(String eventAlias)
Map<String,Event>	getEventAliasMap()
List<Event>	getEventSequence()
Tree<RuleAdapterRuntime.NodeValue>	getEventTree() Returns the event tree.
Event	getFirstEvent()
RuleAdapterRuntime	getRuntime()
ProcessorType	getType()
boolean	isCandidateForFirstEvent(Event event)
void	onEvent(Event event) Processes the incoming event.
protected boolean	runRule() Attempts to run (fire) this rule.
void	validate()

Methods inherited from class org.openksavi.sponge.core.rule.AbstractRuleAdapter

addAllEventConditions, addEventCondition, addEventConditions, getDefinition, getEventAlias, getEventAliases, getEventConditions, getEventConditions, getEventCount, getEventMode, getEventModes, isOrdered, makeEventSpec, makeEventSpec, makeEventSpec, makeEventSpec, onDuration, setEventAliases, setEventModes, setEventSpecs, setOrdered

Methods inherited from class org.openksavi.sponge.core.BaseEventSetProcessorAdapter

durationOccurred, finish, getDuration, getGroup, getState, hasDuration, isDurationTriggered, isRunning, isSynchronous, processEvent, setDuration, setDurationTriggered, setGroup, setState, setSynchronous

Methods inherited from class org.openksavi.sponge.core.BaseEventProcessorAdapter

getEventName, getEventNames, setEventName, setEventNames

Methods inherited from class org.openksavi.sponge.core.BaseProcessorAdapter

clone, getDescription, getDisplayName, getKnowledgeBase, getLogger, getMeta, getName, getProcessor, isJavaDefined, setDefinition, setDescription, setDisplayName, setKnowledgeBase, setMeta, setName, setProcessor, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.EventSetProcessorAdapter

durationOccurred, finish, getGroup, getState, isRunning, processEvent, setGroup, setState

Methods inherited from interface org.openksavi.sponge.ProcessorAdapter

getProcessor, setProcessor

Methods inherited from interface org.openksavi.sponge.EventSetProcessorOperations

getDuration, hasDuration, isSynchronous, setDuration, setSynchronous

Methods inherited from interface org.openksavi.sponge.EventProcessorOperations

getEventName, getEventNames, setEventName, setEventNames

Methods inherited from interface org.openksavi.sponge.ProcessorOperations

getKnowledgeBase, getMeta, setMeta

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

Constructor Detail

BaseRuleAdapter

public BaseRuleAdapter(BaseRuleDefinition definition)

Method Detail

getType

public ProcessorType getType()

onEvent

public void onEvent(Event event)

Processes the incoming event.

Specified by:

onEvent in class BaseEventSetProcessorAdapter<Rule>

createValidationException

public SpongeException createValidationException(String text)

clear

public void clear()

Clears event tree and event alias map.

Specified by:

clear in interface ProcessorAdapter<Rule>

Overrides:

clear in class BaseProcessorAdapter<Rule>

getRuntime

public RuleAdapterRuntime getRuntime()

acceptAsFirst

public boolean acceptAsFirst(Event event)

runRule

protected boolean runRule()

Description copied from class: AbstractRuleAdapter

Attempts to run (fire) this rule.

Specified by:

runRule in class AbstractRuleAdapter<Rule>

Returns:

true if this rule has been run.

isCandidateForFirstEvent

public boolean isCandidateForFirstEvent(Event event)

Specified by:

isCandidateForFirstEvent in class BaseEventSetProcessorAdapter<Rule>

getFirstEvent

public Event getFirstEvent()

Specified by:

getFirstEvent in class BaseEventSetProcessorAdapter<Rule>

getEvent

public Event getEvent(String eventAlias)

getEventAliasMap

public final Map<String,Event> getEventAliasMap()

getEventSequence

public final List<Event> getEventSequence()

getEventTree

public final Tree<RuleAdapterRuntime.NodeValue> getEventTree()

Returns the event tree.

Returns:

the event tree.

validate

public void validate()

Specified by:

validate in interface ProcessorAdapter<Rule>

Overrides:

validate in class BaseEventProcessorAdapter<Rule>