com.espertech.esper.common.internal.view.timewin

Class TimeWindowView

java.lang.Object

com.espertech.esper.common.internal.view.core.ViewSupport

com.espertech.esper.common.internal.view.timewin.TimeWindowView

All Implemented Interfaces:

AgentInstanceStopCallback, DataWindowView, View, Viewable, ViewDataVisitable, Iterable<EventBean>

public class TimeWindowView
extends ViewSupport
implements DataWindowView, AgentInstanceStopCallback

This view is a moving timeWindow extending the specified amount of milliseconds into the past. The view bases the timeWindow on the time obtained from the scheduling service. All incoming events receive a timestamp and are placed in a sorted map by timestamp. The view does not care about old data published by the parent view to this view.

Events leave or expire from the time timeWindow by means of a scheduled callback registered with the scheduling service. Thus child views receive updates containing old data only asynchronously as the system-time-based timeWindow moves on. However child views receive updates containing new data as soon as the new data arrives.

Field Summary

Fields inherited from class com.espertech.esper.common.internal.view.core.ViewSupport

child, parent

Fields inherited from interface com.espertech.esper.common.internal.context.util.AgentInstanceStopCallback

INSTANCE_NO_ACTION

Constructor Summary

Constructors

Constructor and Description
TimeWindowView(AgentInstanceViewFactoryChainContext agentInstanceContext, TimeWindowViewFactory timeWindowViewFactory, ViewUpdatedCollection viewUpdatedCollection, TimePeriodProvide timePeriodProvide)

Method Summary

Modifier and Type	Method and Description
EventType	getEventType() Provides metadata information about the type of object the event collection contains.
ViewFactory	getViewFactory()
ViewUpdatedCollection	getViewUpdatedCollection() Returns the (optional) collection handling random access to window contents for prior or previous events.
boolean	isEmpty() Returns true if the window is empty, or false if not empty.
Iterator<EventBean>	iterator() Allows iteration through all elements in this viewable.
void	stop(AgentInstanceStopServices services)
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.common.internal.view.core.ViewSupport

getChild, getParent, setChild, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.espertech.esper.common.internal.view.core.View

getParent, setParent

Methods inherited from interface com.espertech.esper.common.internal.view.core.Viewable

getChild, setChild

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TimeWindowView

public TimeWindowView(AgentInstanceViewFactoryChainContext agentInstanceContext,
                      TimeWindowViewFactory timeWindowViewFactory,
                      ViewUpdatedCollection viewUpdatedCollection,
                      TimePeriodProvide timePeriodProvide)

Method Detail

getViewUpdatedCollection

public ViewUpdatedCollection getViewUpdatedCollection()

Returns the (optional) collection handling random access to window contents for prior or previous events.

Returns:

buffer for events

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

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 Viewable

Specified by:

iterator in interface Iterable<EventBean>

Returns:

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

toString

public final String toString()

Overrides:

toString in class Object

isEmpty

public boolean isEmpty()

Returns true if the window is empty, or false if not empty.

Returns:

true if empty

stop

public void stop(AgentInstanceStopServices services)

Specified by:

stop in interface AgentInstanceStopCallback

visitView

public void visitView(ViewDataVisitor viewDataVisitor)

Specified by:

visitView in interface ViewDataVisitable

getViewFactory

public ViewFactory getViewFactory()