org.wso2.extension.siddhi.execution.geo

Class ReverseGeocodeStreamFunctionProcessor

java.lang.Object

io.siddhi.core.query.processor.stream.AbstractStreamProcessor<S>

io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor<io.siddhi.core.util.snapshot.state.State>

org.wso2.extension.siddhi.execution.geo.ReverseGeocodeStreamFunctionProcessor

All Implemented Interfaces:

io.siddhi.core.query.processor.Processor, io.siddhi.core.util.extension.holder.ExternalReferencedHolder

public class ReverseGeocodeStreamFunctionProcessor
extends io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor<io.siddhi.core.util.snapshot.state.State>

This extension transforms a latitude and longitude coordinates into precise address information. The output contains string properties streetNumber, neighborhood, route, administrativeAreaLevelTwo, administrativeAreaLevelOne, country, countryCode, postalCode and formattedAddress in order. However, these information are not available for all the geo coordinates. For example, if the latitude and longitude represent a place in a forest, only the high level information like country will be returned. For those which are not available, this extension will return "N/A" as the value.

Field Summary

Fields inherited from class io.siddhi.core.query.processor.stream.AbstractStreamProcessor

attributeExpressionExecutors, attributeExpressionLength, complexEventPopulater, inputDefinition, metaStreamEvent, nextProcessor, siddhiQueryContext, stateHolder, streamEventClonerHolder

Constructor Summary

Constructors

Constructor and Description
ReverseGeocodeStreamFunctionProcessor()

Method Summary

Modifier and Type	Method and Description
List<io.siddhi.query.api.definition.Attribute>	getReturnAttributes()
protected io.siddhi.core.util.snapshot.state.StateFactory<io.siddhi.core.util.snapshot.state.State>	init(io.siddhi.query.api.definition.AbstractDefinition abstractDefinition, io.siddhi.core.executor.ExpressionExecutor[] attributeExpressionExecutors, io.siddhi.core.util.config.ConfigReader configReader, boolean outputExpectsExpiredEvents, io.siddhi.core.config.SiddhiQueryContext siddhiQueryContext) 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	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 io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor

getProcessingMode, init, processEventChunk

Methods inherited from class io.siddhi.core.query.processor.stream.AbstractStreamProcessor

constructStreamEventPopulater, 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

ReverseGeocodeStreamFunctionProcessor

public ReverseGeocodeStreamFunctionProcessor()

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 io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor<io.siddhi.core.util.snapshot.state.State>

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 io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor<io.siddhi.core.util.snapshot.state.State>

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 io.siddhi.core.util.snapshot.state.StateFactory<io.siddhi.core.util.snapshot.state.State> init(io.siddhi.query.api.definition.AbstractDefinition abstractDefinition,
                                                                                                         io.siddhi.core.executor.ExpressionExecutor[] attributeExpressionExecutors,
                                                                                                         io.siddhi.core.util.config.ConfigReader configReader,
                                                                                                         boolean outputExpectsExpiredEvents,
                                                                                                         io.siddhi.core.config.SiddhiQueryContext siddhiQueryContext)

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

Specified by:

init in class io.siddhi.core.query.processor.stream.function.StreamFunctionProcessor<io.siddhi.core.util.snapshot.state.State>

Parameters:

abstractDefinition - the incoming stream definition

attributeExpressionExecutors - the executors of each function parameters

outputExpectsExpiredEvents - whether output can be expired event

siddhiQueryContext - siddhi query context

configReader - this hold the stream Processor configuration reader.

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.

getReturnAttributes

public List<io.siddhi.query.api.definition.Attribute> getReturnAttributes()

Specified by:

getReturnAttributes in class io.siddhi.core.query.processor.stream.AbstractStreamProcessor<io.siddhi.core.util.snapshot.state.State>