org.openksavi.sponge.correlator

Interface Correlator

All Superinterfaces:

CorrelatorOperations, Descriptive, EventProcessor<CorrelatorAdapter>, EventProcessorOperations, EventSetProcessor<CorrelatorAdapter>, EventSetProcessorOperations, HasVersion, Processor<CorrelatorAdapter>, ProcessorOperations

public interface Correlator
extends EventSetProcessor<CorrelatorAdapter>, CorrelatorOperations

Correlator.

Method Summary

Modifier and Type	Method and Description
void	finish() Finishes this event set processor.
boolean	onAcceptAsFirst(Event event) A callback method that checks if this event should be accepted as the first event of this correlator, therefore starting a new instance.
void	onDuration() Callback invoked when duration timeout occurs.
void	onEvent(Event event) Callback invoked when an event happens.

Methods inherited from interface org.openksavi.sponge.EventSetProcessor

getFirstEvent, getGroup

Methods inherited from interface org.openksavi.sponge.EventProcessor

setEvent, setEvents

Methods inherited from interface org.openksavi.sponge.Processor

getAdapter, getLogger, onConfigure, onInit

Methods inherited from interface org.openksavi.sponge.correlator.CorrelatorOperations

getMaxInstances, isInstanceSynchronous, setInstanceSynchronous, setMaxInstances

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, getLabel, getName, setDescription, setLabel, setName

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

getVersion, setVersion

Method Detail

onAcceptAsFirst

boolean onAcceptAsFirst(Event event)

A callback method that checks if this event should be accepted as the first event of this correlator, therefore starting a new instance.

Parameters:

event - the incoming event.

Returns:

true if this event should be accepted as the first event.

onEvent

void onEvent(Event event)

Callback invoked when an event happens.

Parameters:

event - event.

onDuration

void onDuration()

Callback invoked when duration timeout occurs.

finish

void finish()

Finishes this event set processor.