Package org.elasticsearch.search

Class DocValueFormat.BooleanDocValueFormat

org.elasticsearch.search.DocValueFormat.BooleanDocValueFormat

All Implemented Interfaces:

NamedWriteable, Writeable, DocValueFormat

Enclosing interface:

DocValueFormat

public static class DocValueFormat.BooleanDocValueFormat
extends 
implements DocValueFormat

Stateless, Singleton formatter for boolean values. Parses the strings "true" and "false" as inputs.

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(double value)	Format a double value.
	format(long value)	Format a long value.
	getWriteableName()	Returns the name of the writeable object
double	value, boolean roundUp, now)	Parse a value that was formatted with DocValueFormat.format(double) back to the original double value.
long	value, boolean roundUp, now)	Parse a value that was formatted with DocValueFormat.format(long) back to the original long value.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.

, , , , , , , , , ,

Methods inherited from interface org.elasticsearch.search.DocValueFormat

format, formatSortValue, parseBytesRef

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

parseLong

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