org.openksavi.sponge.rule

Interface Rule

All Superinterfaces:

Descriptive, EventProcessor<RuleAdapter>, EventProcessorOperations, EventSetProcessor<RuleAdapter>, EventSetProcessorOperations, Processor<RuleAdapter>, ProcessorOperations, RuleOperations

public interface Rule
extends EventSetProcessor<RuleAdapter>, RuleOperations

Rule.

Method Summary

Modifier and Type	Method and Description
Event	getEvent(String eventAlias) Returns an event that has a specified alias.
List<Event>	getEventSequence() Returns a sequence of actual events.
RuleEventSpec	makeEventSpec(String eventName) Creates a new rule event specification.
RuleEventSpec	makeEventSpec(String eventName, EventMode eventMode) Creates a new rule event specification.
RuleEventSpec	makeEventSpec(String eventName, String eventAlias) Creates a new rule event specification.
RuleEventSpec	makeEventSpec(String eventName, String eventAlias, EventMode eventMode) Creates a new rule event specification.
void	onRun(Event event) A callback method invoked when this rule fires.
void	setEvent(String eventStringSpec) Sets the event specification as a string.
void	setEvents(String... eventStringSpecs) Sets the event specifications as strings.
void	setEventSpec(RuleEventSpec eventSpec) Sets the event specification.
void	setEventSpecs(RuleEventSpec... eventSpecs) Sets the event specifications.

Methods inherited from interface org.openksavi.sponge.EventSetProcessor

getFirstEvent, getGroup

Methods inherited from interface org.openksavi.sponge.Processor

getAdapter, getLogger, onConfigure, onInit

Methods inherited from interface org.openksavi.sponge.rule.RuleOperations

addAllEventConditions, addEventCondition, addEventConditions, getEventConditions, getEventConditions, isOrdered, setOrdered

Methods inherited from interface org.openksavi.sponge.EventSetProcessorOperations

getDuration, hasDuration, isSynchronous, setDuration, setSynchronous

Methods inherited from interface org.openksavi.sponge.ProcessorOperations

getFeatures, getKnowledgeBase, setFeatures

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

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

Method Detail

onRun

void onRun(Event event)

A callback method invoked when this rule fires.

Parameters:

event - event.

getEvent

Event getEvent(String eventAlias)

Returns an event that has a specified alias.

Parameters:

eventAlias - an event alias.

Returns:

an event.

getEventSequence

List<Event> getEventSequence()

Returns a sequence of actual events.

Returns:

an event sequence.

setEvents

void setEvents(String... eventStringSpecs)

Sets the event specifications as strings.

Specified by:

setEvents in interface EventProcessor<RuleAdapter>

Parameters:

eventStringSpecs - the event specifications.

setEventSpecs

void setEventSpecs(RuleEventSpec... eventSpecs)

Sets the event specifications.

Parameters:

eventSpecs - the event specifications.

setEvent

void setEvent(String eventStringSpec)

Sets the event specification as a string.

Specified by:

setEvent in interface EventProcessor<RuleAdapter>

Parameters:

eventStringSpec - the event specification.

setEventSpec

void setEventSpec(RuleEventSpec eventSpec)

Sets the event specification.

Parameters:

eventSpec - the event specification.

makeEventSpec

RuleEventSpec makeEventSpec(String eventName,
                            String eventAlias,
                            EventMode eventMode)

Creates a new rule event specification.

Parameters:

eventName - an event name.

eventAlias - an event alias.

eventMode - an event mode.

Returns:

a new rule event specification.

makeEventSpec

RuleEventSpec makeEventSpec(String eventName,
                            EventMode eventMode)

Creates a new rule event specification.

Parameters:

eventName - an event name.

eventMode - an event mode.

Returns:

a new rule event specification.

makeEventSpec

RuleEventSpec makeEventSpec(String eventName,
                            String eventAlias)

Creates a new rule event specification.

Parameters:

eventName - an event name.

eventAlias - an event alias.

Returns:

a new rule event specification.

makeEventSpec

RuleEventSpec makeEventSpec(String eventName)

Creates a new rule event specification.

Parameters:

eventName - an event name.

Returns:

a new rule event specification.