Package io.deephaven.api

Enum Class RangeEndRule

java.lang.Object

java.lang.Enum<RangeEndRule>

io.deephaven.api.RangeEndRule

All Implemented Interfaces:

Serializable, Comparable<RangeEndRule>, java.lang.constant.Constable

public enum RangeEndRule
extends Enum<RangeEndRule>

Each output row of a range join corresponds to exactly one left table row and one or more aggregations over a range of responsive right table rows. Responsive right table rows must have identical values to the left table row for the exact match columns, and the relationship between the left end column value and right range column value must respect one of the enumerated RangeEndRule options.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GREATER_THAN	The left end column value must be strictly greater than right range column values.
GREATER_THAN_OR_EQUAL	The left end column value must be greater than or equal to right range column values.
GREATER_THAN_OR_EQUAL_ALLOW_FOLLOWING	The left end column value must be greater than or equal to right range column values.

Method Summary

Modifier and Type	Method	Description
static RangeEndRule	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RangeEndRule[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GREATER_THAN

public static final RangeEndRule GREATER_THAN

The left end column value must be strictly greater than right range column values.

GREATER_THAN_OR_EQUAL

public static final RangeEndRule GREATER_THAN_OR_EQUAL

The left end column value must be greater than or equal to right range column values.

GREATER_THAN_OR_EQUAL_ALLOW_FOLLOWING

public static final RangeEndRule GREATER_THAN_OR_EQUAL_ALLOW_FOLLOWING

The left end column value must be greater than or equal to right range column values. If no matching right range column value is equal to the left end column value, the immediately following matching right row should be included in the aggregation if such a row exists.

Method Details

values

public static RangeEndRule[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RangeEndRule valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null