Package org.elasticsearch.search

Class DocValueFormat.DateTime

java.lang.Object

org.elasticsearch.search.DocValueFormat.DateTime

All Implemented Interfaces:

NamedWriteable, Writeable, DocValueFormat

Enclosing interface:

DocValueFormat

public static final class DocValueFormat.DateTime
extends java.lang.Object
implements DocValueFormat

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.DocValueFormat

DocValueFormat.DateTime, DocValueFormat.Decimal

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

Fields inherited from interface org.elasticsearch.search.DocValueFormat

BOOLEAN, GEOHASH, IP, RAW

Constructor Summary

Constructors

Constructor	Description
DateTime(StreamInput in)
DateTime(FormatDateTimeFormatter formatter, org.joda.time.DateTimeZone timeZone)

Method Summary

Modifier and Type	Method	Description
java.lang.String	format(double value)	Format a double value.
java.lang.String	format(long value)	Format a long value.
java.lang.String	format(org.apache.lucene.util.BytesRef value)	Format a binary value.
java.lang.String	getWriteableName()	Returns the name of the writeable object
org.apache.lucene.util.BytesRef	parseBytesRef(java.lang.String value)	Parse a value that was formatted with DocValueFormat.format(BytesRef) back to the original BytesRef.
double	parseDouble(java.lang.String value, boolean roundUp, java.util.function.LongSupplier now)	Parse a value that was formatted with DocValueFormat.format(double) back to the original double value.
long	parseLong(java.lang.String value, boolean roundUp, java.util.function.LongSupplier now)	Parse a value that was formatted with DocValueFormat.format(long) back to the original long value.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

DateTime

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

DateTime

public DateTime(StreamInput in)
         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

format

public java.lang.String format(long value)

Description copied from interface: DocValueFormat

Format a long value. This is used by terms and histogram aggregations to format keys for fields that use longs as a doc value representation such as the long and date fields.

Specified by:

format in interface DocValueFormat

format

public java.lang.String format(double value)

Description copied from interface: DocValueFormat

Format a double value. This is used by terms and stats aggregations to format keys for fields that use numbers as a doc value representation such as the long, double or date fields.

Specified by:

format in interface DocValueFormat

format

public java.lang.String format(org.apache.lucene.util.BytesRef value)

Description copied from interface: DocValueFormat

Format a binary value. This is used by terms aggregations to format keys for fields that use binary doc value representations such as the keyword and ip fields.

Specified by:

format in interface DocValueFormat

parseLong

public long parseLong(java.lang.String value,
                      boolean roundUp,
                      java.util.function.LongSupplier now)

Description copied from interface: DocValueFormat

Parse a value that was formatted with DocValueFormat.format(long) back to the original long value.

Specified by:

parseLong in interface DocValueFormat

parseDouble

public double parseDouble(java.lang.String value,
                          boolean roundUp,
                          java.util.function.LongSupplier now)

Description copied from interface: DocValueFormat

Parse a value that was formatted with DocValueFormat.format(double) back to the original double value.

Specified by:

parseDouble in interface DocValueFormat

parseBytesRef

public org.apache.lucene.util.BytesRef parseBytesRef(java.lang.String value)

Description copied from interface: DocValueFormat

Parse a value that was formatted with DocValueFormat.format(BytesRef) back to the original BytesRef.

Specified by:

parseBytesRef in interface DocValueFormat