Package com.scaleoutsoftware.collections.timewindowing

Class SlidingWindowCollection<T>

java.lang.Object

com.scaleoutsoftware.collections.timewindowing.WindowingCollection<T>

com.scaleoutsoftware.collections.timewindowing.SlidingWindowCollection<T>

Type Parameters:

T - the object type of the source collection.

All Implemented Interfaces:

Iterable<TimeWindow<T>>

public class SlidingWindowCollection<T>
extends WindowingCollection<T>

The SlidingWindowCollection transforms a collection into an iterable collection of overlapping time windows. This wrapper class can be used to manage the retention policy and add objects in chronological order to the underlying source collection. The difference between SlidingWindowCollection and WatermarkedSlidingWindowCollection is that windows in the WatermarkedSlidingWindowCollection can be closed if the watermark passes the inclusive end of a window.

Field Summary

Fields inherited from class com.scaleoutsoftware.collections.timewindowing.WindowingCollection

_sourceCollection, _startTimeMs, _timestampSelector

Constructor Summary

Constructors

Constructor	Description
SlidingWindowCollection(List<T> sourceCollection, TimestampSelector<T> timestampSelector, long startTimeMs, long windowDurationMs, long everyMs)	Instantiates a new SlidingWindowCollection

Method Summary

Modifier and Type	Method	Description
void	forEach(Consumer<? super TimeWindow<T>> action)
Iterator<TimeWindow<T>>	iterator()
Spliterator<TimeWindow<T>>	spliterator()

Methods inherited from class com.scaleoutsoftware.collections.timewindowing.WindowingCollection

add

Methods inherited from class java.lang.Object

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

Constructor Details

SlidingWindowCollection

public SlidingWindowCollection(List<T> sourceCollection,
 TimestampSelector<T> timestampSelector,
 long startTimeMs,
 long windowDurationMs,
 long everyMs)

Instantiates a new SlidingWindowCollection

Parameters:

sourceCollection - the underlying source collection

timestampSelector - the TimestampSelector is used to pull a timestamp from an item in the source collection and subsequent insertions.

startTimeMs - the first time an object can be in a time window -- items before the start time will be evicted. The start time is also the start time of the first time window.

windowDurationMs - the duration of a time window

everyMs - the time between the starting point of each time window

Method Details

iterator

public Iterator<TimeWindow<T>> iterator()

forEach

public void forEach(Consumer<? super TimeWindow<T>> action)

spliterator

public Spliterator<TimeWindow<T>> spliterator()