|
||||||||||
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.ext.SortWindowView
public final class SortWindowView
Window sorting by values in the specified field extending a specified number of elements from the lowest value up or the highest value down. The view accepts 3 parameters. The first parameter is the field name to get the values to sort for, the second parameter defines whether to sort ascending or descending, the third parameter is the number of elements to keep in the sorted list. The type of the field to be sorted in the event must implement the Comparable interface. The natural order in which events arrived is used as the second sorting criteria. Thus should events arrive with equal sort values the oldest event leaves the sort window first. Old values removed from a prior view are removed from the sort view.
Field Summary |
---|
Fields inherited from class net.esper.view.ViewSupport |
---|
parent |
Constructor Summary | |
---|---|
SortWindowView()
Default constructor - required by all views to adhere to the Java bean specification. |
|
SortWindowView(java.lang.String sortFieldName,
boolean isDescending,
int size)
Constructor. |
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 |
getSortFieldName()
Returns the field name supplying the values to sort by. |
int |
getSortWindowSize()
Returns the number of elements kept by the sort window. |
boolean |
isDescending()
Returns an indication of sort order. |
java.util.Iterator<EventBean> |
iterator()
Allows iteration through all elements in this event collection. |
void |
setDescending(boolean descending)
Set the sort order for the sort window. |
void |
setParent(Viewable parent)
Called when the View is added to a Viewable object. |
void |
setSortFieldName(java.lang.String sortFieldName)
Sets the field name supplying the values to sort by. |
void |
setSortWindowSize(int sortWindowSize)
Sets the number of elements kept by the sort window. |
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 |
Methods inherited from interface net.esper.view.View |
---|
getParent |
Methods inherited from interface net.esper.view.Viewable |
---|
addView, getViews, hasViews, removeView |
Constructor Detail |
---|
public SortWindowView()
public SortWindowView(java.lang.String sortFieldName, boolean isDescending, int size)
sortFieldName
- is the name of the field in the event to get the values to sortisDescending
- true if the sort should be descending, false if ascendingsize
- is the specified number of elements to keep in the sortMethod Detail |
---|
public 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 getSortFieldName()
public final void setSortFieldName(java.lang.String sortFieldName)
sortFieldName
- field name to sort bypublic final boolean isDescending()
public final void setDescending(boolean descending)
descending
- is true to set the descending and false for ascending sorting.public final int getSortWindowSize()
public final void setSortWindowSize(int sortWindowSize)
sortWindowSize
- size of windowpublic final java.lang.String attachesTo(Viewable parentView)
View
attachesTo
in interface View
parentView
- is the potential parent for this view
public final EventType getEventType()
EventCollection
getEventType
in interface EventCollection
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 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 |