org.wso2.siddhi.core.window

Class EventWindow

java.lang.Object

org.wso2.siddhi.core.window.EventWindow

All Implemented Interfaces:

FindableProcessor, Snapshotable

public class EventWindow
extends Object
implements FindableProcessor, Snapshotable

Window implementation of SiddhiQL. It can be seen as a global Window which can be accessed from multiple queries.

Constructor Summary

Constructors

Constructor and Description
EventWindow(org.wso2.siddhi.query.api.definition.WindowDefinition windowDefinition, ExecutionPlanContext executionPlanContext) Construct a EventWindow object.

Method Summary

Modifier and Type	Method and Description
void	add(ComplexEventChunk complexEventChunk) Add the given ComplexEventChunk to the EventWindow.
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() Return an object array containing the internal state of the internalWindowProcessor.
StreamEvent	find(StateEvent matchingEvent, Finder finder) To find events from the processor event pool, that the matches the matchingEvent based on finder logic.
String	getElementId() Return the elementId which may be used for snapshot creation.
LockWrapper	getLock()
org.wso2.siddhi.query.api.definition.WindowDefinition	getWindowDefinition() Return the WindowDefinition used to construct this EventWindow.
void	init(Map<String,EventTable> eventTableMap, Map<String,EventWindow> eventWindowMap, LatencyTracker latencyTracker, String queryName) Initialize the WindowEvent table by creating WindowProcessor to handle the events.
void	restoreState(Object[] state) Restore the internalWindowProcessor using given state.
void	setPublisher(StreamJunction.Publisher publisher) Set Publisher to which the the output events from internal window have to be sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventWindow

public EventWindow(org.wso2.siddhi.query.api.definition.WindowDefinition windowDefinition,
                   ExecutionPlanContext executionPlanContext)

Construct a EventWindow object.

Parameters:

windowDefinition - definition of the window

executionPlanContext - execution plan context of Siddhi

Method Detail

init

public void init(Map<String,EventTable> eventTableMap,
                 Map<String,EventWindow> eventWindowMap,
                 LatencyTracker latencyTracker,
                 String queryName)

Initialize the WindowEvent table by creating WindowProcessor to handle the events.

Parameters:

eventTableMap - map of EventTables

eventWindowMap - map of EventWindows

latencyTracker - to rack the latency if statistic of underlying WindowProcessor is required

setPublisher

public void setPublisher(StreamJunction.Publisher publisher)

Set Publisher to which the the output events from internal window have to be sent.

Parameters:

publisher - output publisher

getWindowDefinition

public org.wso2.siddhi.query.api.definition.WindowDefinition getWindowDefinition()

Return the WindowDefinition used to construct this EventWindow.

Returns:

the window definition

add

public void add(ComplexEventChunk complexEventChunk)

Add the given ComplexEventChunk to the EventWindow.

Parameters:

complexEventChunk - the event chunk to be added

find

public StreamEvent find(StateEvent matchingEvent,
                        Finder finder)

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)

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

getLock

public LockWrapper getLock()

currentState

public Object[] currentState()

Return an object array containing the internal state of the internalWindowProcessor.

Specified by:

currentState in interface Snapshotable

Returns:

current state of the EventWindow

restoreState

public void restoreState(Object[] state)

Restore the internalWindowProcessor using given state.

Specified by:

restoreState in interface Snapshotable

Parameters:

state - the stateful objects of the element as an array on

getElementId

public String getElementId()

Return the elementId which may be used for snapshot creation.

Specified by:

getElementId in interface Snapshotable

Returns:

the element id of this Snapshotable object