org.wso2.siddhi.core.executor.function

Class FunctionExecutor

java.lang.Object

org.wso2.siddhi.core.executor.function.FunctionExecutor

All Implemented Interfaces:

ExpressionExecutor, Snapshotable

Direct Known Subclasses:

CastFunctionExecutor, CoalesceFunctionExecutor, ConvertFunctionExecutor, CreateSetFunctionExecutor, CurrentTimeMillisFunctionExecutor, DefaultFunctionExecutor, EventTimestampFunctionExecutor, IfThenElseFunctionExecutor, IncrementalAggregateBaseTimeFunctionExecutor, IncrementalShouldUpdateFunctionExecutor, IncrementalStartTimeEndTimeFunctionExecutor, IncrementalTimeGetTimeZone, IncrementalUnixTimeFunctionExecutor, InstanceOfBooleanFunctionExecutor, InstanceOfDoubleFunctionExecutor, InstanceOfFloatFunctionExecutor, InstanceOfIntegerFunctionExecutor, InstanceOfLongFunctionExecutor, InstanceOfStringFunctionExecutor, MaximumFunctionExecutor, MinimumFunctionExecutor, ScriptFunctionExecutor, SizeOfSetFunctionExecutor, UUIDFunctionExecutor

public abstract class FunctionExecutor
extends Object
implements ExpressionExecutor, Snapshotable

Parent abstract class for Function Executors. Function executor will have one or more input parameters and single return value.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExpressionExecutor[]	attributeExpressionExecutors
protected String	elementId
protected String	functionId
protected String	queryName
protected SiddhiAppContext	siddhiAppContext

Constructor Summary

Constructors

Constructor and Description
FunctionExecutor()

Method Summary

Modifier and Type	Method and Description
void	clean() Used to clean its references
ExpressionExecutor	cloneExecutor(String key)
Object	execute(ComplexEvent event) The main execution method which will be called upon event arrival
protected abstract Object	execute(Object data) The main execution method which will be called upon event arrival when there are zero or one function parameter
protected abstract Object	execute(Object[] data) The main execution method which will be called upon event arrival when there are more then one function parameter
String	getElementId()
protected abstract void	init(ExpressionExecutor[] attributeExpressionExecutors, ConfigReader configReader, SiddhiAppContext siddhiAppContext) The initialization method for FunctionExecutor, this method will be called before the other methods
void	initExecutor(ExpressionExecutor[] attributeExpressionExecutors, SiddhiAppContext siddhiAppContext, String queryName, ConfigReader configReader)

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.executor.ExpressionExecutor

getReturnType

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

currentState, restoreState

Field Detail

attributeExpressionExecutors

protected ExpressionExecutor[] attributeExpressionExecutors

siddhiAppContext

protected SiddhiAppContext siddhiAppContext

elementId

protected String elementId

functionId

protected String functionId

queryName

protected String queryName

Constructor Detail

FunctionExecutor

public FunctionExecutor()

Method Detail

initExecutor

public void initExecutor(ExpressionExecutor[] attributeExpressionExecutors,
                         SiddhiAppContext siddhiAppContext,
                         String queryName,
                         ConfigReader configReader)

cloneExecutor

public ExpressionExecutor cloneExecutor(String key)

Specified by:

cloneExecutor in interface ExpressionExecutor

init

protected abstract void init(ExpressionExecutor[] attributeExpressionExecutors,
                             ConfigReader configReader,
                             SiddhiAppContext siddhiAppContext)

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

Parameters:

attributeExpressionExecutors - are the executors of each function parameters

configReader - This hold the FunctionExecutor extensions configuration reader.

siddhiAppContext - the context of the siddhi app

execute

public Object execute(ComplexEvent event)

The main execution method which will be called upon event arrival

Specified by:

execute in interface ExpressionExecutor

Parameters:

event - the event to be executed

Returns:

the execution result

execute

protected abstract Object execute(Object[] data)

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

Parameters:

data - the runtime values of function parameters

Returns:

the function result

execute

protected abstract Object execute(Object data)

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

Parameters:

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

Returns:

the function result

getElementId

public String getElementId()

Specified by:

getElementId in interface Snapshotable

clean

public void clean()

Description copied from interface: Snapshotable

Used to clean its references

Specified by:

clean in interface ExpressionExecutor

Specified by:

clean in interface Snapshotable