Package io.deephaven.api

Enum Class RangeStartRule

java.lang.Object

java.lang.Enum<RangeStartRule>

io.deephaven.api.RangeStartRule

All Implemented Interfaces:

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

public enum RangeStartRule
extends Enum<RangeStartRule>

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 start column value and right range column value must respect one of the enumerated RangeStartRule 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
LESS_THAN	The left start column value must be strictly less than right range column values.
LESS_THAN_OR_EQUAL	The left start column value must be less than or equal to right range column values.
LESS_THAN_OR_EQUAL_ALLOW_PRECEDING	The left start column value must be less than or equal to right range column values.

Method Summary

Modifier and Type	Method	Description
static RangeStartRule	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RangeStartRule[]	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

LESS_THAN

public static final RangeStartRule LESS_THAN

The left start column value must be strictly less than right range column values.

LESS_THAN_OR_EQUAL

public static final RangeStartRule LESS_THAN_OR_EQUAL

The left start column value must be less than or equal to right range column values.

LESS_THAN_OR_EQUAL_ALLOW_PRECEDING

public static final RangeStartRule LESS_THAN_OR_EQUAL_ALLOW_PRECEDING

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

Method Details

values

public static RangeStartRule[] 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 RangeStartRule 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