com.espertech.esper.view.stat

Class BaseBivariateStatisticsView

java.lang.Object

com.espertech.esper.view.ViewSupport

com.espertech.esper.view.stat.BaseBivariateStatisticsView

All Implemented Interfaces:

DerivedValueView, EventCollection, GroupableView, View, Viewable, Iterable<EventBean>

Direct Known Subclasses:

CorrelationView, RegressionLinestView

public abstract class BaseBivariateStatisticsView
extends ViewSupport
implements DerivedValueView

View for computing statistics that require 2 input variable arrays containing X and Y datapoints. Subclasses compute correlation or regression values, for instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected StatViewAdditionalProps	additionalProps Additional properties.
protected AgentInstanceContext	agentInstanceContext Services required by implementing classes.
protected EventType	eventType Event type.
protected Object[]	lastValuesEventNew
protected BaseStatisticsBean	statisticsBean This bean can be overridden by subclasses providing extra values such as correlation, regression.
protected ViewFactory	viewFactory

Fields inherited from class com.espertech.esper.view.ViewSupport

EMPTY_VIEW_ARRAY, parent

Constructor Summary

Constructors

Constructor and Description
BaseBivariateStatisticsView(ViewFactory viewFactory, AgentInstanceContext agentInstanceContext, ExprNode expressionX, ExprEvaluator expressionXEval, ExprNode expressionY, ExprEvaluator expressionYEval, EventType eventType, StatViewAdditionalProps additionalProps) Constructor requires the name of the two fields to use in the parent view to compute the statistics.

Method Summary

Modifier and Type	Method and Description
StatViewAdditionalProps	getAdditionalProps()
ExprNode	getExpressionX() Returns the expression supplying X data points.
ExprEvaluator	getExpressionXEval()
ExprNode	getExpressionY() Returns the expression supplying Y data points.
ExprEvaluator	getExpressionYEval()
Object[]	getLastValuesEventNew()
BaseStatisticsBean	getStatisticsBean()
ViewFactory	getViewFactory()
Iterator<EventBean>	iterator() Allows iteration through all elements in this event collection.
protected abstract EventBean	populateMap(BaseStatisticsBean baseStatisticsBean, EventAdapterService eventAdapterService, EventType eventType, StatViewAdditionalProps additionalProps, Object[] decoration) Populate bean.
void	setLastValuesEventNew(Object[] lastValuesEventNew)
void	update(EventBean[] newData, EventBean[] oldData) Notify that data has been added or removed from the Viewable parent.

Methods inherited from class com.espertech.esper.view.ViewSupport

addView, addView, dumpChildViews, dumpUpdateParams, dumpUpdateParams, findDescendent, findViewIndex, getParent, getViews, hasViews, removeAllViews, removeView, removeView, setParent, updateChildren, updateChildren

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.espertech.esper.view.View

getParent, setParent

Methods inherited from interface com.espertech.esper.view.Viewable

addView, getViews, hasViews, removeAllViews, removeView

Methods inherited from interface com.espertech.esper.view.EventCollection

getEventType

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

viewFactory

protected final ViewFactory viewFactory

statisticsBean

protected BaseStatisticsBean statisticsBean

This bean can be overridden by subclasses providing extra values such as correlation, regression.

agentInstanceContext

protected final AgentInstanceContext agentInstanceContext

Services required by implementing classes.

additionalProps

protected final StatViewAdditionalProps additionalProps

Additional properties.

eventType

protected final EventType eventType

Event type.

lastValuesEventNew

protected Object[] lastValuesEventNew

Constructor Detail

BaseBivariateStatisticsView

public BaseBivariateStatisticsView(ViewFactory viewFactory,
                                   AgentInstanceContext agentInstanceContext,
                                   ExprNode expressionX,
                                   ExprEvaluator expressionXEval,
                                   ExprNode expressionY,
                                   ExprEvaluator expressionYEval,
                                   EventType eventType,
                                   StatViewAdditionalProps additionalProps)

Constructor requires the name of the two fields to use in the parent view to compute the statistics.

Parameters:

expressionX - is the expression to get the X values from

expressionXEval - is the expression to get the X values from

expressionY - is the expression to get the Y values from

expressionYEval - is the expression to get the Y values from

agentInstanceContext - contains required view services

eventType - type of event

additionalProps - additional props

viewFactory - view factory

Method Detail

populateMap

protected abstract EventBean populateMap(BaseStatisticsBean baseStatisticsBean,
                                         EventAdapterService eventAdapterService,
                                         EventType eventType,
                                         StatViewAdditionalProps additionalProps,
                                         Object[] decoration)

Populate bean.

Parameters:

baseStatisticsBean - results

eventAdapterService - event adapters

eventType - type

additionalProps - additional props

decoration - decoration values

Returns:

bean

update

public void update(EventBean[] newData,
                   EventBean[] oldData)

Description copied from interface: View

Notify that data has been added or removed from the Viewable parent. The last object in the newData array of objects would be the newest object added to the parent view. The first object of the oldData array of objects would be the oldest object removed from the parent view.

If the call to update contains new (inserted) data, then the first argument will be a non-empty list and the second will be empty. Similarly, if the call is a notification of deleted data, then the first argument will be empty and the second will be non-empty. Either the newData or oldData will be non-null. This method won't be called with both arguments being null, but either one could be null. The same is true for zero-length arrays. Either newData or oldData will be non-empty. If both are non-empty, then the update is a modification notification.

When update() is called on a view by the parent object, the data in newData will be in the collection of the parent, and its data structures will be arranged to reflect that. The data in oldData will not be in the parent's data structures, and any access to the parent will indicate that that data is no longer there.

Specified by:

update in interface View

Parameters:

newData - is the new data that has been added to the parent view

oldData - is the old data that has been removed from the parent view

iterator

public final Iterator<EventBean> iterator()

Description copied from interface: EventCollection

Allows iteration through all elements in this event collection. The iterator will return the elements in the collection in their natural order, or, if there is no natural ordering, in some unpredictable order.

Specified by:

iterator in interface EventCollection

Specified by:

iterator in interface Iterable<EventBean>

Returns:

an iterator which will go through all current elements in the collection.

getExpressionX

public final ExprNode getExpressionX()

Returns the expression supplying X data points.

Returns:

X expression

getExpressionY

public final ExprNode getExpressionY()

Returns the expression supplying Y data points.

Returns:

Y expression

getStatisticsBean

public BaseStatisticsBean getStatisticsBean()

getLastValuesEventNew

public Object[] getLastValuesEventNew()

setLastValuesEventNew

public void setLastValuesEventNew(Object[] lastValuesEventNew)

getAdditionalProps

public StatViewAdditionalProps getAdditionalProps()

getViewFactory

public ViewFactory getViewFactory()

Specified by:

getViewFactory in interface GroupableView

getExpressionXEval

public ExprEvaluator getExpressionXEval()

getExpressionYEval

public ExprEvaluator getExpressionYEval()