com.yahoo.bard.webservice.data.time

Interface Granularity

All Known Subinterfaces:

TimeGrain, ZonelessTimeGrain

All Known Implementing Classes:

AllGranularity, DefaultTimeGrain, ZonedTimeGrain

public interface Granularity

A granularity describes a way of dividing up or organizing time.

This is key to the notion of how bard describes time keyed data

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Collection<org.joda.time.Interval> intervals) Determine if all intervals align with a granularity.
String	getAlignmentDescription() Get description of correct alignment of a granularity, e.g.
String	getName() Get the name of the granularity.
default Iterable<org.joda.time.Interval>	intervalsIterable(Collection<org.joda.time.Interval> intervals) Wrap the granularity iterator in an iterable predicate for use in streaming.
default Iterator<org.joda.time.Interval>	intervalsIterator(Collection<org.joda.time.Interval> intervals) Build an iterator that will iterate over a set of intervals, collecting them into a single stream, and slicing or not slicing them according to the granularity given.
Iterator<org.joda.time.Interval>	intervalsIterator(SimplifiedIntervalList intervals) Build an iterator from a pre-simplified list of intervals.
boolean	satisfiedBy(Granularity that) Determine if this granularity can be fulfilled by an aggregate of another granularity.
default boolean	satisfies(Granularity that) Determine the reciprocal relationship to satisfiedBy, that this granularity fulfils an aggregate of another granularity.

Method Detail

getName

String getName()

Get the name of the granularity.

Returns:

the granularity name

intervalsIterator

default Iterator<org.joda.time.Interval> intervalsIterator(Collection<org.joda.time.Interval> intervals)

Build an iterator that will iterate over a set of intervals, collecting them into a single stream, and slicing or not slicing them according to the granularity given.

IMPORTANT WARNING: The results of this iterator will not always align with the bucketing of query results!

Period based granularities will return a single interval per result time bucket from the query. For the 'all' time grain, multiple intervals are possible, but in query result data they will all map to a single result time bucket.

Parameters:

intervals - The intervals being iterated across

Returns:

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

intervalsIterator

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

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

Parameters:

intervals - The intervals as a simplified interval list

Returns:

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

See Also:

intervalsIterator(Collection)

intervalsIterable

default Iterable<org.joda.time.Interval> intervalsIterable(Collection<org.joda.time.Interval> intervals)

Wrap the granularity iterator in an iterable predicate for use in streaming.

Parameters:

intervals - The intervals being iterated across

Returns:

An iterable useful for streaming over intervals by grain

See Also:

(Granularity, Collection)

satisfiedBy

boolean satisfiedBy(Granularity that)

Determine if this granularity can be fulfilled by an aggregate of another granularity.

Parameters:

that - The granularity to be compared against

Returns:

true if this granularity can be expressed in terms of elements of that granularity

satisfies

default boolean satisfies(Granularity that)

Determine the reciprocal relationship to satisfiedBy, that this granularity fulfils an aggregate of another granularity.

Parameters:

that - The granularity to be compared against.

Returns:

true if that granularity can be expressed in terms of elements of this granularity

accepts

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

Determine if all intervals align with a 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

String getAlignmentDescription()

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

Returns:

the correct alignment description