com.yahoo.bard.webservice.data.time

Class AllGranularity

java.lang.Object

com.yahoo.bard.webservice.data.time.AllGranularity

All Implemented Interfaces:

Granularity

public class AllGranularity
extends Object
implements Granularity

All granularity buckets any number and length of intervals into a single bucket.

Because it has special behavior compared with period based time grains it gets it's own type.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_NAME
static AllGranularity	INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Collection<org.joda.time.Interval> intervals) Determine if all intervals align with a granularity.
boolean	equals(Object that)
String	getAlignmentDescription() Get description of correct alignment of a granularity, e.g.
String	getName() Get the name of the granularity.
int	hashCode()
Iterator<org.joda.time.Interval>	intervalsIterator(SimplifiedIntervalList intervals) Build an iterator from a pre-simplified list of intervals.
boolean	satisfiedBy(Granularity that) Any granularity can be rolled up into all.

Methods inherited from class java.lang.Object

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

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

intervalsIterable, intervalsIterator, satisfies

Field Detail

ALL_NAME

public static final String ALL_NAME

See Also:

Constant Field Values

INSTANCE

public static final AllGranularity INSTANCE

Method Detail

getName

public String getName()

Description copied from interface: Granularity

Get the name of the granularity.

Specified by:

getName in interface Granularity

Returns:

the granularity name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object

intervalsIterator

public Iterator<org.joda.time.Interval> intervalsIterator(SimplifiedIntervalList intervals)

Description copied from interface: Granularity

Build an iterator from a pre-simplified list of intervals.

Specified by:

intervalsIterator in interface Granularity

Parameters:

intervals - The intervals as a simplified interval list

Returns:

A grain delimited iterator returning all the intervals in the interval set

See Also:

Granularity.intervalsIterator(Collection)

satisfiedBy

public boolean satisfiedBy(Granularity that)

Any granularity can be rolled up into all.

Specified by:

satisfiedBy in interface Granularity

Parameters:

that - The granularity to be compared against

Returns:

true

accepts

public boolean accepts(Collection<org.joda.time.Interval> intervals)

Description copied from interface: Granularity

Determine if all intervals align with a granularity.

Specified by:

accepts in interface Granularity

Parameters:

intervals - The collection of intervals that should be checked

Returns:

true if all of the intervals start and end on instants which this granularity bounds

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

Returns:

the correct alignment description