Package org.elasticsearch.search

Class DocValueFormat.BinaryDocValueFormat

org.elasticsearch.search.DocValueFormat.BinaryDocValueFormat

All Implemented Interfaces:

NamedWriteable, Writeable, DocValueFormat

Enclosing interface:

DocValueFormat

public static class DocValueFormat.BinaryDocValueFormat
extends 
implements DocValueFormat

Singleton, stateless formatter, for representing bytes as base64 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 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
	format(org.apache.lucene.util.BytesRef value)	Format a binary value.
	getWriteableName()	Returns the name of the writeable object
org.apache.lucene.util.BytesRef	value)	Parse a value that was formatted with DocValueFormat.format(BytesRef) back to the original BytesRef.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.

, , , , , , , , , ,

Methods inherited from interface org.elasticsearch.search.DocValueFormat

format, format, formatSortValue, parseDouble, parseLong

Field Details

INSTANCE

public static final DocValueFormat INSTANCE

Method Details

getWriteableName

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

parseBytesRef

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