com.metamx.common

Enum Granularity

java.lang.Object

java.lang.Enum<Granularity>

com.metamx.common.Granularity

All Implemented Interfaces:

Serializable, Comparable<Granularity>

public enum Granularity
extends Enum<Granularity>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Granularity.Formatter
class	Granularity.IntervalIterable
class	Granularity.IntervalIterator
class	Granularity.ReverseIntervalIterable
class	Granularity.ReverseIntervalIterator

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
FIFTEEN_MINUTE
FIVE_MINUTE
HOUR
MINUTE
MONTH
SECOND
SIX_HOUR
TEN_MINUTE
WEEK
YEAR

Field Summary

Fields

Modifier and Type	Field and Description
protected Pattern	defaultPathPattern
protected Pattern	hivePathPattern

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.Interval	bucket(org.joda.time.DateTime t) Return a granularity-sized Interval containing a particular DateTime.
org.joda.time.DateTime	decrement(org.joda.time.DateTime time)
org.joda.time.DateTime	decrement(org.joda.time.DateTime time, int count)
protected Integer[]	getDateValues(String filePath, Granularity.Formatter formatter)
abstract org.joda.time.format.DateTimeFormatter	getFormatter(Granularity.Formatter type)
org.joda.time.format.DateTimeFormatter	getFormatter(String type)
Iterable<org.joda.time.Interval>	getIterable(org.joda.time.DateTime start, org.joda.time.DateTime end)
Iterable<org.joda.time.Interval>	getIterable(org.joda.time.Interval input)
Iterable<org.joda.time.Interval>	getReverseIterable(org.joda.time.DateTime start, org.joda.time.DateTime end)
Iterable<org.joda.time.Interval>	getReverseIterable(org.joda.time.Interval input)
abstract org.joda.time.ReadablePeriod	getUnits(int n)
org.joda.time.DateTime	increment(org.joda.time.DateTime time)
org.joda.time.DateTime	increment(org.joda.time.DateTime time, int count)
abstract int	numIn(org.joda.time.ReadableInterval interval)
org.joda.time.DateTime	toDate(String filePath)
abstract org.joda.time.DateTime	toDate(String filePath, Granularity.Formatter formatter)
String	toPath(org.joda.time.DateTime time)
String	toPath(org.joda.time.DateTime time, Granularity.Formatter type)
String	toPath(org.joda.time.DateTime time, String type)
abstract org.joda.time.DateTime	truncate(org.joda.time.DateTime time)
static Granularity	valueOf(String name) Returns the enum constant of this type with the specified name.
static Granularity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
org.joda.time.Interval	widen(org.joda.time.Interval interval) Round out Interval such that it becomes granularity-aligned and nonempty.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SECOND

public static final Granularity SECOND

MINUTE

public static final Granularity MINUTE

FIVE_MINUTE

public static final Granularity FIVE_MINUTE

TEN_MINUTE

public static final Granularity TEN_MINUTE

FIFTEEN_MINUTE

public static final Granularity FIFTEEN_MINUTE

HOUR

public static final Granularity HOUR

SIX_HOUR

public static final Granularity SIX_HOUR

DAY

public static final Granularity DAY

WEEK

public static final Granularity WEEK

MONTH

public static final Granularity MONTH

YEAR

public static final Granularity YEAR

Field Detail

defaultPathPattern

protected final Pattern defaultPathPattern

hivePathPattern

protected final Pattern hivePathPattern

Method Detail

values

public static Granularity[] 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 (Granularity c : Granularity.values())
    System.out.println(c);

Returns:

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

valueOf

public static Granularity 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

getFormatter

public abstract org.joda.time.format.DateTimeFormatter getFormatter(Granularity.Formatter type)

getUnits

public abstract org.joda.time.ReadablePeriod getUnits(int n)

truncate

public abstract org.joda.time.DateTime truncate(org.joda.time.DateTime time)

numIn

public abstract int numIn(org.joda.time.ReadableInterval interval)

toDate

public abstract org.joda.time.DateTime toDate(String filePath,
                            Granularity.Formatter formatter)

toDate

public org.joda.time.DateTime toDate(String filePath)

getDateValues

protected final Integer[] getDateValues(String filePath,
                      Granularity.Formatter formatter)

getFormatter

public final org.joda.time.format.DateTimeFormatter getFormatter(String type)

increment

public final org.joda.time.DateTime increment(org.joda.time.DateTime time)

increment

public final org.joda.time.DateTime increment(org.joda.time.DateTime time,
                               int count)

decrement

public final org.joda.time.DateTime decrement(org.joda.time.DateTime time)

decrement

public final org.joda.time.DateTime decrement(org.joda.time.DateTime time,
                               int count)

toPath

public final String toPath(org.joda.time.DateTime time)

toPath

public final String toPath(org.joda.time.DateTime time,
            String type)

toPath

public final String toPath(org.joda.time.DateTime time,
            Granularity.Formatter type)

bucket

public final org.joda.time.Interval bucket(org.joda.time.DateTime t)

Return a granularity-sized Interval containing a particular DateTime.

widen

public final org.joda.time.Interval widen(org.joda.time.Interval interval)

Round out Interval such that it becomes granularity-aligned and nonempty.

getIterable

public Iterable<org.joda.time.Interval> getIterable(org.joda.time.DateTime start,
                                           org.joda.time.DateTime end)

getIterable

public Iterable<org.joda.time.Interval> getIterable(org.joda.time.Interval input)

getReverseIterable

public Iterable<org.joda.time.Interval> getReverseIterable(org.joda.time.DateTime start,
                                                  org.joda.time.DateTime end)

getReverseIterable

public Iterable<org.joda.time.Interval> getReverseIterable(org.joda.time.Interval input)