com.scaleoutsoftware.streaming.timewindowing

Class SlidingWindowCollection<T>

java.lang.Object

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

All Implemented Interfaces:

java.lang.Iterable<TimeWindow<T>>

public class SlidingWindowCollection<T>
extends java.lang.Object
implements java.lang.Iterable<TimeWindow<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.

Constructor Summary

Constructors

Constructor and Description
SlidingWindowCollection(java.util.List<T> source, TimestampSelector<T> selector, long windowDuration, long every, long startTime) Instantiates a new SlidingWindowCollection

Method Summary

Modifier and Type	Method and Description
void	add(T item) Adds an item to the underlying source collection in chronological order.
void	forEach(java.util.function.Consumer<? super TimeWindow<T>> action)
java.util.Iterator<TimeWindow<T>>	iterator()
java.util.Spliterator<TimeWindow<T>>	spliterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

SlidingWindowCollection

public SlidingWindowCollection(java.util.List<T> source,
                               TimestampSelector<T> selector,
                               long windowDuration,
                               long every,
                               long startTime)

Instantiates a new SlidingWindowCollection

Parameters:

source - the underlying source collection

selector - the interface used to select a timestamp from an item

windowDuration - the duration of a time window

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

startTime - the first time an object can be in a time window -- items before the start time will be evicted from the source collection.

Method Detail

add

public void add(T item)

Adds an item to the underlying source collection in chronological order.

Parameters:

item - the item to add

iterator

public java.util.Iterator<TimeWindow<T>> iterator()

Specified by:

iterator in interface java.lang.Iterable<TimeWindow<T>>

forEach

public void forEach(java.util.function.Consumer<? super TimeWindow<T>> action)

Specified by:

forEach in interface java.lang.Iterable<TimeWindow<T>>

spliterator

public java.util.Spliterator<TimeWindow<T>> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<TimeWindow<T>>