com.yahoo.bard.webservice.data.time

Enum DefaultTimeGrain

java.lang.Object

java.lang.Enum<DefaultTimeGrain>

com.yahoo.bard.webservice.data.time.DefaultTimeGrain

All Implemented Interfaces:

Granularity, TimeGrain, ZonelessTimeGrain, Serializable, Comparable<DefaultTimeGrain>

public enum DefaultTimeGrain
extends Enum<DefaultTimeGrain>
implements ZonelessTimeGrain

DefaultTimeGrain are a set of concrete TimeGrain implementations which support 'natural', simple to describe time blocks corresponding to standard rounding rules. These time grains are all based on single field implementations of Joda's ReadablePeriod. Satisfiability is determined by configuring an explicit tree together via the satisfying grains property. Rounding functions support alignment testing, and are provided by joda's DateTime.Property class.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
HOUR
MINUTE
MONTH
QUARTER
WEEK
YEAR

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERIOD_TYPE_NAME

Method Summary

Modifier and Type	Method and Description
void	addSatisfyingGrain(TimeGrain satisfies) Notifies this grain that it can be decomposed to another grain.
String	getAlignmentDescription() Get description of correct alignment of a granularity, e.g.
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.
String	getType() Type of Granularity to use when serializing.
org.joda.time.DateTime	roundFloor(org.joda.time.DateTime dateTime) Given a date time find the first instant at or before that date time which starts a time grain.
boolean	satisfiedBy(TimeGrain grain) True if the argument grain can be used to build this grain.
String	toString()
static DefaultTimeGrain	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultTimeGrain[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

aligns, buildZonedTimeGrain

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

Enum Constant Detail

MINUTE

public static final DefaultTimeGrain MINUTE

HOUR

public static final DefaultTimeGrain HOUR

DAY

public static final DefaultTimeGrain DAY

WEEK

public static final DefaultTimeGrain WEEK

MONTH

public static final DefaultTimeGrain MONTH

QUARTER

public static final DefaultTimeGrain QUARTER

YEAR

public static final DefaultTimeGrain YEAR

Field Detail

PERIOD_TYPE_NAME

public static final String PERIOD_TYPE_NAME

See Also:

Constant Field Values

Method Detail

values

public static DefaultTimeGrain[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DefaultTimeGrain c : DefaultTimeGrain.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DefaultTimeGrain valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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

toString

public String toString()

Specified by:

toString in interface TimeGrain

Overrides:

toString in class Enum<DefaultTimeGrain>

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

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

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)

Description copied from interface: TimeGrain

Given a date time find the first instant at or before that date time which starts a time grain.

Specified by:

roundFloor in interface TimeGrain

Parameters:

dateTime - The time being rounded

Returns:

The first date time instant of the bucket this date time maps into

satisfiedBy

public boolean satisfiedBy(@NotNull
                           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

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

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

addSatisfyingGrain

public void addSatisfyingGrain(TimeGrain satisfies)

Notifies this grain that it can be decomposed to another grain.

Parameters:

satisfies - The grain which this grain can be built from.