com.yahoo.bard.webservice.util

Class SimplifiedIntervalList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<org.joda.time.Interval>

com.yahoo.bard.webservice.util.SimplifiedIntervalList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<org.joda.time.Interval>, Collection<org.joda.time.Interval>, Deque<org.joda.time.Interval>, List<org.joda.time.Interval>, Queue<org.joda.time.Interval>

public class SimplifiedIntervalList
extends LinkedList<org.joda.time.Interval>

A simplified interval list is a list of intervals, ordered by time, expressed in as few intervals as possible (i.e. adjacent and overlapping intervals are combined into a single interval).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimplifiedIntervalList.IsSubinterval A predicate for testing whether the test interval is a complete subinterval of part of the supply of intervals.
static class	SimplifiedIntervalList.SkippingIntervalPredicate A predicate to scan a Simplified Interval List using an iterator and a test predicate.

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<Iterator<org.joda.time.Interval>,org.joda.time.Interval>	getNextIfAvailable Function to iterate an iterator if it has a next element, otherwise return null.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SimplifiedIntervalList() Constructor.
SimplifiedIntervalList(Collection<org.joda.time.Interval> intervals) Simplify then build a list.
SimplifiedIntervalList(SimplifiedIntervalList intervals) If the intervals are already simplified, simply copy the list.

Method Summary

Modifier and Type	Method and Description
boolean	add(org.joda.time.Interval e) Only internal calls to linked list mutators should be used to change the list.
List<org.joda.time.Interval>	asList() Method to convert SimplifiedIntervalList as regular list to address the deserialization issues.
static Collector<org.joda.time.Interval,SimplifiedIntervalList,SimplifiedIntervalList>	getCollector() Build a collector which appends overlapping intervals, merging and simplifying as it goes.
SimplifiedIntervalList	intersect(SimplifiedIntervalList that) Return the intersection of all subintervals in two interval lists.
Iterator<org.joda.time.Interval>	periodIterator(org.joda.time.ReadablePeriod readablePeriod) Create an Iterator using IntervalPeriodInterators to all intervals of this list broken up into pieces of size period.
static SimplifiedIntervalList	simplifyIntervals(Collection<org.joda.time.Interval>... intervals) Takes one or more lists of intervals, and combines them into a single, sorted list with the minimum number of intervals needed to capture exactly the same instants as the original intervals.
SimplifiedIntervalList	subtract(SimplifiedIntervalList that) Return the subtracted list of all intervals in this that are not in that.
SimplifiedIntervalList	union(SimplifiedIntervalList that) Return the union of this simplified interval list and the intervals of another.

Methods inherited from class java.util.LinkedList

add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque

iterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

getNextIfAvailable

protected Function<Iterator<org.joda.time.Interval>,org.joda.time.Interval> getNextIfAvailable

Function to iterate an iterator if it has a next element, otherwise return null.

Constructor Detail

SimplifiedIntervalList

public SimplifiedIntervalList()

Constructor.

SimplifiedIntervalList

public SimplifiedIntervalList(Collection<org.joda.time.Interval> intervals)

Simplify then build a list.

Parameters:

intervals - A collection of intervals

SimplifiedIntervalList

public SimplifiedIntervalList(SimplifiedIntervalList intervals)

If the intervals are already simplified, simply copy the list.

Parameters:

intervals - A simplified list of intervals

Method Detail

asList

public List<org.joda.time.Interval> asList()

Method to convert SimplifiedIntervalList as regular list to address the deserialization issues.

Returns:

List of simplified intervals

simplifyIntervals

@SafeVarargs
public static SimplifiedIntervalList simplifyIntervals(Collection<org.joda.time.Interval>... intervals)

Takes one or more lists of intervals, and combines them into a single, sorted list with the minimum number of intervals needed to capture exactly the same instants as the original intervals.

If any subintervals of the input collection abut or overlap they will be replaced with a single, combined interval.

Examples:

• ['2014/2017', '2015/2020'] will combine into ['2014/2020']
• ['2015/2016', '2016/2017'] will combine into ['2015/2017]
• ['2015/2016', '2013/2014'] will sort into ['2013/2014', '2015/2016']
• ['2015/2015', '2015/2016', '2012/2013'] will sort and combine to ['2012/2013', '2015/2016']

Parameters:

intervals - The collection(s) of intervals being collated

Returns:

A single list of sorted intervals simplified to the smallest number of intervals able to describe the duration

add

public boolean add(org.joda.time.Interval e)

Only internal calls to linked list mutators should be used to change the list.

Specified by:

add in interface Collection<org.joda.time.Interval>

Specified by:

add in interface Deque<org.joda.time.Interval>

Specified by:

add in interface List<org.joda.time.Interval>

Specified by:

add in interface Queue<org.joda.time.Interval>

Overrides:

add in class LinkedList<org.joda.time.Interval>

Parameters:

e - Any element to be added

Returns:

nothing, a runtime exception is always thrown

getCollector

public static Collector<org.joda.time.Interval,SimplifiedIntervalList,SimplifiedIntervalList> getCollector()

Build a collector which appends overlapping intervals, merging and simplifying as it goes.

Returns:

A collector for merging simplified intervals

union

public SimplifiedIntervalList union(SimplifiedIntervalList that)

Return the union of this simplified interval list and the intervals of another.

Parameters:

that - A simplified list of intervals

Returns:

A new simplified list containing all subintervals of both this and that.

intersect

public SimplifiedIntervalList intersect(SimplifiedIntervalList that)

Return the intersection of all subintervals in two interval lists.

Parameters:

that - A simplified list of intervals

Returns:

A new simplified interval list whose intervals are all subintervals of this and that.

subtract

public SimplifiedIntervalList subtract(SimplifiedIntervalList that)

Return the subtracted list of all intervals in this that are not in that.

Parameters:

that - A simplified list of intervals

Returns:

A new simplified interval list whose intervals are all subintervals of this and not that

periodIterator

public Iterator<org.joda.time.Interval> periodIterator(org.joda.time.ReadablePeriod readablePeriod)

Create an Iterator using IntervalPeriodInterators to all intervals of this list broken up into pieces of size period.

Parameters:

readablePeriod - The period to chunk subintervals into.

Returns:

An iterator which returns period sized subintervals of this interval list.