Package io.deephaven.api

Class RangeJoinMatch

java.lang.Object

io.deephaven.api.RangeJoinMatch

@Immutable
public abstract class RangeJoinMatch
extends Object

A RangeJoinMatch specifies the columns and relationships used to determine a bucket's responsive rows from the right table for each row in the left table of a range join.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RangeJoinMatch.Builder

Constructor Summary

Constructors

Constructor	Description
RangeJoinMatch()

Method Summary

Modifier and Type	Method	Description
static RangeJoinMatch.Builder	builder()
final void	checkLeftColumnsDifferent()
abstract ColumnName	leftEndColumn()	The column from the left table that bounds the end of the responsive range from the right table.
abstract ColumnName	leftStartColumn()	The column from the left table that bounds the start of the responsive range from the right table.
static RangeJoinMatch	of(ColumnName leftStartColumn, RangeStartRule rangeStartRule, ColumnName rightRangeColumn, RangeEndRule rangeEndRule, ColumnName leftEndColumn)
static RangeJoinMatch	parse(String input)
abstract RangeEndRule	rangeEndRule()	The rule applied to leftStartColumn() and rightRangeColumn() to determine the end of the responsive range from the right table for a given left table row.
abstract RangeStartRule	rangeStartRule()	The rule applied to leftStartColumn() and rightRangeColumn() to determine the start of the responsive range from the right table for a given left table row.
abstract ColumnName	rightRangeColumn()	The column name from the right table that determines which right table rows are responsive to a given left table row.

Methods inherited from class java.lang.Object

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

Constructor Details

RangeJoinMatch

public RangeJoinMatch()

Method Details

builder

public static RangeJoinMatch.Builder builder()

of

public static RangeJoinMatch of(ColumnName leftStartColumn,
 RangeStartRule rangeStartRule,
 ColumnName rightRangeColumn,
 RangeEndRule rangeEndRule,
 ColumnName leftEndColumn)

parse

public static RangeJoinMatch parse(String input)

leftStartColumn

public abstract ColumnName leftStartColumn()

The column from the left table that bounds the start of the responsive range from the right table.

Returns:

The left start column name

rangeStartRule

public abstract RangeStartRule rangeStartRule()

The rule applied to leftStartColumn() and rightRangeColumn() to determine the start of the responsive range from the right table for a given left table row.

Returns:

The range start rule

rightRangeColumn

public abstract ColumnName rightRangeColumn()

The column name from the right table that determines which right table rows are responsive to a given left table row.

Returns:

The right range column name

rangeEndRule

public abstract RangeEndRule rangeEndRule()

The rule applied to leftStartColumn() and rightRangeColumn() to determine the end of the responsive range from the right table for a given left table row.

Returns:

The range end rule

leftEndColumn

public abstract ColumnName leftEndColumn()

The column from the left table that bounds the end of the responsive range from the right table.

Returns:

The left end column name

checkLeftColumnsDifferent

@Check
public final void checkLeftColumnsDifferent()