net.esper.view.stat
Class BaseBivariateStatisticsView

java.lang.Object
  extended by net.esper.view.ViewSupport
      extended by net.esper.view.stat.BaseBivariateStatisticsView
All Implemented Interfaces:
Iterable<EventBean>, ContextAwareView, EventCollection, View, Viewable
Direct Known Subclasses:
CorrelationView, RegressionLinestView

public abstract class BaseBivariateStatisticsView
extends ViewSupport
implements ContextAwareView

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  BaseStatisticsBean statisticsBean
          This bean can be overridden by subclasses providing extra values such as correlation, regression.
protected  ViewServiceContext viewServiceContext
          Services required by implementing classes.
 
Fields inherited from class net.esper.view.ViewSupport
parent
 
Constructor Summary
BaseBivariateStatisticsView()
          Default constructor - required by all views to adhere to the Java bean specification.
BaseBivariateStatisticsView(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 attachesTo(Viewable parentView)
          Return null if the view will accept being attached to a particular object.
 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.
 ViewServiceContext getViewServiceContext()
          Returns the context instances used by the view.
 Iterator<EventBean> iterator()
          Allows iteration through all elements in this event collection.
 void setFieldNameX(String fieldNameX)
          Sets the field name of the X data column.
 void setFieldNameY(String fieldNameY)
          Sets the field name of the Y data column.
 void setParent(Viewable parent)
          Called when the View is added to a Viewable object.
 void setViewServiceContext(ViewServiceContext viewServiceContext)
          Set the services context containing service handles.
 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, shallowCopyView, 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.


viewServiceContext

protected ViewServiceContext viewServiceContext
Services required by implementing classes.

Constructor Detail

BaseBivariateStatisticsView

public BaseBivariateStatisticsView()
Default constructor - required by all views to adhere to the Java bean specification.


BaseBivariateStatisticsView

public BaseBivariateStatisticsView(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
Method Detail

getViewServiceContext

public ViewServiceContext getViewServiceContext()
Description copied from interface: ContextAwareView
Returns the context instances used by the view.

Specified by:
getViewServiceContext in interface ContextAwareView
Returns:
context instance

setViewServiceContext

public void setViewServiceContext(ViewServiceContext viewServiceContext)
Description copied from interface: ContextAwareView
Set the services context containing service handles.

Specified by:
setViewServiceContext in interface ContextAwareView
Parameters:
viewServiceContext - with service handles

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

attachesTo

public final String attachesTo(Viewable parentView)
Description copied from interface: View
Return null if the view will accept being attached to a particular object.

Specified by:
attachesTo in interface View
Parameters:
parentView - is the potential parent for this view
Returns:
null if this view can successfully attach to the parent, an error message if it cannot.

update

public final 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 Iterable<EventBean>
Specified by:
iterator in interface EventCollection
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

setFieldNameX

public final void setFieldNameX(String fieldNameX)
Sets the field name of the X data column.

Parameters:
fieldNameX - is the field name from which to get X data values.

setFieldNameY

public final void setFieldNameY(String fieldNameY)
Sets the field name of the Y data column.

Parameters:
fieldNameY - is the field name from which to get Y data values.