com.yahoo.bard.webservice.data.time

Class ZonedTimeGrain

java.lang.Object

com.yahoo.bard.webservice.data.time.ZonedTimeGrain

All Implemented Interfaces:

Granularity, TimeGrain

public class ZonedTimeGrain
extends Object
implements TimeGrain

TimeGrain with a time zone and a Zoneless Time Grain. A key difference from ZonelessTimeGrain is that alignment testing and rounding on a ZonedTimeGrain will be considered with respect to the ZonedTimeGrain's buckets rather than using the time zone on the date time supplied.

Constructor Summary

Constructors

Constructor and Description
ZonedTimeGrain(ZonelessTimeGrain baseTimeGrain, org.joda.time.DateTimeZone timeZone) Create a Zoned Time grain wrapping a ZonelessTimeGrain and a joda DateTimeZone.

Method Summary

Modifier and Type	Method and Description
boolean	aligns(org.joda.time.DateTime dateTime) Determines if this dateTime falls on a time grain boundary.
boolean	equals(Object that)
String	getAlignmentDescription() Get description of correct alignment of a granularity, e.g.
ZonelessTimeGrain	getBaseTimeGrain()
org.joda.time.Duration	getEstimatedDuration() Estimated duration gives a rough millisecond length of the TimeGrain usable for comparison.
String	getName() Get the name of the granularity.
org.joda.time.ReadablePeriod	getPeriod() Get the Period of the TimeGrain.
String	getPeriodString() Period string to use when serializing.
org.joda.time.DateTimeZone	getTimeZone()
String	getTimeZoneName()
String	getType() Type of Granularity to use when serializing.
int	hashCode()
org.joda.time.DateTime	roundFloor(org.joda.time.DateTime dateTime) Use the inner grain's round function to round a DateTime, but use the bucketing of this grain's timezone rather than the one from the date time itself.
boolean	satisfiedBy(TimeGrain grain) True if the argument grain can be used to build this grain.
String	toString()
ZonedTimeGrain	withZone(org.joda.time.DateTimeZone dateTimeZone) Create a ZonedTimeGrain with the same base grain and a different time zone.

Methods inherited from class java.lang.Object

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

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

accepts, aligns, intervalsIterator, roundCeiling, satisfiedBy

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

intervalsIterable, intervalsIterator, satisfies

Constructor Detail

ZonedTimeGrain

public ZonedTimeGrain(@NotNull
                      ZonelessTimeGrain baseTimeGrain,
                      @NotNull
                      org.joda.time.DateTimeZone timeZone)

Create a Zoned Time grain wrapping a ZonelessTimeGrain and a joda DateTimeZone.

Parameters:

baseTimeGrain - the unzoned time grain to decorate

timeZone - A time zone to apply to this time grain

Method Detail

getType

public String getType()

Description copied from interface: TimeGrain

Type of Granularity to use when serializing.

Specified by:

getType in interface TimeGrain

Returns:

the type of the TimeGrain

getPeriodString

public String getPeriodString()

Description copied from interface: TimeGrain

Period string to use when serializing.

Specified by:

getPeriodString in interface TimeGrain

Returns:

the period string

roundFloor

public org.joda.time.DateTime roundFloor(org.joda.time.DateTime dateTime)

Use the inner grain's round function to round a DateTime, but use the bucketing of this grain's timezone rather than the one from the date time itself.

Specified by:

roundFloor in interface TimeGrain

Parameters:

dateTime - The time being rounded

Returns:

the time, as rounded by the inner time grain and adjusted into this grain's time zone.

getPeriod

public org.joda.time.ReadablePeriod getPeriod()

Description copied from interface: TimeGrain

Get the Period of the TimeGrain.

Specified by:

getPeriod in interface TimeGrain

Returns:

the TimeGrain Period

getName

public String getName()

Description copied from interface: Granularity

Get the name of the granularity.

Specified by:

getName in interface Granularity

Specified by:

getName in interface TimeGrain

Returns:

the granularity name

getAlignmentDescription

public String getAlignmentDescription()

Description copied from interface: Granularity

Get description of correct alignment of a granularity, e.g. week

Specified by:

getAlignmentDescription in interface Granularity

Specified by:

getAlignmentDescription in interface TimeGrain

Returns:

the correct alignment description

getEstimatedDuration

public org.joda.time.Duration getEstimatedDuration()

Description copied from interface: TimeGrain

Estimated duration gives a rough millisecond length of the TimeGrain usable for comparison.

Specified by:

getEstimatedDuration in interface TimeGrain

Returns:

a millisecond based estimate of the length of this time grain

getTimeZoneName

public String getTimeZoneName()

aligns

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

Description copied from interface: TimeGrain

Determines if this dateTime falls on a time grain boundary.

Specified by:

aligns in interface TimeGrain

Parameters:

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

Returns:

true if the date time is at the beginning of a time grain bucket.

satisfiedBy

public boolean satisfiedBy(TimeGrain grain)

Description copied from interface: TimeGrain

True if the argument grain can be used to build this grain. This grain doesn't need to be a regular multiple of the reference grain. (e.g. months are an irregular number of days long) In the basic case this will support compositions such as days into months or weeks. If additional narrowing concerns are applied, less specified grains can satisfy more specified grains, but not vice versa. For example, a day with a time zone can be satisfied by one without a time zone, but zoneless time cannot be satisfied by timezoned time.

Specified by:

satisfiedBy in interface TimeGrain

Parameters:

grain - The grain being tested

Returns:

true if this grain can be built out of the parameter grain

getBaseTimeGrain

public ZonelessTimeGrain getBaseTimeGrain()

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

withZone

public ZonedTimeGrain withZone(org.joda.time.DateTimeZone dateTimeZone)

Create a ZonedTimeGrain with the same base grain and a different time zone.

Parameters:

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

Returns:

The modified copy ZonedTimeGrain

toString

public String toString()

Specified by:

toString in interface TimeGrain

Overrides:

toString in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object