[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

A data view that aggregates events in a stream and releases them in one batch at every specified time interval. The view works similar to a time_window but in not continuous. The view releases the batched events after the interval as new data to child views. The prior batch if not empty is released as old data to child view. The view doesn't release intervals with no old or new data. It also does not GetSelectListEvents old data published by a parent view.

For example, we want to calculate the average of IBM stock every hour, for the last hour. The view accepts 2 parameter combinations. (1) A time interval is supplied with a reference point - based on this point the intervals are set. (1) A time interval is supplied but no reference point - the reference point is set when the first event arrives.

If there are no events in the current and prior batch, the view will not invoke the update method of child views. In that case also, no next callback is scheduled with the scheduling service until the next event arrives.

The following tables list the members exposed by the TimeBatchView type.

Public Methods

  NameDescription
AddView
Add a view to the viewable object.
(Inherited from ViewSupport.)
AttachesTo
Return null if the view will accept being attached to a particular object.
(Overrides .AttachesTo(Viewable).)
static memberComputeWaitMSec
Given a current time and a reference time and an interval size, compute the amount of milliseconds till the next interval.

Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetEnumerator
Returns an enumerator that iterates through the collection.
(Overrides .GetEnumerator().)
GetHashCode
Serves as a hash function for a particular type. GetHashCode() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
GetViews
Returns all added views.
(Inherited from ViewSupport.)
RemoveView
Remove a view.
(Inherited from ViewSupport.)
SendBatch
This method updates child views and clears the batch of events. We schedule a new callback at this time if there were events in the batch.

ToString
Returns a String that represents the current Object.
(Overrides .ToString().)
Update
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.

(Overrides .Update(EventBean[](), EventBean[]()).)

Protected Methods

  NameDescription
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)

Explicit Interface Implementations

  NameDescription
Explicit interface implemetationIEnumerable.System.Collections.IEnumerable.GetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from ViewSupport.)