com.espertech.esper.view.window
Class ExternallyTimedBatchView

java.lang.Object
  com.espertech.esper.view.ViewSupport
      com.espertech.esper.view.window.ExternallyTimedBatchView

All Implemented Interfaces:

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

public class ExternallyTimedBatchView
extends ViewSupport
implements DataWindowView, CloneableView

Batch window based on timestamp of arriving events.

Field Summary

protected AgentInstanceViewFactoryChainContext	agentInstanceViewFactoryContext
protected EventBean[]	lastBatch
protected java.lang.Long	referenceTimestamp
protected ViewUpdatedCollection	viewUpdatedCollection
protected java.util.Set<EventBean>	window

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

EMPTY_VIEW_ARRAY, parent

Constructor Summary

ExternallyTimedBatchView(ExternallyTimedBatchViewFactory factory, ExprNode timestampExpression, ExprEvaluator timestampExpressionEval, ExprTimePeriodEvalDeltaConst timeDeltaComputation, java.lang.Long optionalReferencePoint, ViewUpdatedCollection viewUpdatedCollection, AgentInstanceViewFactoryChainContext agentInstanceViewFactoryContext)
Constructor.

Method Summary

View	cloneView() Duplicates the view.
protected void	determineOldestTimestamp()
EventType	getEventType() Provides metadata information about the type of object the event collection contains.
ExprTimePeriodEvalDeltaConst	getTimeDeltaComputation()
ExprNode	getTimestampExpression() Returns the field name to get timestamp values from.
ViewFactory	getViewFactory()
protected void	handleInternalAddEvent(EventBean anNewData, boolean isNextBatch)
protected void	handleInternalPostBatch(java.util.Set<EventBean> window, EventBean[] batchNewData)
protected void	handleInternalRemovedEvent(EventBean anOldData)
boolean	isEmpty() Returns true to indicate the window is empty, or false if the view is 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

lastBatch

protected EventBean[] lastBatch

window

protected final java.util.Set<EventBean> window

referenceTimestamp

protected java.lang.Long referenceTimestamp

viewUpdatedCollection

protected ViewUpdatedCollection viewUpdatedCollection

agentInstanceViewFactoryContext

protected AgentInstanceViewFactoryChainContext agentInstanceViewFactoryContext

Constructor Detail

ExternallyTimedBatchView

public ExternallyTimedBatchView(ExternallyTimedBatchViewFactory factory,
                                ExprNode timestampExpression,
                                ExprEvaluator timestampExpressionEval,
                                ExprTimePeriodEvalDeltaConst timeDeltaComputation,
                                java.lang.Long optionalReferencePoint,
                                ViewUpdatedCollection viewUpdatedCollection,
                                AgentInstanceViewFactoryChainContext agentInstanceViewFactoryContext)

Constructor.

Parameters:

timestampExpression - is the field name containing a long timestamp value that should be in ascending order for the natural order of events and is intended to reflect System.currentTimeInMillis but does not necessarily have to. out of the window as oldData in the update method. The view compares each events timestamp against the newest event timestamp and those with a delta greater then secondsBeforeExpiry are pushed out of the window.

viewUpdatedCollection - is a collection that the view must update when receiving events

factory - for copying this view in a group-by

agentInstanceViewFactoryContext - context for expression evalauation

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

getTimestampExpression

public final ExprNode getTimestampExpression()

Returns the field name to get timestamp values from.

Returns:

field name for timestamp values

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

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

isEmpty

public boolean isEmpty()

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

Returns:

true if empty

getTimeDeltaComputation

public ExprTimePeriodEvalDeltaConst getTimeDeltaComputation()

visitView

public void visitView(ViewDataVisitor viewDataVisitor)

Specified by:

visitView in interface ViewDataVisitable

getViewFactory

public ViewFactory getViewFactory()

Specified by:

getViewFactory in interface GroupableView

determineOldestTimestamp

protected void determineOldestTimestamp()

handleInternalPostBatch

protected void handleInternalPostBatch(java.util.Set<EventBean> window,
                                       EventBean[] batchNewData)

handleInternalRemovedEvent

protected void handleInternalRemovedEvent(EventBean anOldData)

handleInternalAddEvent

protected void handleInternalAddEvent(EventBean anNewData,
                                      boolean isNextBatch)