org.elasticsearch.common.rounding

Class Rounding

java.lang.Object

org.elasticsearch.common.rounding.Rounding

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

Rounding.FactorRounding, Rounding.Interval, Rounding.OffsetRounding, TimeZoneRounding

public abstract class Rounding
extends Object
implements Streamable

A strategy for rounding long values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rounding.FactorRounding
static class	Rounding.Interval Rounding strategy which is based on an interval rounded = value - (value % interval)
static class	Rounding.OffsetRounding
static class	Rounding.Streams

Constructor Summary

Constructors

Constructor and Description
Rounding()

Method Summary

Methods

Modifier and Type	Method and Description
abstract byte	id()
abstract long	nextRoundingValue(long value) Given the rounded value (which was potentially generated by round(long), returns the next rounding value.
long	round(long value) Rounds the given value, equivalent to calling roundValue(roundKey(value)).
abstract long	roundKey(long value) Given a value, compute a key that uniquely identifies the rounded value although it is not necessarily equal to the rounding value itself.
abstract long	valueForKey(long key) Compute the rounded value given the key that identifies it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readFrom, writeTo

Constructor Detail

Rounding

public Rounding()

Method Detail

id

public abstract byte id()

roundKey

public abstract long roundKey(long value)

Given a value, compute a key that uniquely identifies the rounded value although it is not necessarily equal to the rounding value itself.

valueForKey

public abstract long valueForKey(long key)

Compute the rounded value given the key that identifies it.

round

public final long round(long value)

Rounds the given value, equivalent to calling roundValue(roundKey(value)).

Parameters:

value - The value to round.

Returns:

The rounded value.

nextRoundingValue

public abstract long nextRoundingValue(long value)

Given the rounded value (which was potentially generated by round(long), returns the next rounding value. For example, with interval based rounding, if the interval is 3, nextRoundValue(6) = 9 .

Parameters:

value - The current rounding value

Returns:

The next rounding value;