com.scaleoutsoftware.streaming.timewindowing

Class SessionWindowCollection<T>

java.lang.Object

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

All Implemented Interfaces:

java.lang.Iterable<TimeWindow<T>>

public class SessionWindowCollection<T>
extends java.lang.Object
implements java.lang.Iterable<TimeWindow<T>>

The SessionWindowCollection transforms a List into an iterable collection of session windows. This wrapper class can be used to manage the retention policy of the source collection as well as to insert new objects in chronological order.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(T item) Adds an item to the source collection in time ordered fashion.
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

SessionWindowCollection

public SessionWindowCollection(java.util.List<T> source,
                               TimestampSelector<T> selector,
                               long startTime,
                               long timeout)

Instantiates a new SessionWindowCollection

Parameters:

source - the underlying source.

selector - the selector used to pull a timestamp from an item in the source collection and subsequent insertions

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

timeout - the minimum amount of time between session window ranges

Method Detail

add

public void add(T item)

Adds an item to the source collection in time ordered fashion.

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>>