com.yahoo.bard.webservice.data.time

Interface ZonelessTimeGrain

All Superinterfaces:

Granularity, TimeGrain

All Known Implementing Classes:

DefaultTimeGrain

public interface ZonelessTimeGrain
extends TimeGrain

An interface to support classes which implement a Time Grain without Zone information. Zoneless time grains are like a Platonic Ideal of granularity. They are unattached to specific boundaries for purposes of rounding or alignment.

Method Summary

Modifier and Type	Method and Description
default boolean	aligns(org.joda.time.DateTime dateTime) Determines if this dateTime falls on a time grain boundary.
default ZonedTimeGrain	buildZonedTimeGrain(org.joda.time.DateTimeZone dateTimeZone) Apply a timezone to a time grain.

Methods inherited from interface com.yahoo.bard.webservice.data.time.TimeGrain

accepts, aligns, getAlignmentDescription, getEstimatedDuration, getName, getPeriod, getPeriodString, getType, intervalsIterator, roundCeiling, roundFloor, satisfiedBy, satisfiedBy, toString

Methods inherited from interface com.yahoo.bard.webservice.data.time.Granularity

intervalsIterable, intervalsIterator, satisfies

Method Detail

aligns

default boolean aligns(org.joda.time.DateTime dateTime)

Determines if this dateTime falls on a time grain boundary. A zoneless time grain should use the time zone from the date time being passed in for rounding alignment.

Specified by:

aligns in interface TimeGrain

Parameters:

dateTime - A date time to test against the time grain boundary

Returns:

true if this date time, under it's own time zone and calendar, meets a boundary on this time grain

buildZonedTimeGrain

default ZonedTimeGrain buildZonedTimeGrain(org.joda.time.DateTimeZone dateTimeZone)

Apply a timezone to a time grain.

Parameters:

dateTimeZone - The time zone to associate with the resulting zone time grain

Returns:

A time grain with the selected zone