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

Class StreamProcessor

java.lang.Object

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

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

All Implemented Interfaces:

Processor, EternalReferencedHolder, Snapshotable

Direct Known Subclasses:

LogStreamProcessor

public abstract class StreamProcessor
extends AbstractStreamProcessor

For Siddhi extensions, extend this class to use the functionality of AbstractStreamProcessor. This class processes only StreamEvents. Use StreamFunctionProcessor to process StateEvents.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	outputExpectsExpiredEvents

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

additionalAttributes, attributeExpressionExecutors, attributeExpressionLength, complexEventPopulater, elementId, inputDefinition, nextProcessor, queryName, siddhiAppContext, streamEventCloner, streamEventClonerHolder

Constructor Summary

Constructors

Constructor and Description
StreamProcessor()

Method Summary

Modifier and Type	Method and Description
protected abstract List<org.wso2.siddhi.query.api.definition.Attribute>	init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition, ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, SiddhiAppContext siddhiAppContext)
protected List<org.wso2.siddhi.query.api.definition.Attribute>	init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition, ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, SiddhiAppContext siddhiAppContext, boolean outputExpectsExpiredEvents) The configure method of the StreamProcessor, this method will be called before other methods
protected abstract void	process(ComplexEventChunk<StreamEvent> streamEventChunk, Processor nextProcessor, StreamEventCloner streamEventCloner, ComplexEventPopulater complexEventPopulater) The main processing method that will be called upon event arrival
protected void	processEventChunk(ComplexEventChunk<StreamEvent> streamEventChunk, Processor nextProcessor, StreamEventCloner streamEventCloner, ComplexEventPopulater complexEventPopulater) The main processing method that will be called upon event arrival

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.util.extension.holder.EternalReferencedHolder

start, stop

Methods inherited from interface org.wso2.siddhi.core.util.snapshot.Snapshotable

currentState, restoreState

Field Detail

outputExpectsExpiredEvents

protected boolean outputExpectsExpiredEvents

Constructor Detail

StreamProcessor

public StreamProcessor()

Method Detail

processEventChunk

protected void processEventChunk(ComplexEventChunk<StreamEvent> streamEventChunk,
                                 Processor nextProcessor,
                                 StreamEventCloner streamEventCloner,
                                 ComplexEventPopulater complexEventPopulater)

Description copied from class: AbstractStreamProcessor

The main processing method that will be called upon event arrival

Specified by:

processEventChunk in class AbstractStreamProcessor

Parameters:

streamEventChunk - the 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

complexEventPopulater - helps to populate the events with the resultant attributes

process

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

The main processing method that will be called upon event arrival

Parameters:

streamEventChunk - the 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

complexEventPopulater - helps to populate the events with the resultant attributes

init

protected List<org.wso2.siddhi.query.api.definition.Attribute> init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition,
                                                                    ExpressionExecutor[] attributeExpressionExecutors,
                                                                    ConfigReader configReader,
                                                                    SiddhiAppContext siddhiAppContext,
                                                                    boolean outputExpectsExpiredEvents)

The configure method of the StreamProcessor, this method will be called before other methods

Specified by:

init in class AbstractStreamProcessor

Parameters:

inputDefinition - the incoming stream definition

attributeExpressionExecutors - the executors of each function parameters

configReader - the config reader of StreamProcessor

siddhiAppContext - the context of the siddhi app

outputExpectsExpiredEvents - is output expects ExpiredEvents @return the additional output attributes introduced by the function

Returns:

list of attributes.

init

protected abstract List<org.wso2.siddhi.query.api.definition.Attribute> init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition,
                                                                             ExpressionExecutor[] attributeExpressionExecutors,
                                                                             ConfigReader configReader,
                                                                             SiddhiAppContext siddhiAppContext)