Package org.elasticsearch.search

Interface DocValueFormat

All Superinterfaces:

NamedWriteable, Writeable

All Known Implementing Classes:

DocValueFormat.DateTime, DocValueFormat.Decimal

public interface DocValueFormat
extends NamedWriteable

A formatter for values as returned by the fielddata/doc-values APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DocValueFormat.DateTime
static class	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 DocValueFormat	BINARY
static DocValueFormat	BOOLEAN
static DocValueFormat	GEOHASH
static DocValueFormat	GEOTILE
static DocValueFormat	IP
static DocValueFormat	RAW

Method Summary

Modifier and Type	Method	Description
default Object	format(double value)	Format a double value.
default Object	format(long value)	Format a long value.
default Object	format(BytesRef value)	Format a binary value.
default BytesRef	parseBytesRef(String value)	Parse a value that was formatted with format(BytesRef) back to the original BytesRef.
default double	parseDouble(String value, boolean roundUp, LongSupplier now)	Parse a value that was formatted with format(double) back to the original double value.
default long	parseLong(String value, boolean roundUp, LongSupplier now)	Parse a value that was formatted with format(long) back to the original long value.
static DocValueFormat	withNanosecondResolution(DocValueFormat format)

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Field Detail

RAW

static final DocValueFormat RAW

BINARY

static final DocValueFormat BINARY

GEOHASH

static final DocValueFormat GEOHASH

GEOTILE

static final DocValueFormat GEOTILE

BOOLEAN

static final DocValueFormat BOOLEAN

IP

static final DocValueFormat IP

Method Detail

format

default Object format(long value)

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.

format

default Object format(double value)

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.

format

default Object format(BytesRef value)

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.

parseLong

default long parseLong(String value,
                       boolean roundUp,
                       LongSupplier now)

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

parseDouble

default double parseDouble(String value,
                           boolean roundUp,
                           LongSupplier now)

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

parseBytesRef

default BytesRef parseBytesRef(String value)

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

withNanosecondResolution

static DocValueFormat withNanosecondResolution(DocValueFormat format)