Package com.espertech.esper.common.internal.view.timetolive

Class TimeOrderView

java.lang.Object
com.espertech.esper.common.internal.view.core.ViewSupport
com.espertech.esper.common.internal.view.timetolive.TimeOrderView
All Implemented Interfaces:
AgentInstanceMgmtCallback, DataWindowView, View, Viewable, ViewDataVisitable, Iterable<EventBean>
public class TimeOrderView extends ViewSupport implements DataWindowView, AgentInstanceMgmtCallback
Window retaining timestamped events up to a given number of seconds such that older events that arrive later are sorted into the window and released in timestamp order.

The insert stream consists of all arriving events. The remove stream consists of events in order of timestamp value as supplied by each event.

Timestamp values on events should match runtime time. The window compares runtime time to timestamp value and releases events when the event's timestamp is less then runtime time minus interval size (the event is older then the window tail).

The view accepts 2 parameters. The first parameter is the field name to get the event timestamp value from, the second parameter defines the interval size.

  • Constructor Details

  • Method Details

    • getEventType

      public final EventType getEventType()
      Description copied from interface: Viewable
      Provides metadata information about the type of object the event collection contains.
      Specified by:
      getEventType in interface Viewable
      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

    • getTimestamp

      protected Long getTimestamp(EventBean newEvent)

    • isEmpty

      public boolean isEmpty()
      True to indicate the sort window is empty, or false if not empty.
      Returns:
      true if empty sort window

    • iterator

      public final Iterator<EventBean> iterator()
      Description copied from interface: Viewable
      Allows iteration through all elements in this viewable. 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 Iterable<EventBean>
      Specified by:
      iterator in interface Viewable
      Returns:
      an iterator which will go through all current elements in the collection.

    • toString

      public final String toString()
      Overrides:
      toString in class Object

    • visitView

      public void visitView(ViewDataVisitor viewDataVisitor)
      Specified by:
      visitView in interface ViewDataVisitable

    • expire

      protected final void expire()
      This method removes (expires) objects from the window and schedules a new callback for the time when the next oldest message would expire from the window.

    • stop

      public void stop(AgentInstanceStopServices services)
      Specified by:
      stop in interface AgentInstanceMgmtCallback

    • getFactory

      public ViewFactory getFactory()