Package io.siddhi.core.executor

Class EventVariableFunctionExecutor

java.lang.Object

io.siddhi.core.executor.function.FunctionExecutor

io.siddhi.core.executor.EventVariableFunctionExecutor

All Implemented Interfaces:

ExpressionExecutor, Serializable

public class EventVariableFunctionExecutor
extends FunctionExecutor

Executor class for Siddhi that extracts events.

See Also:

Serialized Form

Field Summary

Fields inherited from class io.siddhi.core.executor.function.FunctionExecutor

attributeExpressionExecutors, functionId, processingMode, siddhiQueryContext

Constructor Summary

Constructors

Constructor	Description
EventVariableFunctionExecutor(int streamEventChainIndex, int streamEventIndexInChain)

Method Summary

Modifier and Type	Method	Description
Object	execute(ComplexEvent event)	The main execution method which will be called upon event arrival
protected Object	execute(Object[] data, State state)	The main execution method which will be called upon event arrival when there are more then one function parameter
protected Object	execute(Object data, State state)	The main execution method which will be called upon event arrival when there are zero or one function parameter
io.siddhi.query.api.definition.Attribute.Type	getReturnType()
protected StateFactory	init(ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, SiddhiQueryContext siddhiQueryContext)	The initialization method for FunctionExecutor, this method will be called before the other methods

Methods inherited from class io.siddhi.core.executor.function.FunctionExecutor

execute, execute, initExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

EventVariableFunctionExecutor

public EventVariableFunctionExecutor(int streamEventChainIndex,
                                     int streamEventIndexInChain)

Method Detail

init

protected StateFactory init(ExpressionExecutor[] attributeExpressionExecutors,
                            ConfigReader configReader,
                            SiddhiQueryContext siddhiQueryContext)

Description copied from class: FunctionExecutor

The initialization method for FunctionExecutor, this method will be called before the other methods

Specified by:

init in class FunctionExecutor

Parameters:

attributeExpressionExecutors - are the executors of each function parameters

configReader - This hold the FunctionExecutor extensions configuration reader.

siddhiQueryContext - the context of the siddhi query

getReturnType

public io.siddhi.query.api.definition.Attribute.Type getReturnType()

execute

protected Object execute(Object[] data,
                         State state)

Description copied from class: FunctionExecutor

The main execution method which will be called upon event arrival when there are more then one function parameter

Specified by:

execute in class FunctionExecutor

Parameters:

data - the runtime values of function parameters

state - current query state

Returns:

the function result

execute

protected Object execute(Object data,
                         State state)

Description copied from class: FunctionExecutor

The main execution method which will be called upon event arrival when there are zero or one function parameter

Specified by:

execute in class FunctionExecutor

Parameters:

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

state - current query state

Returns:

the function result

execute

public Object execute(ComplexEvent event)

Description copied from class: FunctionExecutor

The main execution method which will be called upon event arrival

Specified by:

execute in interface ExpressionExecutor

Overrides:

execute in class FunctionExecutor

Parameters:

event - the event to be executed

Returns:

the execution result