org.elasticsearch.search.aggregations.support.format

Interface ValueFormatter

All Superinterfaces:

Streamable

All Known Implementing Classes:

ValueFormatter.BooleanFormatter, ValueFormatter.DateTime, ValueFormatter.GeoHash, ValueFormatter.IPv4Formatter, ValueFormatter.Number, ValueFormatter.Number.Pattern, ValueFormatter.Raw

public interface ValueFormatter
extends Streamable

A strategy for formatting time represented as millis long value to string

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValueFormatter.BooleanFormatter
static class	ValueFormatter.DateTime A time formatter which is based on date/time format.
static class	ValueFormatter.GeoHash
static class	ValueFormatter.IPv4Formatter
static class	ValueFormatter.Number
static class	ValueFormatter.Raw

Field Summary

Fields

Modifier and Type	Field and Description
static ValueFormatter	BOOLEAN
static ValueFormatter	GEOHASH
static ValueFormatter	IPv4
static ValueFormatter	RAW

Method Summary

Methods

Modifier and Type	Method and Description
String	format(double value)
String	format(long value) Formats the given millis time value (since the epoch) to string.
byte	id() Uniquely identifies this formatter (used for efficient serialization)

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

readFrom, writeTo

Field Detail

RAW

static final ValueFormatter RAW

IPv4

static final ValueFormatter IPv4

GEOHASH

static final ValueFormatter GEOHASH

BOOLEAN

static final ValueFormatter BOOLEAN

Method Detail

id

byte id()

Uniquely identifies this formatter (used for efficient serialization)

Returns:

The id of this formatter

format

String format(long value)

Formats the given millis time value (since the epoch) to string.

Parameters:

value - The long value to format.

Returns:

The formatted value as string.

format

String format(double value)

Parameters:

value - double The double value to format.

Returns:

The formatted value as string