io.siddhi.core.query.processor.stream

Class AbstractStreamProcessor

java.lang.Object

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

All Implemented Interfaces:

Processor, EternalReferencedHolder, Snapshotable

Direct Known Subclasses:

StreamFunctionProcessor, StreamProcessor, WindowProcessor

public abstract class AbstractStreamProcessor
extends Object
implements Processor, EternalReferencedHolder, Snapshotable

Abstract implementation of Processor intended to be used by any Stream Processors.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<io.siddhi.query.api.definition.Attribute>	additionalAttributes
protected ExpressionExecutor[]	attributeExpressionExecutors
protected int	attributeExpressionLength
protected ComplexEventPopulater	complexEventPopulater
protected String	elementId
protected io.siddhi.query.api.definition.AbstractDefinition	inputDefinition
protected MetaStreamEvent	metaStreamEvent
protected Processor	nextProcessor
protected SiddhiQueryContext	siddhiQueryContext
protected StreamEventCloner	streamEventCloner
protected StreamEventClonerHolder	streamEventClonerHolder

Constructor Summary

Constructors

Constructor and Description
AbstractStreamProcessor()

Method Summary

Modifier and Type	Method and Description
void	clean() Used to clean its references
Processor	cloneProcessor(String key) Clone a copy of processor
void	constructStreamEventPopulater(MetaStreamEvent metaStreamEvent, int streamEventChainIndex)
String	getElementId()
Processor	getNextProcessor() Get next processor element in the processor chain.
abstract ProcessingMode	getProcessingMode() Defines the behaviour of the processing, will be called after the init
protected abstract 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
void	initProcessor(MetaStreamEvent metaStreamEvent, ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, boolean outputExpectsExpiredEvents, io.siddhi.query.api.SiddhiElement siddhiElement, SiddhiQueryContext siddhiQueryContext)
void	process(ComplexEventChunk streamEventChunk) Process the handed StreamEvent
protected abstract void	processEventChunk(ComplexEventChunk<StreamEvent> streamEventChunk, Processor nextProcessor, StreamEventCloner streamEventCloner, ComplexEventPopulater complexEventPopulater) The main processing method that will be called upon event arrival
void	setNextProcessor(Processor processor) Set next processor element in processor chain
void	setStreamEventCloner(StreamEventCloner streamEventCloner)
void	setToLast(Processor processor) Set as the last element of the processor chain

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

Field Detail

nextProcessor

protected Processor nextProcessor

additionalAttributes

protected List<io.siddhi.query.api.definition.Attribute> additionalAttributes

metaStreamEvent

protected MetaStreamEvent metaStreamEvent

siddhiQueryContext

protected SiddhiQueryContext siddhiQueryContext

streamEventClonerHolder

protected StreamEventClonerHolder streamEventClonerHolder

streamEventCloner

protected StreamEventCloner streamEventCloner

inputDefinition

protected io.siddhi.query.api.definition.AbstractDefinition inputDefinition

attributeExpressionExecutors

protected ExpressionExecutor[] attributeExpressionExecutors

attributeExpressionLength

protected int attributeExpressionLength

complexEventPopulater

protected ComplexEventPopulater complexEventPopulater

elementId

protected String elementId

Constructor Detail

AbstractStreamProcessor

public AbstractStreamProcessor()

Method Detail

initProcessor

public void initProcessor(MetaStreamEvent metaStreamEvent,
                          ExpressionExecutor[] attributeExpressionExecutors,
                          ConfigReader configReader,
                          boolean outputExpectsExpiredEvents,
                          io.siddhi.query.api.SiddhiElement siddhiElement,
                          SiddhiQueryContext siddhiQueryContext)

init

protected abstract 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

Parameters:

metaStreamEvent - the stream event meta

inputDefinition - the incoming stream definition

attributeExpressionExecutors - the executors of each function parameters

configReader - this hold the AbstractStreamProcessor extensions configuration reader.

outputExpectsExpiredEvents - is expired events sent as output

siddhiQueryContext - current siddhi query context

Returns:

the additional output attributes introduced by the function

process

public void process(ComplexEventChunk streamEventChunk)

Description copied from interface: Processor

Process the handed StreamEvent

Specified by:

process in interface Processor

Parameters:

streamEventChunk - event chunk to be processed

processEventChunk

protected abstract void processEventChunk(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

getNextProcessor

public Processor getNextProcessor()

Description copied from interface: Processor

Get next processor element in the processor chain. Processed event should be sent to next processor

Specified by:

getNextProcessor in interface Processor

Returns:

next processor

setNextProcessor

public void setNextProcessor(Processor processor)

Description copied from interface: Processor

Set next processor element in processor chain

Specified by:

setNextProcessor in interface Processor

Parameters:

processor - Processor to be set as next element of processor chain

cloneProcessor

public Processor cloneProcessor(String key)

Description copied from interface: Processor

Clone a copy of processor

Specified by:

cloneProcessor in interface Processor

Parameters:

key - partition key

Returns:

cloned processor

constructStreamEventPopulater

public void constructStreamEventPopulater(MetaStreamEvent metaStreamEvent,
                                          int streamEventChainIndex)

setStreamEventCloner

public void setStreamEventCloner(StreamEventCloner streamEventCloner)

setToLast

public void setToLast(Processor processor)

Description copied from interface: Processor

Set as the last element of the processor chain

Specified by:

setToLast in interface Processor

Parameters:

processor - Last processor in the chain

getElementId

public String getElementId()

Specified by:

getElementId in interface Snapshotable

clean

public void clean()

Description copied from interface: Processor

Used to clean its references

Specified by:

clean in interface Processor

Specified by:

clean in interface Snapshotable

getProcessingMode

public abstract ProcessingMode getProcessingMode()

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

Returns:

ProcessingMode processing mode of the processor