net.esper.view.stat
Class CorrelationView

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

All Implemented Interfaces:

Iterable<EventBean>, CloneableView, EventCollection, View, Viewable

public final class CorrelationView
extends BaseBivariateStatisticsView
implements CloneableView

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(ViewServiceContext viewServiceContext, String xFieldName, String yFieldName)
Constructor.

Method Summary

View	cloneView(ViewServiceContext viewServiceContext)
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, iterator, setParent, update

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, wait, wait, wait

Constructor Detail

CorrelationView

public CorrelationView(ViewServiceContext viewServiceContext,
                       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

viewServiceContext - contains required view services

Method Detail

cloneView

public View cloneView(ViewServiceContext viewServiceContext)

Specified by:

cloneView in interface CloneableView

getEventType

public EventType getEventType()

Description copied from interface: EventCollection

Provides metadata information about the type of object the event collection contains.

Specified by:

getEventType in interface EventCollection

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