|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.esper.view.ViewSupport
net.esper.view.stat.WeightedAverageView
public final class WeightedAverageView
View for computing a weighted average. The view uses 2 fields within the parent view to compute the weighted average. The X field and weight field. In a price-volume example it calculates the volume-weighted average price as (sum(price * volume) / sum(volume)). Example: weighted_avg("price", "volume")
Field Summary |
---|
Fields inherited from class net.esper.view.ViewSupport |
---|
parent |
Constructor Summary | |
---|---|
WeightedAverageView()
Default constructor - required by all views to adhere to the Java bean specification. |
|
WeightedAverageView(java.lang.String fieldNameX,
java.lang.String fieldNameWeight)
Constructor requires the name of the field to use in the parent view to compute the weighted average on, as well as the name of the field in the parent view to get the weight from. |
Method Summary | |
---|---|
java.lang.String |
attachesTo(Viewable parentView)
Return null if the view will accept being attached to a particular object. |
EventType |
getEventType()
Provides metadata information about the type of object the event collection contains. |
java.lang.String |
getFieldNameWeight()
Returns the name of the field supplying the weight values. |
java.lang.String |
getFieldNameX()
Returns the name of the field supplying the X values. |
ViewServiceContext |
getViewServiceContext()
Returns the context instances used by the view. |
java.util.Iterator<EventBean> |
iterator()
Allows iteration through all elements in this event collection. |
void |
setFieldNameWeight(java.lang.String fieldNameWeight)
Sets the name of the field supplying the weight values. |
void |
setFieldNameX(java.lang.String fieldNameX)
Sets the name of the field supplying the X values. |
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. |
java.lang.String |
toString()
|
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, wait, wait, wait |
Constructor Detail |
---|
public WeightedAverageView()
public WeightedAverageView(java.lang.String fieldNameX, java.lang.String fieldNameWeight)
fieldNameX
- is the name of the field within the parent view to use to get numeric data points for this view to
compute the average for.fieldNameWeight
- is the field name for the weight to apply to each data pointMethod Detail |
---|
public ViewServiceContext getViewServiceContext()
ContextAwareView
getViewServiceContext
in interface ContextAwareView
public void setViewServiceContext(ViewServiceContext viewServiceContext)
ContextAwareView
setViewServiceContext
in interface ContextAwareView
viewServiceContext
- with service handlespublic void setParent(Viewable parent)
View
setParent
in interface View
setParent
in class ViewSupport
parent
- is the parent that this view is a child ofpublic final java.lang.String getFieldNameX()
public final void setFieldNameX(java.lang.String fieldNameX)
fieldNameX
- field name supplying X data pointspublic final java.lang.String getFieldNameWeight()
public final void setFieldNameWeight(java.lang.String fieldNameWeight)
fieldNameWeight
- field name supplying weightpublic final java.lang.String attachesTo(Viewable parentView)
View
attachesTo
in interface View
parentView
- is the potential parent for this view
public final void update(EventBean[] newData, EventBean[] oldData)
View
update
in interface View
newData
- is the new data that has been added to the parent viewoldData
- is the old data that has been removed from the parent viewpublic final EventType getEventType()
EventCollection
getEventType
in interface EventCollection
public final java.util.Iterator<EventBean> iterator()
EventCollection
iterator
in interface java.lang.Iterable<EventBean>
iterator
in interface EventCollection
public final java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |