com.yahoo.bard.webservice.druid.model.dimension.extractionfunction

Class TimeFormatExtractionFunction

java.lang.Object

com.yahoo.bard.webservice.druid.model.dimension.extractionfunction.ExtractionFunction

com.yahoo.bard.webservice.druid.model.dimension.extractionfunction.TimeFormatExtractionFunction

public class TimeFormatExtractionFunction
extends ExtractionFunction

An extraction function that returns the dimension value formatted according to given format string, time zone, and locale.

Visit http://druid.io/docs/0.10.1/querying/dimensionspecs.html#time-format-extraction-function for more details on Time Format Extraction Function.

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.bard.webservice.druid.model.dimension.extractionfunction.ExtractionFunction

ExtractionFunction.DefaultExtractionFunctionType

Constructor Summary

Constructors

Constructor and Description
TimeFormatExtractionFunction() Constructor.
TimeFormatExtractionFunction(String format, Locale locale, org.joda.time.DateTimeZone timeZone, Granularity granularity, Boolean asMillis) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getFormat() Returns format of this TimeFormatExtractionFunction.
Granularity	getGranularity() Returns granularity of this TimeFormatExtractionFunction.
Locale	getLocale() Returns locale of this TimeFormatExtractionFunction.
org.joda.time.DateTimeZone	getTimeZone() Returns time zone of this TimeFormatExtractionFunction.
int	hashCode()
Boolean	isAsMillis() Returns whether to treat input input strings as millis(true) or ISO8601 strings(false).
TimeFormatExtractionFunction	withAsMillis(Boolean asMillis) Returns a new TimeFormatExtractionFunction with a specified config on "asMillis".
TimeFormatExtractionFunction	withFormat(String format) Returns a new TimeFormatExtractionFunction with a specified format.
TimeFormatExtractionFunction	withGranularity(Granularity granularity) Returns a new TimeFormatExtractionFunction with a specified granularity.
TimeFormatExtractionFunction	withLocale(Locale locale) Returns a new TimeFormatExtractionFunction with a specified locale.
TimeFormatExtractionFunction	withTimeZone(org.joda.time.DateTimeZone timeZone) Returns a new TimeFormatExtractionFunction with a specified time zone.

Methods inherited from class com.yahoo.bard.webservice.druid.model.dimension.extractionfunction.ExtractionFunction

getType

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeFormatExtractionFunction

public TimeFormatExtractionFunction()

Constructor.

Druid only requires "type" parameter in dimension spec. Other fields can all be null. See http://druid.io/docs/0.10.1/querying/dimensionspecs.html#time-format-extraction-function for more details.

TimeFormatExtractionFunction

public TimeFormatExtractionFunction(String format,
                                    Locale locale,
                                    org.joda.time.DateTimeZone timeZone,
                                    Granularity granularity,
                                    Boolean asMillis)

Constructor.

Parameters:

format - The date time format for the resulting dimension value, in Joda Time DateTimeFormat, or null to use the default ISO8601 format.

locale - Locale (language and country) to use, given as a IETF BCP 47 language tag, e.g. en-US, en-GB, fr-FR, fr-CA, etc.

timeZone - Time zone to use in IANA tz database format , e.g. Europe/Berlin (this can possibly be different than the aggregation time-zone)

granularity - Granularity to apply before formatting.

asMillis - Boolean value, set to true to treat input strings as millis rather than ISO8601 strings.

Method Detail

getFormat

public String getFormat()

Returns format of this TimeFormatExtractionFunction.

Returns:

the format of this TimeFormatExtractionFunction

getLocale

public Locale getLocale()

Returns locale of this TimeFormatExtractionFunction.

Returns:

the locale of this TimeFormatExtractionFunction

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

Returns time zone of this TimeFormatExtractionFunction.

Returns:

the time zone of this TimeFormatExtractionFunction

getGranularity

public Granularity getGranularity()

Returns granularity of this TimeFormatExtractionFunction.

Returns:

the granularity of this TimeFormatExtractionFunction

isAsMillis

public Boolean isAsMillis()

Returns whether to treat input input strings as millis(true) or ISO8601 strings(false).

Returns:

the whether to treat input input strings as millis(true) or ISO8601 strings(false)

withFormat

public TimeFormatExtractionFunction withFormat(String format)

Returns a new TimeFormatExtractionFunction with a specified format.

Parameters:

format - The date time format for the resulting dimension value, in Joda Time DateTimeFormat, or null to use the default ISO8601 format.

Returns:

the new TimeFormatExtractionFunction with the specified format

withLocale

public TimeFormatExtractionFunction withLocale(Locale locale)

Returns a new TimeFormatExtractionFunction with a specified locale.

Parameters:

locale - Locale (language and country) to use, given as a IETF BCP 47 language tag, e.g. en-US, en-GB, fr-FR, fr-CA, etc.

Returns:

the new TimeFormatExtractionFunction with the specified locale

withTimeZone

public TimeFormatExtractionFunction withTimeZone(org.joda.time.DateTimeZone timeZone)

Returns a new TimeFormatExtractionFunction with a specified time zone.

Parameters:

timeZone - Time zone to use in IANA tz database format , e.g. Europe/Berlin (this can possibly be different than the aggregation time-zone)

Returns:

the new TimeFormatExtractionFunction with the specified time zone

withGranularity

public TimeFormatExtractionFunction withGranularity(Granularity granularity)

Returns a new TimeFormatExtractionFunction with a specified granularity.

Parameters:

granularity - Granularity to apply before formatting.

Returns:

the new TimeFormatExtractionFunction with the specified granularity

withAsMillis

public TimeFormatExtractionFunction withAsMillis(Boolean asMillis)

Returns a new TimeFormatExtractionFunction with a specified config on "asMillis".

Parameters:

asMillis - Boolean value, set to true to treat input strings as millis rather than ISO8601 strings.

Returns:

new TimeFormatExtractionFunction with the specified config on "asMillis"

hashCode

public int hashCode()

Overrides:

hashCode in class ExtractionFunction

equals

public boolean equals(Object other)

Overrides:

equals in class ExtractionFunction