org.elasticsearch.search.aggregations.support.format

Class ValueFormatter.DateTime

java.lang.Object

org.elasticsearch.search.aggregations.support.format.ValueFormatter.DateTime

All Implemented Interfaces:

Streamable, ValueFormatter

Enclosing interface:

ValueFormatter

public static class ValueFormatter.DateTime
extends Object
implements ValueFormatter

A time formatter which is based on date/time format.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.support.format.ValueFormatter

ValueFormatter.BooleanFormatter, ValueFormatter.DateTime, ValueFormatter.GeoHash, ValueFormatter.IPv4Formatter, ValueFormatter.Number, ValueFormatter.Raw

Field Summary

Fields

Modifier and Type	Field and Description
static ValueFormatter	DEFAULT

Fields inherited from interface org.elasticsearch.search.aggregations.support.format.ValueFormatter

BOOLEAN, GEOHASH, IPv4, RAW

Constructor Summary

Constructors

Constructor and Description
DateTime(FormatDateTimeFormatter formatter)
DateTime(FormatDateTimeFormatter formatter, org.joda.time.DateTimeZone timezone)
DateTime(String format)
DateTime(String format, org.joda.time.DateTimeZone timezone)

Method Summary

Modifier and Type	Method and Description
String	format(double value)
String	format(long time) Formats the given millis time value (since the epoch) to string.
byte	id() Uniquely identifies this formatter (used for efficient serialization)
static ValueFormatter.DateTime	mapper(DateFieldMapper.DateFieldType fieldType, org.joda.time.DateTimeZone timezone)
void	readFrom(StreamInput in)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ValueFormatter DEFAULT

Constructor Detail

DateTime

public DateTime(String format)

DateTime

public DateTime(FormatDateTimeFormatter formatter)

DateTime

public DateTime(String format,
                org.joda.time.DateTimeZone timezone)

DateTime

public DateTime(FormatDateTimeFormatter formatter,
                org.joda.time.DateTimeZone timezone)

Method Detail

mapper

public static ValueFormatter.DateTime mapper(DateFieldMapper.DateFieldType fieldType,
                                             org.joda.time.DateTimeZone timezone)

format

public String format(long time)

Description copied from interface: ValueFormatter

Formats the given millis time value (since the epoch) to string.

Specified by:

format in interface ValueFormatter

Parameters:

time - The long value to format.

Returns:

The formatted value as string.

format

public String format(double value)

Specified by:

format in interface ValueFormatter

Parameters:

value - double The double value to format.

Returns:

The formatted value as string

id

public byte id()

Description copied from interface: ValueFormatter

Uniquely identifies this formatter (used for efficient serialization)

Specified by:

id in interface ValueFormatter

Returns:

The id of this formatter

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException