org.openksavi.sponge.core.correlator

Class BaseCorrelator

java.lang.Object

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

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

org.openksavi.sponge.core.BaseEventSetProcessor<CorrelatorAdapter>

org.openksavi.sponge.core.correlator.BaseCorrelator

All Implemented Interfaces:

Correlator, CorrelatorOperations, EventProcessor<CorrelatorAdapter>, EventProcessorOperations, EventSetProcessor<CorrelatorAdapter>, EventSetProcessorOperations, Processor<CorrelatorAdapter>, ProcessorAdapterFactory<CorrelatorAdapter>, ProcessorOperations

Direct Known Subclasses:

DefaultBuilderCorrelator, JCorrelator

public abstract class BaseCorrelator
extends BaseEventSetProcessor<CorrelatorAdapter>
implements Correlator

Constructor Summary

Constructors

Constructor and Description
BaseCorrelator()

Method Summary

Modifier and Type	Method and Description
CorrelatorAdapter	createAdapter()
void	finish()
Lock	getLock() Returns the lock that can be used to synchronize threads when the instance synchronous flag is set to false.
BaseCorrelatorMeta	getMeta()
boolean	onAcceptAsFirst(Event event)
void	onDuration()
BaseCorrelator	withCategory(String category)
BaseCorrelator	withDescription(String description)
BaseCorrelator	withDuration(Duration duration)
BaseCorrelator	withEvent(String eventName)
BaseCorrelator	withEvents(List<String> eventNames)
BaseCorrelator	withFeature(String name, Object value)
BaseCorrelator	withFeatures(Map<String,Object> features)
BaseCorrelator	withInstanceSynchronous(boolean instanceSynchronous)
BaseCorrelator	withLabel(String label)
BaseCorrelator	withMaxInstances(int maxInstances)
BaseCorrelator	withName(String name)
BaseCorrelator	withSynchronous(Boolean synchronous)
BaseCorrelator	withVersion(Integer version)

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

getEventSetProcessorAdapterImpl, getFirstEvent, getGroup

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

getAdapter, getKb, getKnowledgeBase, getLogger, getSponge, onInit, setAdapter, toString

Methods inherited from class java.lang.Object

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

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

onEvent

Methods inherited from interface org.openksavi.sponge.EventSetProcessor

getFirstEvent, getGroup

Methods inherited from interface org.openksavi.sponge.Processor

getAdapter, getLogger, getSponge, onConfigure, onInit

Methods inherited from interface org.openksavi.sponge.ProcessorOperations

getKnowledgeBase

Constructor Detail

BaseCorrelator

public BaseCorrelator()

Method Detail

getMeta

public BaseCorrelatorMeta getMeta()

Specified by:

getMeta in interface CorrelatorOperations

Specified by:

getMeta in interface EventProcessorOperations

Specified by:

getMeta in interface EventSetProcessorOperations

Specified by:

getMeta in interface ProcessorOperations

Overrides:

getMeta in class BaseEventSetProcessor<CorrelatorAdapter>

finish

public final void finish()

Specified by:

finish in interface Correlator

onAcceptAsFirst

public boolean onAcceptAsFirst(Event event)

Specified by:

onAcceptAsFirst in interface Correlator

onDuration

public void onDuration()

Specified by:

onDuration in interface Correlator

createAdapter

public final CorrelatorAdapter createAdapter()

Specified by:

createAdapter in interface ProcessorAdapterFactory<CorrelatorAdapter>

getLock

public final Lock getLock()

Returns the lock that can be used to synchronize threads when the instance synchronous flag is set to false.

Returns:

the lock.

withName

public BaseCorrelator withName(String name)

Overrides:

withName in class BaseProcessor<CorrelatorAdapter>

withLabel

public BaseCorrelator withLabel(String label)

Overrides:

withLabel in class BaseProcessor<CorrelatorAdapter>

withDescription

public BaseCorrelator withDescription(String description)

Overrides:

withDescription in class BaseProcessor<CorrelatorAdapter>

withVersion

public BaseCorrelator withVersion(Integer version)

Overrides:

withVersion in class BaseProcessor<CorrelatorAdapter>

withFeatures

public BaseCorrelator withFeatures(Map<String,Object> features)

Overrides:

withFeatures in class BaseProcessor<CorrelatorAdapter>

withFeature

public BaseCorrelator withFeature(String name,
                                  Object value)

Overrides:

withFeature in class BaseProcessor<CorrelatorAdapter>

withCategory

public BaseCorrelator withCategory(String category)

Overrides:

withCategory in class BaseProcessor<CorrelatorAdapter>

withEvents

public BaseCorrelator withEvents(List<String> eventNames)

Overrides:

withEvents in class BaseEventProcessor<CorrelatorAdapter>

withEvent

public BaseCorrelator withEvent(String eventName)

Overrides:

withEvent in class BaseEventProcessor<CorrelatorAdapter>

withDuration

public BaseCorrelator withDuration(Duration duration)

Overrides:

withDuration in class BaseEventSetProcessor<CorrelatorAdapter>

withSynchronous

public BaseCorrelator withSynchronous(Boolean synchronous)

Overrides:

withSynchronous in class BaseEventSetProcessor<CorrelatorAdapter>

withMaxInstances

public BaseCorrelator withMaxInstances(int maxInstances)

withInstanceSynchronous

public BaseCorrelator withInstanceSynchronous(boolean instanceSynchronous)