Module org.elasticsearch.server

Package org.elasticsearch.search

Interface DocValueFormat

All Superinterfaces:

NamedWriteable, Writeable

All Known Implementing Classes:

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

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.BinaryDocValueFormat	Singleton, stateless formatter, for representing bytes as base64 strings
static class	DocValueFormat.BooleanDocValueFormat	Stateless, Singleton formatter for boolean values.
static final class	DocValueFormat.DateTime
static final class	DocValueFormat.Decimal
static class	DocValueFormat.GeoHashDocValueFormat	Singleton, stateless formatter for geo hash values
static class	DocValueFormat.GeoTileDocValueFormat
static class	DocValueFormat.IpDocValueFormat	Stateless, singleton formatter for IP address data
static class	DocValueFormat.RawDocValueFormat	Singleton, stateless formatter for "Raw" values, generally taken to mean keywords and other strings.
static class	DocValueFormat.TimeSeriesIdDocValueFormat	DocValues format for time series id.
static class	DocValueFormat.UnsignedLongShiftedDocValueFormat	DocValues format for unsigned 64 bit long values, that are stored as shifted signed 64 bit long values.

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 final BigInteger	BIGINTEGER_2_64_MINUS_ONE
static final DocValueFormat	BINARY
static final DocValueFormat	BOOLEAN
static final DocValueFormat	GEOHASH
static final DocValueFormat	GEOTILE
static final DocValueFormat.IpDocValueFormat	IP
static final long	MASK_2_63
static final DocValueFormat	RAW
static final DocValueFormat	TIME_SERIES_ID
static final DocValueFormat	UNSIGNED_LONG_SHIFTED

Method Summary

Modifier and Type	Method	Description
static DocValueFormat	enableFormatSortValues(DocValueFormat format)
default Object	format(double value)	Format a double value.
default Object	format(long value)	Format a long value.
default Object	format(org.apache.lucene.util.BytesRef value)	Format a binary value.
default Object	formatSortValue(Object value)	Formats a value of a sort field in a search response.
default org.apache.lucene.util.BytesRef	parseBytesRef(Object 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 Details

MASK_2_63

static final long MASK_2_63

See Also:

• Constant Field Values

BIGINTEGER_2_64_MINUS_ONE

static final BigInteger BIGINTEGER_2_64_MINUS_ONE

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.IpDocValueFormat IP

UNSIGNED_LONG_SHIFTED

static final DocValueFormat UNSIGNED_LONG_SHIFTED

TIME_SERIES_ID

static final DocValueFormat TIME_SERIES_ID

Method Details

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(org.apache.lucene.util.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 org.apache.lucene.util.BytesRef parseBytesRef(Object value)

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

formatSortValue

default Object formatSortValue(Object value)

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.

withNanosecondResolution

static DocValueFormat withNanosecondResolution(DocValueFormat format)

enableFormatSortValues

static DocValueFormat enableFormatSortValues(DocValueFormat format)