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 Object
implements DocValueFormat

Nested Class Summary

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

DocValueFormat.BinaryDocValueFormat, DocValueFormat.BooleanDocValueFormat, DocValueFormat.DateTime, DocValueFormat.Decimal, DocValueFormat.GeoHashDocValueFormat, DocValueFormat.GeoTileDocValueFormat, DocValueFormat.IpDocValueFormat, DocValueFormat.RawDocValueFormat, DocValueFormat.UnsignedLongShiftedDocValueFormat

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 String	NAME

Fields inherited from interface org.elasticsearch.search.DocValueFormat

BIGINTEGER_2_64_MINUS_ONE, BINARY, BOOLEAN, GEOHASH, GEOTILE, IP, MASK_2_63, RAW, UNSIGNED_LONG_SHIFTED

Constructor Summary

Constructors

Constructor	Description
DateTime(StreamInput in)
DateTime(DateFormatter formatter, ZoneId timeZone, DateFieldMapper.Resolution resolution)

Method Summary

Modifier and Type	Method	Description
String	format(double value)	Format a double value.
String	format(long value)	Format a long value.
Object	formatSortValue(Object value)	Formats a value of a sort field in a search response.
DateMathParser	getDateMathParser()
String	getWriteableName()	Returns the name of the writeable object
double	parseDouble(String value, boolean roundUp, LongSupplier now)	Parse a value that was formatted with DocValueFormat.format(double) back to the original double value.
long	parseLong(String value, boolean roundUp, LongSupplier now)	Parse a value that was formatted with DocValueFormat.format(long) back to the original long value.
String	toString()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.DocValueFormat

format, parseBytesRef

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Details

DateTime

public DateTime(DateFormatter formatter,
 ZoneId timeZone,
 DateFieldMapper.Resolution resolution)

DateTime

public DateTime(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

getWriteableName

public 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 IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getDateMathParser

public DateMathParser getDateMathParser()

format

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

formatSortValue

public Object formatSortValue(Object value)

Description copied from interface: DocValueFormat

Formats a value of a sort field in a search response. This is used by SearchSortValues to avoid sending the internal representation of a value of a sort field in a search response. The default implementation formats BytesRef but leave other types as-is.

Specified by:

formatSortValue in interface DocValueFormat

parseLong

public long parseLong(String value,
 boolean roundUp,
 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(String value,
 boolean roundUp,
 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

toString

public String toString()

Overrides:

toString in class Object