com.yahoo.bard.webservice.util

Class IntervalUtils

java.lang.Object

com.yahoo.bard.webservice.util.IntervalUtils

public class IntervalUtils
extends Object

Methods and Iterators which support interval slicing alignment and set operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIGNMENT_EPOCH_STRING
static org.joda.time.DateTime	SYSTEM_ALIGNMENT_EPOCH
static SystemConfig	SYSTEM_CONFIG

Constructor Summary

Constructors

Constructor and Description
IntervalUtils()

Method Summary

Modifier and Type	Method and Description
static SimplifiedIntervalList	collectBucketedIntervalsIntersectingIntervalList(SimplifiedIntervalList supplyIntervals, SimplifiedIntervalList bucketedIntervals, Granularity granularity) Collect all subintervals of an interval list of a grain bucketed size which are subintervals of another supply list of intervals.
static long	countSlicedIntervals(Collection<org.joda.time.Interval> rawIntervals, Granularity grain) Count the intervals after simplifying raw intervals and splitting by grain.
static Optional<org.joda.time.DateTime>	firstMoment(Collection<? extends Collection<org.joda.time.Interval>> intervalSets) Return the first date time instant in this set of intervals if available.
static Stream<org.joda.time.Interval>	getIntervalOverlaps(org.joda.time.Interval interval, Collection<org.joda.time.Interval> compareIntervals) For a given interval, return a stream of the subintervals of it that are shared with at least one interval in the collection of compare intervals.
static Set<org.joda.time.Interval>	getOverlappingSubintervals(Collection<org.joda.time.Interval> left, Collection<org.joda.time.Interval> right) Find all the interval overlaps between two collections of intervals.
static Set<org.joda.time.Interval>	getOverlappingSubintervals(Set<org.joda.time.Interval> left, Set<org.joda.time.Interval> right) Find all the interval overlaps between two collections of intervals.
static Map<org.joda.time.Interval,AtomicInteger>	getSlicedIntervals(Collection<org.joda.time.Interval> rawIntervals, Granularity grain) Simplify raw intervals and return a map of intervals (dividing them by the grain) to the ordinal of the interval.
static Optional<TimeGrain>	getTimeGrain(org.joda.time.Interval interval) Find a valid timegrain for the interval based on the start and end date of the interval.
static long	getTotalDuration(Collection<org.joda.time.Interval> intervals) Sum the length of the intervals in this collection.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_CONFIG

public static final SystemConfig SYSTEM_CONFIG

ALIGNMENT_EPOCH_STRING

public static final String ALIGNMENT_EPOCH_STRING

SYSTEM_ALIGNMENT_EPOCH

public static final org.joda.time.DateTime SYSTEM_ALIGNMENT_EPOCH

Constructor Detail

IntervalUtils

public IntervalUtils()

Method Detail

getIntervalOverlaps

public static Stream<org.joda.time.Interval> getIntervalOverlaps(org.joda.time.Interval interval,
                                                                 Collection<org.joda.time.Interval> compareIntervals)

For a given interval, return a stream of the subintervals of it that are shared with at least one interval in the collection of compare intervals.

Parameters:

interval - The interval being matched

compareIntervals - The collection of intervals being matched against

Returns:

Every pairwise overlap

getOverlappingSubintervals

public static Set<org.joda.time.Interval> getOverlappingSubintervals(Collection<org.joda.time.Interval> left,
                                                                     Collection<org.joda.time.Interval> right)

Find all the interval overlaps between two collections of intervals.

If the left set is null, return the right. This makes this usable in a reduce function.

Parameters:

left - The intervals being streamed over

right - The intervals being tested against

Returns:

A set of intervals describing the time common to both sets

getOverlappingSubintervals

public static Set<org.joda.time.Interval> getOverlappingSubintervals(Set<org.joda.time.Interval> left,
                                                                     Set<org.joda.time.Interval> right)

Find all the interval overlaps between two collections of intervals.

If the left set is null, return the right. This makes this usable in a reduce function.

Parameters:

left - The intervals being streamed over

right - The intervals being tested against

Returns:

A set of intervals describing the time common to both sets

getSlicedIntervals

public static Map<org.joda.time.Interval,AtomicInteger> getSlicedIntervals(Collection<org.joda.time.Interval> rawIntervals,
                                                                           Granularity grain)

Simplify raw intervals and return a map of intervals (dividing them by the grain) to the ordinal of the interval.

Parameters:

rawIntervals - A collection of intervals to be split

grain - The grain to split by.

Returns:

a map of simplified intervals split according to the grain to an integer that indicates their ordinal

countSlicedIntervals

public static long countSlicedIntervals(Collection<org.joda.time.Interval> rawIntervals,
                                        Granularity grain)

Count the intervals after simplifying raw intervals and splitting by grain.

Parameters:

rawIntervals - A collection of intervals to be split

grain - The grain to split by.

Returns:

a count of intervals as split by grain

collectBucketedIntervalsIntersectingIntervalList

public static SimplifiedIntervalList collectBucketedIntervalsIntersectingIntervalList(SimplifiedIntervalList supplyIntervals,
                                                                                      SimplifiedIntervalList bucketedIntervals,
                                                                                      Granularity granularity)

Collect all subintervals of an interval list of a grain bucketed size which are subintervals of another supply list of intervals.

Parameters:

supplyIntervals - The interval collection to match bucketedIntervals against

bucketedIntervals - The grain bucketed intervals to collect if they overlap the supply

granularity - Grain at which to split the bucketingIntervals

Returns:

a simplified list of subintervals of the bucketedIntervals list

getTotalDuration

public static long getTotalDuration(Collection<org.joda.time.Interval> intervals)

Sum the length of the intervals in this collection.

Parameters:

intervals - A collection of time intervals

Returns:

The total duration of all the intervals

firstMoment

public static Optional<org.joda.time.DateTime> firstMoment(Collection<? extends Collection<org.joda.time.Interval>> intervalSets)

Return the first date time instant in this set of intervals if available.

Parameters:

intervalSets - A collection of intervals sets

Returns:

Return the earliest date time (if any) across all the intervals contained

getTimeGrain

public static Optional<TimeGrain> getTimeGrain(org.joda.time.Interval interval)

Find a valid timegrain for the interval based on the start and end date of the interval.

Parameters:

interval - The interval to find a timegrain for.

Returns:

the valid timegrain spanned by the interval.