Package org.elasticsearch.search

Class DocValueFormat.RawDocValueFormat

java.lang.Object

org.elasticsearch.search.DocValueFormat.RawDocValueFormat

All Implemented Interfaces:

NamedWriteable, Writeable, DocValueFormat

Enclosing interface:

DocValueFormat

public static class DocValueFormat.RawDocValueFormat
extends Object
implements DocValueFormat

Singleton, stateless formatter for "Raw" values, generally taken to mean keywords and other strings.

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 final DocValueFormat	INSTANCE

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

Method Summary

Modifier and Type	Method	Description
Double	format(double value)	Format a double value.
Long	format(long value)	Format a long value.
String	format(org.apache.lucene.util.BytesRef value)	Format a binary value.
String	getWriteableName()	Returns the name of the writeable object
org.apache.lucene.util.BytesRef	parseBytesRef(String value)	Parse a value that was formatted with DocValueFormat.format(BytesRef) back to the original BytesRef.
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

formatSortValue

Field Details

INSTANCE

public static final DocValueFormat INSTANCE

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)

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

format

public Long 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 Double 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 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(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

parseBytesRef

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

toString

public String toString()

Overrides:

toString in class Object