net.esper.view.stat
Class CorrelationView

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

public final class CorrelationView
extends BaseBivariateStatisticsView

A view that calculates correlation on two fields. The view uses internally a CorrelationBean instance for the calculations, it also returns this bean as the result. This class accepts most of its behaviour from its parent, BaseBivariateStatisticsView. It adds the usage of the correlation bean and the appropriate schema.


Field Summary
 
Fields inherited from class net.esper.view.stat.BaseBivariateStatisticsView
statisticsBean, viewServiceContext
 
Fields inherited from class net.esper.view.ViewSupport
parent
 
Constructor Summary
CorrelationView()
          Default constructor - required by all views to adhere to the Java bean specification.
CorrelationView(String xFieldName, String yFieldName)
          Constructor.
 
Method Summary
protected static EventType createEventType(ViewServiceContext viewServiceContext)
          Creates the event type for this view.
 EventType getEventType()
          Provides metadata information about the type of object the event collection contains.
 String toString()
           
 
Methods inherited from class net.esper.view.stat.BaseBivariateStatisticsView
getFieldNameX, getFieldNameY, getViewServiceContext, iterator, setFieldNameX, setFieldNameY, setParent, setViewServiceContext, update
 
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, wait, wait, wait
 

Constructor Detail

CorrelationView

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


CorrelationView

public CorrelationView(String xFieldName,
                       String yFieldName)
Constructor.

Parameters:
xFieldName - is the field name of the field providing X data points
yFieldName - is the field name of the field providing X data points
Method Detail

getEventType

public EventType getEventType()
Description copied from interface: EventCollection
Provides metadata information about the type of object the event collection contains.

Returns:
metadata for the objects in the collection

toString

public String toString()
Overrides:
toString in class Object

createEventType

protected static EventType createEventType(ViewServiceContext viewServiceContext)
Creates the event type for this view.

Parameters:
viewServiceContext - is the event adapter service
Returns:
event type of view