org.wso2.siddhi.extension.geo

Class GeocodeStreamFunctionProcessor

java.lang.Object

org.wso2.siddhi.core.query.processor.stream.AbstractStreamProcessor

org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

org.wso2.siddhi.extension.geo.GeocodeStreamFunctionProcessor

All Implemented Interfaces:

org.wso2.siddhi.core.query.processor.Processor, org.wso2.siddhi.core.util.extension.holder.EternalReferencedHolder, org.wso2.siddhi.core.util.snapshot.Snapshotable

public class GeocodeStreamFunctionProcessor
extends org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

This extension transforms a location into its geo-coordinates and formatted address

Field Summary

Fields inherited from class org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

outputExpectsExpiredEvents

Fields inherited from class org.wso2.siddhi.core.query.processor.stream.AbstractStreamProcessor

additionalAttributes, attributeExpressionExecutors, attributeExpressionLength, complexEventPopulater, elementId, executionPlanContext, inputDefinition, log, nextProcessor, queryName, streamEventCloner

Constructor Summary

Constructors

Constructor and Description
GeocodeStreamFunctionProcessor()

Method Summary

Modifier and Type	Method and Description
Object[]	currentState() Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time
protected List<org.wso2.siddhi.query.api.definition.Attribute>	init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition, org.wso2.siddhi.core.executor.ExpressionExecutor[] attributeExpressionExecutors, org.wso2.siddhi.core.config.ExecutionPlanContext executionPlanContext) The init method of the StreamProcessor, this method will be called before other methods
protected Object[]	process(Object data) The process method of the StreamFunction, used when zero or one function parameter is provided
protected Object[]	process(Object[] data) The process method of the StreamFunction, used when more then one function parameters are provided
void	restoreState(Object[] state) Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.
void	start() This will be called only once and this can be used to acquire required resources for the processing element.
void	stop() This will be called only once and this can be used to release the acquired resources for processing.

Methods inherited from class org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

init, processEventChunk

Methods inherited from class org.wso2.siddhi.core.query.processor.stream.AbstractStreamProcessor

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

Constructor Detail

GeocodeStreamFunctionProcessor

public GeocodeStreamFunctionProcessor()

Method Detail

process

protected Object[] process(Object[] data)

The process method of the StreamFunction, used when more then one function parameters are provided

Specified by:

process in class org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

Parameters:

data - the data values for the function parameters

Returns:

the data for additional output attributes introduced by the function

process

protected Object[] process(Object data)

The process method of the StreamFunction, used when zero or one function parameter is provided

Specified by:

process in class org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

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<org.wso2.siddhi.query.api.definition.Attribute> init(org.wso2.siddhi.query.api.definition.AbstractDefinition inputDefinition,
                                                                    org.wso2.siddhi.core.executor.ExpressionExecutor[] attributeExpressionExecutors,
                                                                    org.wso2.siddhi.core.config.ExecutionPlanContext executionPlanContext)

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

Specified by:

init in class org.wso2.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

Parameters:

inputDefinition - the incoming stream definition

attributeExpressionExecutors - the executors of each function parameters

executionPlanContext - the context of the execution plan

Returns:

the additional output attributes introduced by the function

start

public void start()

This will be called only once and this can be used to acquire required resources for the processing element. This will be called after initializing the system and before starting to process the events.

stop

public void stop()

This will be called only once and this can be used to release the acquired resources for processing. This will be called before shutting down the system.

currentState

public Object[] currentState()

Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time

Returns:

stateful objects of the processing element as an array

restoreState

public void restoreState(Object[] state)

Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.

Parameters:

state - the stateful objects of the element as an array on the same order provided by currentState().