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

Class StreamFunctionProcessor

java.lang.Object

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

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

All Implemented Interfaces:

Processor, EternalReferencedHolder, Snapshotable

Direct Known Subclasses:

Pol2CartStreamFunctionProcessor

public abstract class StreamFunctionProcessor
extends AbstractStreamProcessor

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, executionPlanContext, inputDefinition, log, nextProcessor, queryName, streamEventCloner

Constructor Summary

Constructors

Constructor and Description
StreamFunctionProcessor()

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, ExecutionPlanContext executionPlanContext)
protected List<org.wso2.siddhi.query.api.definition.Attribute>	init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition, ExpressionExecutor[] attributeExpressionExecutors, ExecutionPlanContext executionPlanContext, boolean outputExpectsExpiredEvents) The init method of the StreamProcessor, this method will be called before other methods
protected abstract Object[]	process(Object data) The process method of the StreamFunction, used when zero or one function parameter is provided
protected abstract Object[]	process(Object[] data) The process method of the StreamFunction, used when more then one function parameters are provided
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

StreamFunctionProcessor

public StreamFunctionProcessor()

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 Object[] process(Object[] data)

The process method of the StreamFunction, used when more then one function parameters are provided

Parameters:

data - the data values for the function parameters

Returns:

the data for additional output attributes introduced by the function

process

protected abstract Object[] process(Object data)

The process method of the StreamFunction, used when zero or one function parameter is provided

Parameters:

data - null if the function parameter count is zero or runtime data value of the function parameter

Returns:

the data for additional output attribute introduced by the function

init

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

The init 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

executionPlanContext - the context of the execution plan

outputExpectsExpiredEvents - is output expects ExpiredEvents

Returns:

the additional output attributes introduced by the function

init

protected abstract List<org.wso2.siddhi.query.api.definition.Attribute> init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition,
                                                                             ExpressionExecutor[] attributeExpressionExecutors,
                                                                             ExecutionPlanContext executionPlanContext)