com.espertech.esper.view.ext
Class RankWindowView

java.lang.Object
  com.espertech.esper.view.ViewSupport
      com.espertech.esper.view.ext.RankWindowView

All Implemented Interfaces:

CloneableView, DataWindowView, EventCollection, GroupableView, View, Viewable, ViewDataVisitable, java.lang.Iterable<EventBean>

public class RankWindowView
extends ViewSupport
implements DataWindowView, CloneableView

Window sorting by values in the specified field extending a specified number of elements from the lowest value up or the highest value down and retaining only the last unique value per key. 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 another view are removed from the sort view.

Field Summary

protected AgentInstanceViewFactoryChainContext	agentInstanceViewFactoryContext
protected int	numberOfEvents
protected ExprEvaluator[]	sortCriteriaEvaluators
protected java.util.TreeMap<java.lang.Object,java.lang.Object>	sortedEvents
protected ExprEvaluator[]	uniqueCriteriaEvaluators
protected java.util.Map<java.lang.Object,java.lang.Object>	uniqueKeySortKeys

Fields inherited from class com.espertech.esper.view.ViewSupport

EMPTY_VIEW_ARRAY, parent

Constructor Summary

RankWindowView(RankWindowViewFactory rankWindowViewFactory, ExprNode[] uniqueCriteriaExpressions, ExprEvaluator[] uniqueCriteriaEvaluators, ExprNode[] sortCriteriaExpressions, ExprEvaluator[] sortCriteriaEvaluators, boolean[] descendingValues, int sortWindowSize, IStreamSortRankRandomAccess optionalRankedRandomAccess, boolean isSortUsingCollator, AgentInstanceViewFactoryChainContext agentInstanceViewFactoryContext)
Ctor.

Method Summary

View	cloneView() Duplicates the view.
static java.lang.Object	getCriteriaKey(EventBean[] eventsPerStream, ExprEvaluator[] evaluators, EventBean theEvent, ExprEvaluatorContext evalContext)
static MultiKeyUntyped	getCriteriaMultiKey(EventBean[] eventsPerStream, ExprEvaluator[] evaluators, ExprEvaluatorContext evalContext)
EventType	getEventType() Provides metadata information about the type of object the event collection contains.
java.lang.Object	getSortValues(EventBean theEvent)
java.lang.Object	getUniqueValues(EventBean theEvent)
ViewFactory	getViewFactory()
void	internalHandleAddedKey(java.lang.Object sortKey, EventBean eventBean)
void	internalHandleRemovedKey(java.lang.Object sortKey, EventBean eventBean)
void	internalHandleReplacedKey(java.lang.Object newSortKey, EventBean newEvent, EventBean oldEvent)
boolean	isEmpty() True to indicate the sort window is empty, or false if not empty.
java.util.Iterator<EventBean>	iterator() Allows iteration through all elements in this event collection.
java.lang.String	toString()
void	update(EventBean[] newData, EventBean[] oldData) Notify that data has been added or removed from the Viewable parent.
void	visitView(ViewDataVisitor viewDataVisitor)

Methods inherited from class com.espertech.esper.view.ViewSupport

addView, addView, dumpChildViews, dumpUpdateParams, dumpUpdateParams, findDescendent, findViewIndex, getParent, getViews, hasViews, removeAllViews, removeView, removeView, setParent, updateChildren, updateChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.espertech.esper.view.View

getParent, setParent

Methods inherited from interface com.espertech.esper.view.Viewable

addView, getViews, hasViews, removeAllViews, removeView

Field Detail

sortCriteriaEvaluators

protected final ExprEvaluator[] sortCriteriaEvaluators

uniqueCriteriaEvaluators

protected final ExprEvaluator[] uniqueCriteriaEvaluators

agentInstanceViewFactoryContext

protected final AgentInstanceViewFactoryChainContext agentInstanceViewFactoryContext

sortedEvents

protected java.util.TreeMap<java.lang.Object,java.lang.Object> sortedEvents

uniqueKeySortKeys

protected java.util.Map<java.lang.Object,java.lang.Object> uniqueKeySortKeys

numberOfEvents

protected int numberOfEvents

Constructor Detail

RankWindowView

public RankWindowView(RankWindowViewFactory rankWindowViewFactory,
                      ExprNode[] uniqueCriteriaExpressions,
                      ExprEvaluator[] uniqueCriteriaEvaluators,
                      ExprNode[] sortCriteriaExpressions,
                      ExprEvaluator[] sortCriteriaEvaluators,
                      boolean[] descendingValues,
                      int sortWindowSize,
                      IStreamSortRankRandomAccess optionalRankedRandomAccess,
                      boolean isSortUsingCollator,
                      AgentInstanceViewFactoryChainContext agentInstanceViewFactoryContext)

Ctor.

Parameters:

sortCriteriaExpressions - is the event property names to sort

descendingValues - indicates whether to sort ascending or descending for each field

sortWindowSize - is the window size

optionalRankedRandomAccess - is the friend class handling the random access, if required by expressions

rankWindowViewFactory - for copying this view in a group-by

isSortUsingCollator - for string value sorting using compare or Collator

Method Detail

cloneView

public View cloneView()

Description copied from interface: CloneableView

Duplicates the view.

Expected to return a same view in initialized state for grouping.

Specified by:

cloneView in interface CloneableView

getEventType

public final 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

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

internalHandleReplacedKey

public void internalHandleReplacedKey(java.lang.Object newSortKey,
                                      EventBean newEvent,
                                      EventBean oldEvent)

internalHandleRemovedKey

public void internalHandleRemovedKey(java.lang.Object sortKey,
                                     EventBean eventBean)

internalHandleAddedKey

public void internalHandleAddedKey(java.lang.Object sortKey,
                                   EventBean eventBean)

iterator

public final java.util.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 EventCollection

Specified by:

iterator in interface java.lang.Iterable<EventBean>

Returns:

an iterator which will go through all current elements in the collection.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getUniqueValues

public java.lang.Object getUniqueValues(EventBean theEvent)

getSortValues

public java.lang.Object getSortValues(EventBean theEvent)

getCriteriaKey

public static java.lang.Object getCriteriaKey(EventBean[] eventsPerStream,
                                              ExprEvaluator[] evaluators,
                                              EventBean theEvent,
                                              ExprEvaluatorContext evalContext)

getCriteriaMultiKey

public static MultiKeyUntyped getCriteriaMultiKey(EventBean[] eventsPerStream,
                                                  ExprEvaluator[] evaluators,
                                                  ExprEvaluatorContext evalContext)

isEmpty

public boolean isEmpty()

True to indicate the sort window is empty, or false if not empty.

Returns:

true if empty sort window

visitView

public void visitView(ViewDataVisitor viewDataVisitor)

Specified by:

visitView in interface ViewDataVisitable

getViewFactory

public ViewFactory getViewFactory()

Specified by:

getViewFactory in interface GroupableView