org.wso2.extension.siddhi.execution.timeseries

Class LengthTimeLinearRegressionOutlierStreamProcessor

java.lang.Object

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

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

org.wso2.extension.siddhi.execution.timeseries.LengthTimeLinearRegressionOutlierStreamProcessor

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 LengthTimeLinearRegressionOutlierStreamProcessor
extends org.wso2.siddhi.core.query.processor.stream.StreamProcessor

The outlier function takes in a dependent event stream (Y), an independent event stream (X) and a user specified range for outliers, and returns an output to indicate whether the current event is an outlier based on the regression equation that fits historical data. This class detects outliers based on simple linear regression. Number of data points could be constrained using both time and length windows.

Field Summary

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

outputExpectsExpiredEvents

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

additionalAttributes, attributeExpressionExecutors, attributeExpressionLength, complexEventPopulater, elementId, inputDefinition, nextProcessor, queryName, siddhiAppContext, streamEventCloner, streamEventClonerHolder

Constructor Summary

Constructors

Constructor and Description
LengthTimeLinearRegressionOutlierStreamProcessor()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	currentState()
protected List<org.wso2.siddhi.query.api.definition.Attribute>	init(org.wso2.siddhi.query.api.definition.AbstractDefinition abstractDefinition, org.wso2.siddhi.core.executor.ExpressionExecutor[] expressionExecutors, org.wso2.siddhi.core.util.config.ConfigReader configReader, org.wso2.siddhi.core.config.SiddhiAppContext siddhiAppContext) The init method of the LinearRegressionOutlierStreamProcessor.
protected void	process(org.wso2.siddhi.core.event.ComplexEventChunk<org.wso2.siddhi.core.event.stream.StreamEvent> streamEventChunk, org.wso2.siddhi.core.query.processor.Processor nextProcessor, org.wso2.siddhi.core.event.stream.StreamEventCloner streamEventCloner, org.wso2.siddhi.core.event.stream.populater.ComplexEventPopulater complexEventPopulater) The main processing method that will be called upon event arrival.
void	restoreState(Map<String,Object> state)
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.StreamProcessor

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

LengthTimeLinearRegressionOutlierStreamProcessor

public LengthTimeLinearRegressionOutlierStreamProcessor()

Method Detail

init

protected List<org.wso2.siddhi.query.api.definition.Attribute> init(org.wso2.siddhi.query.api.definition.AbstractDefinition abstractDefinition,
                                                                    org.wso2.siddhi.core.executor.ExpressionExecutor[] expressionExecutors,
                                                                    org.wso2.siddhi.core.util.config.ConfigReader configReader,
                                                                    org.wso2.siddhi.core.config.SiddhiAppContext siddhiAppContext)

The init method of the LinearRegressionOutlierStreamProcessor. this method will be called before other methods

Specified by:

init in class org.wso2.siddhi.core.query.processor.stream.StreamProcessor

Parameters:

abstractDefinition - the incoming stream definition

expressionExecutors - the executors of each function parameters

siddhiAppContext - the context of the execution plan

Returns:

the additional output attributes introduced by the function

process

protected void process(org.wso2.siddhi.core.event.ComplexEventChunk<org.wso2.siddhi.core.event.stream.StreamEvent> streamEventChunk,
                       org.wso2.siddhi.core.query.processor.Processor nextProcessor,
                       org.wso2.siddhi.core.event.stream.StreamEventCloner streamEventCloner,
                       org.wso2.siddhi.core.event.stream.populater.ComplexEventPopulater complexEventPopulater)

The main processing method that will be called upon event arrival.

Specified by:

process in class org.wso2.siddhi.core.query.processor.stream.StreamProcessor

Parameters:

streamEventChunk - the event chunk that need to be processed

nextProcessor - the next processor to which the success events need to be passed

streamEventCloner - helps to clone the incoming event for local storage or modification

complexEventPopulater - helps to populate the events with the resultant attributes

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 Map<String,Object> currentState()

restoreState

public void restoreState(Map<String,Object> state)