com.yahoo.bard.webservice.util

Class DateTimeUtils

java.lang.Object

com.yahoo.bard.webservice.util.DateTimeUtils

public class DateTimeUtils
extends Object

Util functions to perform operations on JodaTime objects.

Constructor Summary

Constructors

Constructor and Description
DateTimeUtils()

Method Summary

Modifier and Type	Method and Description
static org.joda.time.DateTime	addTimeGrain(org.joda.time.DateTime dateTime, TimeGrain timeGrain) Adds timeGrain to a given dateTime.
static SortedSet<org.joda.time.Interval>	findFullAvailabilityGaps(Set<org.joda.time.Interval> availableIntervals, Set<org.joda.time.Interval> neededIntervals) Finds the gaps in available vs needed interval sets.
static org.joda.time.DateTimeZone	getTimeZone(Granularity granularity) Given a granularity, produce a time zone.
static String	intervalToString(org.joda.time.Interval interval, org.joda.time.format.DateTimeFormatter formatter, String separator) Converts an interval to a specified string format.
static Set<org.joda.time.Interval>	mergeIntervalSet(Set<org.joda.time.Interval> unmergedIntervals) Merge all contiguous and overlapping intervals in a set together and return the set with the merged intervals.
static Set<org.joda.time.Interval>	mergeIntervalToSet(Set<org.joda.time.Interval> intervals, org.joda.time.Interval intervalToMerge) Merge an interval into the given interval set.
static org.joda.time.DateTime	quarterlyRound(org.joda.time.DateTime from) Round the date time back to the beginning of the nearest (inclusive) month of January, April, July, October.
static List<org.joda.time.Interval>	sliceIntervals(org.joda.time.Interval interval, TimeGrain timeGrain) Slices the intervals into smaller intervals of the timeGrain duration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeUtils

public DateTimeUtils()

Method Detail

addTimeGrain

public static org.joda.time.DateTime addTimeGrain(org.joda.time.DateTime dateTime,
                                                  TimeGrain timeGrain)

Adds timeGrain to a given dateTime.

Parameters:

dateTime - dateTime to which timeGrain is to be added

timeGrain - timeGrain to be added

Returns:

new dateTime i.e. old dateTime + timeGrain

mergeIntervalSet

public static Set<org.joda.time.Interval> mergeIntervalSet(Set<org.joda.time.Interval> unmergedIntervals)

Merge all contiguous and overlapping intervals in a set together and return the set with the merged intervals.

Parameters:

unmergedIntervals - A set of intervals that may abut or overlap

Returns:

The set of merged intervals

mergeIntervalToSet

public static Set<org.joda.time.Interval> mergeIntervalToSet(Set<org.joda.time.Interval> intervals,
                                                             org.joda.time.Interval intervalToMerge)

Merge an interval into the given interval set.

Parameters:

intervals - set of intervals to which an interval is to be added/merged

intervalToMerge - interval to be merged

Returns:

set of intervals

findFullAvailabilityGaps

public static SortedSet<org.joda.time.Interval> findFullAvailabilityGaps(Set<org.joda.time.Interval> availableIntervals,
                                                                         Set<org.joda.time.Interval> neededIntervals)

Finds the gaps in available vs needed interval sets.

Parameters:

availableIntervals - availability intervals

neededIntervals - needed intervals

Returns:

set of intervals that are needed, but not fully available.

intervalToString

public static String intervalToString(org.joda.time.Interval interval,
                                      org.joda.time.format.DateTimeFormatter formatter,
                                      String separator)

Converts an interval to a specified string format.

Parameters:

interval - interval to be formatted

formatter - date time formatter for the

separator - string to separate interval start and end

Returns:

formatted interval string

sliceIntervals

public static List<org.joda.time.Interval> sliceIntervals(org.joda.time.Interval interval,
                                                          TimeGrain timeGrain)

Slices the intervals into smaller intervals of the timeGrain duration.

Parameters:

interval - interval to be sliced

timeGrain - size of the slice

Returns:

list of intervals obtained by slicing the larger interval

Throws:

IllegalArgumentException - if the interval is not an even multiple of the time grain

quarterlyRound

public static org.joda.time.DateTime quarterlyRound(org.joda.time.DateTime from)

Round the date time back to the beginning of the nearest (inclusive) month of January, April, July, October.

Parameters:

from - the date being rounded

Returns:

The nearest previous start of month for one of the three quarter months

getTimeZone

public static org.joda.time.DateTimeZone getTimeZone(Granularity granularity)

Given a granularity, produce a time zone.

Parameters:

granularity - The granularity's time zone, or if there isn't one, the default time zone

Returns:

A time zone