org.wso2.extension.siddhi.execution.word.function

Class WordFunction

java.lang.Object

io.siddhi.core.executor.function.FunctionExecutor

org.wso2.extension.siddhi.execution.word.function.WordFunction

All Implemented Interfaces:

io.siddhi.core.executor.ExpressionExecutor

public class WordFunction
extends io.siddhi.core.executor.function.FunctionExecutor

country(string) Returns word if the given word is meaningful. Accept Type(s): STRING Return Type(s): BOOLEAN

Field Summary

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

attributeExpressionExecutors, functionId, processingMode, siddhiQueryContext

Constructor Summary

Constructors

Constructor and Description
WordFunction()

Method Summary

Modifier and Type	Method and Description
protected Object	execute(Object[] data, io.siddhi.core.util.snapshot.state.State state) The main execution method which will be called upon event arrival when there are more than one Function parameter
protected Object	execute(Object data, io.siddhi.core.util.snapshot.state.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() return a Class object that represents the formal return type of the method represented by this Method object.
protected io.siddhi.core.util.snapshot.state.StateFactory	init(io.siddhi.core.executor.ExpressionExecutor[] attributeExpressionExecutors, io.siddhi.core.util.config.ConfigReader configReader, io.siddhi.core.config.SiddhiQueryContext siddhiQueryContext) The initialization method for FunctionExecutor, which will be called before other methods and validate the all configuration and getting the initial values.

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

execute, execute, execute, initExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

WordFunction

public WordFunction()

Method Detail

init

protected io.siddhi.core.util.snapshot.state.StateFactory init(io.siddhi.core.executor.ExpressionExecutor[] attributeExpressionExecutors,
                                                               io.siddhi.core.util.config.ConfigReader configReader,
                                                               io.siddhi.core.config.SiddhiQueryContext siddhiQueryContext)

The initialization method for FunctionExecutor, which will be called before other methods and validate the all configuration and getting the initial values.

Specified by:

init in class io.siddhi.core.executor.function.FunctionExecutor

Parameters:

attributeExpressionExecutors - are the executors of each attributes in the Function

configReader - this hold the FunctionExecutor extensions configuration reader.

siddhiQueryContext - the context of the siddhi query

execute

protected Object execute(Object[] data,
                         io.siddhi.core.util.snapshot.state.State state)

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

Specified by:

execute in class io.siddhi.core.executor.function.FunctionExecutor

Parameters:

data - the runtime values of Function parameters

state - current query state

Returns:

the Function result

execute

protected Object execute(Object data,
                         io.siddhi.core.util.snapshot.state.State state)

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

Specified by:

execute in class io.siddhi.core.executor.function.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

getReturnType

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

return a Class object that represents the formal return type of the method represented by this Method object.

Returns:

the return type for the method this object represents