net.esper.view.stat
Class BaseBivariateStatisticsView

java.lang.Object
  net.esper.view.ViewSupport
      net.esper.view.stat.BaseBivariateStatisticsView

All Implemented Interfaces:

Iterable<EventBean>, EventCollection, View, Viewable

Direct Known Subclasses:

CorrelationView, RegressionLinestView

public abstract class BaseBivariateStatisticsView
extends ViewSupport

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

protected StatementContext	statementContext Services required by implementing classes.
protected BaseStatisticsBean	statisticsBean This bean can be overridden by subclasses providing extra values such as correlation, regression.

Fields inherited from class net.esper.view.ViewSupport

parent

Constructor Summary

BaseBivariateStatisticsView(StatementContext statementContext, BaseStatisticsBean statisticsBean, String fieldNameX, String fieldNameY)
Constructor requires the name of the two fields to use in the parent view to compute the statistics.

Method Summary

String	getFieldNameX() Returns the field name of the field supplying X data points.
String	getFieldNameY() Returns the field name of the field supplying Y data points.
Iterator<EventBean>	iterator() Allows iteration through all elements in this event collection.
void	setParent(Viewable parent) Called when the View is added to a Viewable object.
void	update(EventBean[] newData, EventBean[] oldData) Notify that data has been added or removed from the Viewable parent.

Methods inherited from class net.esper.view.ViewSupport

addView, dumpChildViews, dumpUpdateParams, findDescendent, getParent, getViews, hasViews, removeView, updateChildren, updateChildren

Methods inherited from class java.lang.Object

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

Field Detail

statisticsBean

protected BaseStatisticsBean statisticsBean

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

statementContext

protected StatementContext statementContext

Services required by implementing classes.

Constructor Detail

BaseBivariateStatisticsView

public BaseBivariateStatisticsView(StatementContext statementContext,
                                   BaseStatisticsBean statisticsBean,
                                   String fieldNameX,
                                   String fieldNameY)

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

Parameters:

statisticsBean - is the base class prodiving sum of X and Y and squares for use by subclasses

fieldNameX - is the name of the field within the parent view to get the X values from

fieldNameY - is the name of the field within the parent view to get the Y values from

statementContext - contains required view services

Method Detail

setParent

public final void setParent(Viewable parent)

Description copied from interface: View

Called when the View is added to a Viewable object.

Specified by:

setParent in interface View

Overrides:

setParent in class ViewSupport

Parameters:

parent - is the parent that this view is a child of

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.

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.

Returns:

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

getFieldNameX

public final String getFieldNameX()

Returns the field name of the field supplying X data points.

Returns:

X field name

getFieldNameY

public final String getFieldNameY()

Returns the field name of the field supplying Y data points.

Returns:

Y field name