io.orchestrate.client

Class Range

java.lang.Object

io.orchestrate.client.Range

Direct Known Subclasses:

RangeBucket

public class Range
extends java.lang.Object

This class represents numeric ranges, with minimum and maximum points, that can be used to build Range or Distance aggregates. Although all Range objects require a min and max value, an unbounded range can be created using Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY. For the sake of building aggregate queries, Ranges are always inclusive of the lower bound and exclusive of the upper bound. So, for example, consider two consecutive Range objects with adjacent bounds:

 
   Range a = Range.between(0, 10);
   Range b = Range.between(10, 20);
 
 

The value 10 would be included as part of range `b` but not as part of range `a`, since ranges are always exclusive of their max value. Consumers of this class should use the public static factory methods (below, above, and between) to create Ranges, since those methods handle infinities and NaN values correctly.

Method Summary

Modifier and Type	Method and Description
static Range	above(double min) Creates a new Range object with the designated lower bound and Double.POSITIVE_INFINITY as the upper bound.
static Range	below(double max) Creates a new Range object with the designated upper bound and Double.NEGATIVE_INFINITY as the lower bound.
static Range	between(double min, double max) Creates a new Range object with the designated lower and upper bounds.
double	getMax()
double	getMin()
java.lang.String	unparse() Creates a syntactically correct string version of this range, suitable for building range aggregate and distance aggregate clauses.

Methods inherited from class java.lang.Object

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

Method Detail

getMin

public double getMin()

getMax

public double getMax()

below

public static Range below(double max)

Creates a new Range object with the designated upper bound and Double.NEGATIVE_INFINITY as the lower bound.

Parameters:

max - The upper bound for the range.

Returns:

A range object.

above

public static Range above(double min)

Creates a new Range object with the designated lower bound and Double.POSITIVE_INFINITY as the upper bound.

Parameters:

min - The lower bound for the range.

Returns:

A range object.

between

public static Range between(double min,
                            double max)

Creates a new Range object with the designated lower and upper bounds.

Parameters:

min - The lower bound for the range.

max - The upper bound for the range.

Returns:

A range object.

unparse

public java.lang.String unparse()

Creates a syntactically correct string version of this range, suitable for building range aggregate and distance aggregate clauses.

Returns:

The string representation of the range.