io.siddhi.core.query.processor.stream.function

Class StreamFunctionProcessor

java.lang.Object

io.siddhi.core.query.processor.stream.AbstractStreamProcessor

io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

All Implemented Interfaces:

Processor, EternalReferencedHolder, Snapshotable

Direct Known Subclasses:

Pol2CartStreamFunctionProcessor

public abstract class StreamFunctionProcessor
extends AbstractStreamProcessor

Stream Processor to handle Stream Functions.

Field Summary

Fields inherited from class io.siddhi.core.query.processor.stream.AbstractStreamProcessor

additionalAttributes, attributeExpressionExecutors, attributeExpressionLength, complexEventPopulater, elementId, inputDefinition, metaStreamEvent, nextProcessor, siddhiQueryContext, streamEventCloner, streamEventClonerHolder

Constructor Summary

Constructors

Constructor and Description
StreamFunctionProcessor()

Method Summary

Modifier and Type	Method and Description
ProcessingMode	getProcessingMode() Defines the behaviour of the processing, will be called after the init
protected abstract List<io.siddhi.query.api.definition.Attribute>	init(io.siddhi.query.api.definition.AbstractDefinition inputDefinition, ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, boolean outputExpectsExpiredEvents, SiddhiQueryContext siddhiQueryContext) The init method of the StreamProcessor, this method will be called before other methods
protected List<io.siddhi.query.api.definition.Attribute>	init(MetaStreamEvent metaStreamEvent, io.siddhi.query.api.definition.AbstractDefinition inputDefinition, ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, boolean outputExpectsExpiredEvents, SiddhiQueryContext siddhiQueryContext) 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 io.siddhi.core.query.processor.stream.AbstractStreamProcessor

clean, 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 io.siddhi.core.util.extension.holder.EternalReferencedHolder

start, stop

Methods inherited from interface io.siddhi.core.util.snapshot.Snapshotable

currentState, restoreState

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

getProcessingMode

public ProcessingMode getProcessingMode()

Description copied from class: AbstractStreamProcessor

Defines the behaviour of the processing, will be called after the init

Specified by:

getProcessingMode in class AbstractStreamProcessor

Returns:

ProcessingMode processing mode of the processor

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<io.siddhi.query.api.definition.Attribute> init(MetaStreamEvent metaStreamEvent,
                                                              io.siddhi.query.api.definition.AbstractDefinition inputDefinition,
                                                              ExpressionExecutor[] attributeExpressionExecutors,
                                                              ConfigReader configReader,
                                                              boolean outputExpectsExpiredEvents,
                                                              SiddhiQueryContext siddhiQueryContext)

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

Specified by:

init in class AbstractStreamProcessor

Parameters:

metaStreamEvent - the stream event meta

inputDefinition - the incoming stream definition

attributeExpressionExecutors - the executors of each function parameters

configReader - this hold the StreamFunctionProcessor extensions configuration reader.

outputExpectsExpiredEvents - is expired events sent as output

siddhiQueryContext - siddhi query context

Returns:

the additional output attributes introduced by the function

init

protected abstract List<io.siddhi.query.api.definition.Attribute> init(io.siddhi.query.api.definition.AbstractDefinition inputDefinition,
                                                                       ExpressionExecutor[] attributeExpressionExecutors,
                                                                       ConfigReader configReader,
                                                                       boolean outputExpectsExpiredEvents,
                                                                       SiddhiQueryContext siddhiQueryContext)

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

Parameters:

inputDefinition - the incoming stream definition

attributeExpressionExecutors - the executors of each function parameters

configReader - this hold the StreamFunctionProcessor extensions configuration reader.

outputExpectsExpiredEvents - is expired events sent as output

siddhiQueryContext - the context of the siddhi query

Returns:

the additional output attributes introduced by the function