org.wso2.siddhi.core.query.processor.stream.window

Class UniqueExternalTimeBatchWindowProcessor

java.lang.Object

org.wso2.siddhi.core.query.processor.stream.AbstractStreamProcessor

org.wso2.siddhi.core.query.processor.stream.window.WindowProcessor

org.wso2.siddhi.core.query.processor.stream.window.UniqueExternalTimeBatchWindowProcessor

All Implemented Interfaces:

Processor, SchedulingProcessor, FindableProcessor, EternalReferencedHolder, Snapshotable

public class UniqueExternalTimeBatchWindowProcessor
extends WindowProcessor
implements SchedulingProcessor, FindableProcessor

Field Summary

Fields inherited from class org.wso2.siddhi.core.query.processor.stream.window.WindowProcessor

outputExpectsExpiredEvents

Fields inherited from class org.wso2.siddhi.core.query.processor.stream.AbstractStreamProcessor

additionalAttributes, attributeExpressionExecutors, attributeExpressionLength, complexEventPopulater, elementId, executionPlanContext, inputDefinition, log, nextProcessor, queryName, streamEventCloner

Constructor Summary

Constructors

Constructor and Description
UniqueExternalTimeBatchWindowProcessor()

Method Summary

Modifier and Type	Method and Description
Finder	constructFinder(org.wso2.siddhi.query.api.expression.Expression expression, MatchingMetaStateHolder matchingMetaStateHolder, ExecutionPlanContext executionPlanContext, List<VariableExpressionExecutor> variableExpressionExecutors, Map<String,EventTable> eventTableMap) To construct a finder having the capability of finding events at the processor that corresponds to the incoming matchingEvent and the given matching expression logic.
Object[]	currentState() Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time
StreamEvent	find(StateEvent matchingEvent, Finder finder) To find events from the processor event pool, that the matches the matchingEvent based on finder logic.
Scheduler	getScheduler()
protected void	init(ExpressionExecutor[] attributeExpressionExecutors, ExecutionPlanContext executionPlanContext) The init method of the WindowProcessor, this method will be called before other methods
protected void	process(ComplexEventChunk<StreamEvent> streamEventChunk, Processor nextProcessor, StreamEventCloner streamEventCloner) Here an assumption is taken: Parameter: timestamp: The time which the window determines as current time and will act upon, the value of this parameter should be monotonically increasing.
void	restoreState(Object[] state) Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.
void	setScheduler(Scheduler scheduler)
void	start() This will be called only once and this can be used to acquire required resources for the processing element.
void	stop() This will be called only once and this can be used to release the acquired resources for processing.

Methods inherited from class org.wso2.siddhi.core.query.processor.stream.window.WindowProcessor

init, processEventChunk

Methods inherited from class org.wso2.siddhi.core.query.processor.stream.AbstractStreamProcessor

cloneProcessor, constructStreamEventPopulater, getElementId, getNextProcessor, initProcessor, process, setNextProcessor, setStreamEventCloner, setToLast

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wso2.siddhi.core.query.processor.Processor

cloneProcessor, getNextProcessor, process, setNextProcessor, setToLast

Constructor Detail

UniqueExternalTimeBatchWindowProcessor

public UniqueExternalTimeBatchWindowProcessor()

Method Detail

init

protected void init(ExpressionExecutor[] attributeExpressionExecutors,
                    ExecutionPlanContext executionPlanContext)

Description copied from class: WindowProcessor

The init method of the WindowProcessor, this method will be called before other methods

Specified by:

init in class WindowProcessor

Parameters:

attributeExpressionExecutors - the executors of each function parameters

executionPlanContext - the context of the execution plan

process

protected void process(ComplexEventChunk<StreamEvent> streamEventChunk,
                       Processor nextProcessor,
                       StreamEventCloner streamEventCloner)

Here an assumption is taken: Parameter: timestamp: The time which the window determines as current time and will act upon, the value of this parameter should be monotonically increasing. from https://docs.wso2.com/display/CEP400/Inbuilt+Windows#InbuiltWindows-externalTime

Specified by:

process in class WindowProcessor

Parameters:

streamEventChunk - the stream event chunk that need to be processed

nextProcessor - the next processor to which the success events need to be passed

streamEventCloner - helps to clone the incoming event for local storage or modification

start

public void start()

Description copied from interface: EternalReferencedHolder

This will be called only once and this can be used to acquire required resources for the processing element. This will be called after initializing the system and before starting to process the events.

Specified by:

start in interface EternalReferencedHolder

stop

public void stop()

Description copied from interface: EternalReferencedHolder

This will be called only once and this can be used to release the acquired resources for processing. This will be called before shutting down the system.

Specified by:

stop in interface EternalReferencedHolder

currentState

public Object[] currentState()

Description copied from interface: Snapshotable

Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time

Specified by:

currentState in interface Snapshotable

Returns:

stateful objects of the processing element as an array

restoreState

public void restoreState(Object[] state)

Description copied from interface: Snapshotable

Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.

Specified by:

restoreState in interface Snapshotable

Parameters:

state - the stateful objects of the element as an array on the same order provided by currentState().

setScheduler

public void setScheduler(Scheduler scheduler)

Specified by:

setScheduler in interface SchedulingProcessor

getScheduler

public Scheduler getScheduler()

Specified by:

getScheduler in interface SchedulingProcessor

find

public StreamEvent find(StateEvent matchingEvent,
                        Finder finder)

Description copied from interface: FindableProcessor

To find events from the processor event pool, that the matches the matchingEvent based on finder logic.

Specified by:

find in interface FindableProcessor

Parameters:

matchingEvent - the event to be matched with the events at the processor

finder - the execution element responsible for finding the corresponding events that matches the matchingEvent based on pool of events at Processor

Returns:

the matched events

constructFinder

public Finder constructFinder(org.wso2.siddhi.query.api.expression.Expression expression,
                              MatchingMetaStateHolder matchingMetaStateHolder,
                              ExecutionPlanContext executionPlanContext,
                              List<VariableExpressionExecutor> variableExpressionExecutors,
                              Map<String,EventTable> eventTableMap)

Description copied from interface: FindableProcessor

To construct a finder having the capability of finding events at the processor that corresponds to the incoming matchingEvent and the given matching expression logic.

Specified by:

constructFinder in interface FindableProcessor

Parameters:

expression - the matching expression

matchingMetaStateHolder - the meta structure of the incoming matchingEvent

executionPlanContext - current execution plan context

variableExpressionExecutors - the list of variable ExpressionExecutors already created

eventTableMap - map of event tables

Returns:

finder having the capability of finding events at the processor against the expression and incoming matchingEvent