Package org.apache.druid.java.util.common.granularity

Class PeriodGranularity

java.lang.Object

org.apache.druid.java.util.common.granularity.Granularity

org.apache.druid.java.util.common.granularity.PeriodGranularity

All Implemented Interfaces:

com.fasterxml.jackson.databind.JsonSerializable, Cacheable

public class PeriodGranularity
extends Granularity
implements com.fasterxml.jackson.databind.JsonSerializable

PeriodGranularity buckets data based on any custom time period

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.druid.java.util.common.granularity.Granularity

Granularity.Formatter

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Field Summary

Fields inherited from class org.apache.druid.java.util.common.granularity.Granularity

IS_FINER_THAN

Constructor Summary

Constructors

Constructor	Description
PeriodGranularity(org.joda.time.Period period, org.joda.time.DateTime origin, org.joda.time.DateTimeZone tz)

Method Summary

Modifier and Type	Method	Description
long	bucketStart(long time)
org.joda.time.DateTime	bucketStart(org.joda.time.DateTime time)
boolean	equals(Object o)
byte[]	getCacheKey()	Get a byte array used as a cache key.
org.joda.time.format.DateTimeFormatter	getFormatter(Granularity.Formatter type)
org.joda.time.DateTime	getOrigin()
org.joda.time.Period	getPeriod()
org.joda.time.DateTimeZone	getTimeZone()
int	hashCode()
long	increment(long t)
org.joda.time.DateTime	increment(org.joda.time.DateTime time)
boolean	isAligned(org.joda.time.Interval interval)	Return true only if the time chunks populated by this granularity includes the given interval time chunk.
void	serialize(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
void	serializeWithType(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider, com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSerializer)
org.joda.time.DateTime	toDate(String filePath, Granularity.Formatter formatter)
org.joda.time.DateTime	toDateTime(long offset)
String	toString()

Methods inherited from class org.apache.druid.java.util.common.granularity.Granularity

bucket, bucketEnd, fromString, getIterable, granularitiesFinerThan, isFinerThan, mergeGranularities, toDate, toPath

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodGranularity

public PeriodGranularity(org.joda.time.Period period,
                         org.joda.time.DateTime origin,
                         org.joda.time.DateTimeZone tz)

Method Detail

getPeriod

public org.joda.time.Period getPeriod()

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

Overrides:

getTimeZone in class Granularity

getOrigin

@Nullable
public org.joda.time.DateTime getOrigin()

getFormatter

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

Specified by:

getFormatter in class Granularity

bucketStart

public long bucketStart(long time)

Specified by:

bucketStart in class Granularity

increment

public long increment(long t)

Specified by:

increment in class Granularity

increment

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

Specified by:

increment in class Granularity

bucketStart

public org.joda.time.DateTime bucketStart(org.joda.time.DateTime time)

Specified by:

bucketStart in class Granularity

toDate

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

Specified by:

toDate in class Granularity

isAligned

public boolean isAligned(org.joda.time.Interval interval)

Description copied from class: Granularity

Return true only if the time chunks populated by this granularity includes the given interval time chunk. The interval must fit exactly into the scheme of the granularity for this to return true

Specified by:

isAligned in class Granularity

getCacheKey

public byte[] getCacheKey()

Description copied from interface: Cacheable

Get a byte array used as a cache key.

Specified by:

getCacheKey in interface Cacheable

Returns:

a cache key

toDateTime

public org.joda.time.DateTime toDateTime(long offset)

Overrides:

toDateTime in class Granularity

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

serialize

public void serialize(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                      com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
               throws IOException

Specified by:

serialize in interface com.fasterxml.jackson.databind.JsonSerializable

Throws:

IOException

serializeWithType

public void serializeWithType(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                              com.fasterxml.jackson.databind.SerializerProvider serializerProvider,
                              com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSerializer)
                       throws IOException

Specified by:

serializeWithType in interface com.fasterxml.jackson.databind.JsonSerializable

Throws:

IOException