Module com.darkcollective.relix.ast

Package com.darkcollective.relix.ast

Record Class WindowFrame.Bound

java.lang.Object

java.lang.Record

com.darkcollective.relix.ast.WindowFrame.Bound

Record Components:

kind - which end, in the order the kinds are declared; never null

offset - the distance, present exactly for PRECEDING and FOLLOWING: a non-negative number, or a duration

Enclosing interface:

WindowFrame

public static record WindowFrame.Bound(WindowFrame.Bound.Kind kind, Optional<Operand> offset)
extends Record

One end of a WindowFrame.Between frame.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WindowFrame.Bound.Kind	The kinds of bound, from the partition's start to its end.

Constructor Summary

Constructors

Constructor	Description
Bound(WindowFrame.Bound.Kind kind, Optional<Operand> offset)	Creates an instance of a Bound record class.

Method Summary

Modifier and Type	Method	Description
static WindowFrame.Bound	currentRow()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static WindowFrame.Bound	following(Operand offset)
final int	hashCode()	Returns a hash code value for this object.
WindowFrame.Bound.Kind	kind()	Returns the value of the kind record component.
static String	literal(Operand offset)	A literal offset as written: a number, or DURATION '…'.
Optional<Operand>	offset()	Returns the value of the offset record component.
static WindowFrame.Bound	preceding(Operand offset)
String	render(Function<Operand,String> offsetText)	The bound as SQL writes it, the offset printed by offsetText.
String	toString()	Returns a string representation of this record class.
static WindowFrame.Bound	unboundedFollowing()
static WindowFrame.Bound	unboundedPreceding()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Bound

public Bound(WindowFrame.Bound.Kind kind,
 Optional<Operand> offset)

Creates an instance of a Bound record class.

Parameters:

kind - the value for the kind record component

offset - the value for the offset record component

Method Details

unboundedPreceding

public static WindowFrame.Bound unboundedPreceding()

preceding

public static WindowFrame.Bound preceding(Operand offset)

currentRow

public static WindowFrame.Bound currentRow()

following

public static WindowFrame.Bound following(Operand offset)

unboundedFollowing

public static WindowFrame.Bound unboundedFollowing()

render

public String render(Function<Operand,String> offsetText)

The bound as SQL writes it, the offset printed by offsetText.

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

literal

public static String literal(Operand offset)

A literal offset as written: a number, or DURATION '…'.

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

kind

public WindowFrame.Bound.Kind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

offset

public Optional<Operand> offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component