Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Limit

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Limit

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Limit(Schema schema, Optional<Long> offset, long count, PhysicalNode input)
extends Record
implements PhysicalNode

Limit (λ) — takes a prefix of the input; preserves the input's delivered ordering.

Nested Class Summary

Nested classes/interfaces inherited from interface com.darkcollective.relix.plan.PhysicalNode

PhysicalNode.Aggregate, PhysicalNode.AsOfJoin, PhysicalNode.BernoulliSample, PhysicalNode.BuildSide, PhysicalNode.Closure, PhysicalNode.Cluster, PhysicalNode.ConstructiveCover, PhysicalNode.Cover, PhysicalNode.Distinct, PhysicalNode.Division, PhysicalNode.Downsample, PhysicalNode.Empty, PhysicalNode.Fixpoint, PhysicalNode.IntervalJoin, PhysicalNode.Iterate, PhysicalNode.Join, PhysicalNode.JoinAlgorithm, PhysicalNode.JoinKeys, PhysicalNode.JoinKind, PhysicalNode.LateralJoin, PhysicalNode.Limit, PhysicalNode.Optimize, PhysicalNode.Path, PhysicalNode.Pivot, PhysicalNode.Project, PhysicalNode.PushedScan, PhysicalNode.RecursiveRef, PhysicalNode.Rename, PhysicalNode.ReservoirSample, PhysicalNode.Scan, PhysicalNode.Select, PhysicalNode.Sessionize, PhysicalNode.SetKind, PhysicalNode.SetOp, PhysicalNode.Solve, PhysicalNode.Sort, PhysicalNode.Spool, PhysicalNode.TopK, PhysicalNode.Trace, PhysicalNode.Tree, PhysicalNode.Universal, PhysicalNode.Unnest, PhysicalNode.Unpivot, PhysicalNode.Why, PhysicalNode.Window

Constructor Summary

Constructors

Constructor	Description
Limit(Schema schema, Optional<Long> offset, long count, PhysicalNode input)	Creates an instance of a Limit record class.

Method Summary

Modifier and Type	Method	Description
List<PhysicalNode>	children()	Direct child plans, left-to-right; empty for a PhysicalNode.Scan.
long	count()	Returns the value of the count record component.
Ordering	deliveredOrdering()	The Ordering that this node delivers on its output stream.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
PhysicalNode	input()	Returns the value of the input record component.
Optional<Long>	offset()	Returns the value of the offset record component.
Schema	schema()	Returns the value of the schema record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.darkcollective.relix.plan.PhysicalNode

mapChildren

Constructor Details

Limit

public Limit(Schema schema,
 Optional<Long> offset,
 long count,
 PhysicalNode input)

Creates an instance of a Limit record class.

Parameters:

schema - the value for the schema record component

offset - the value for the offset record component

count - the value for the count record component

input - the value for the input record component

Method Details

children

public List<PhysicalNode> children()

Description copied from interface: PhysicalNode

Direct child plans, left-to-right; empty for a PhysicalNode.Scan.

Specified by:

children in interface PhysicalNode

deliveredOrdering

public Ordering deliveredOrdering()

Description copied from interface: PhysicalNode

The Ordering that this node delivers on its output stream. The default implementation returns Ordering.none() — meaning no guaranteed row order — which is the conservative safe answer for any operator that does not propagate or establish an ordering. Individual nodes that do preserve order (PhysicalNode.Select, PhysicalNode.Limit) or establish it (PhysicalNode.Sort) override this method.

Specified by:

deliveredOrdering in interface PhysicalNode

Returns:

the delivered ordering; never null

toString

public final 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

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

schema

public Schema schema()

Returns the value of the schema record component.

Specified by:

schema in interface PhysicalNode

Returns:

the value of the schema record component

offset

public Optional<Long> offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component

count

public long count()

Returns the value of the count record component.

Returns:

the value of the count record component

input

public PhysicalNode input()

Returns the value of the input record component.

Returns:

the value of the input record component