org.elasticsearch.common.rounding

Class Rounding.Interval

java.lang.Object

org.elasticsearch.common.rounding.Rounding

org.elasticsearch.common.rounding.Rounding.Interval

All Implemented Interfaces:

Streamable

Enclosing class:

Rounding

public static class Rounding.Interval
extends Rounding

Rounding strategy which is based on an interval rounded = value - (value % interval)

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.common.rounding.Rounding

Rounding.FactorRounding, Rounding.Interval, Rounding.OffsetRounding, Rounding.Streams

Constructor Summary

Constructors

Constructor and Description
Rounding.Interval()
Rounding.Interval(long interval) Creates a new interval rounding.

Method Summary

Methods

Modifier and Type	Method and Description
byte	id()
long	nextRoundingValue(long value) Given the rounded value (which was potentially generated by Rounding.round(long), returns the next rounding value.
void	readFrom(StreamInput in)
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.
static long	roundKey(long value, long interval)
static long	roundValue(long key, long interval)
long	valueForKey(long key) Compute the rounded value given the key that identifies it.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.common.rounding.Rounding

round

Methods inherited from class java.lang.Object

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

Constructor Detail

Rounding.Interval

public Rounding.Interval()

Rounding.Interval

public Rounding.Interval(long interval)

Creates a new interval rounding.

Parameters:

interval - The interval

Method Detail

id

public byte id()

Specified by:

id in class Rounding

roundKey

public static long roundKey(long value,
            long interval)

roundValue

public static long roundValue(long key,
              long interval)

roundKey

public long roundKey(long value)

Description copied from class: Rounding

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

Specified by:

roundKey in class Rounding

valueForKey

public long valueForKey(long key)

Description copied from class: Rounding

Compute the rounded value given the key that identifies it.

Specified by:

valueForKey in class Rounding

nextRoundingValue

public long nextRoundingValue(long value)

Description copied from class: Rounding

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

Specified by:

nextRoundingValue in class Rounding

Parameters:

value - The current rounding value

Returns:

The next rounding value;

readFrom

public void readFrom(StreamInput in)
              throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException