Package org.apache.flink.table.planner.plan.nodes.exec.spec

Class SortSpec

java.lang.Object

org.apache.flink.table.planner.plan.nodes.exec.spec.SortSpec

public class SortSpec
extends Object

SortSpec describes how the data will be sorted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SortSpec.SortFieldSpec	Sort info for a Field.
static class	SortSpec.SortSpecBuilder	SortSpec builder.

Field Summary

Fields

Modifier and Type	Field	Description
static final SortSpec	ANY	SortSpec does not require sort.
static final String	FIELD_NAME_FIELDS

Constructor Summary

Constructors

Constructor	Description
SortSpec(SortSpec.SortFieldSpec[] fieldSpecs)

Method Summary

Modifier and Type	Method	Description
static SortSpec.SortSpecBuilder	builder()
SortSpec	createSubSortSpec(int startIndex)	Creates a sub SortSpec starting from startIndex sort field.
boolean	equals(Object o)
boolean[]	getAscendingOrders()	Gets flags of all fields for whether to sort in ascending order or not.
int[]	getFieldIndices()	Gets field index of all fields in input.
int	getFieldSize()	Gets num of field in the spec.
SortSpec.SortFieldSpec	getFieldSpec(int index)	Gets SortSpec.SortFieldSpec of field at given index.
SortSpec.SortFieldSpec[]	getFieldSpecs()	Gets all SortSpec.SortFieldSpec in the SortSpec.
org.apache.flink.table.types.logical.LogicalType[]	getFieldTypes(org.apache.flink.table.types.logical.RowType input)	Gets fields types of sort fields accoording to input type.
boolean[]	getNullsIsLast()	Gets flags of all fields for whether to put null at last or not.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

FIELD_NAME_FIELDS

public static final String FIELD_NAME_FIELDS

See Also:

• Constant Field Values

ANY

public static final SortSpec ANY

SortSpec does not require sort.

Constructor Details

SortSpec

public SortSpec(SortSpec.SortFieldSpec[] fieldSpecs)

Method Details

createSubSortSpec

public SortSpec createSubSortSpec(int startIndex)

Creates a sub SortSpec starting from startIndex sort field.

getFieldIndices

public int[] getFieldIndices()

Gets field index of all fields in input.

getAscendingOrders

public boolean[] getAscendingOrders()

Gets flags of all fields for whether to sort in ascending order or not.

getNullsIsLast

public boolean[] getNullsIsLast()

Gets flags of all fields for whether to put null at last or not.

getFieldSpecs

public SortSpec.SortFieldSpec[] getFieldSpecs()

Gets all SortSpec.SortFieldSpec in the SortSpec.

getFieldSpec

public SortSpec.SortFieldSpec getFieldSpec(int index)

Gets SortSpec.SortFieldSpec of field at given index.

getFieldSize

public int getFieldSize()

Gets num of field in the spec.

getFieldTypes

public org.apache.flink.table.types.logical.LogicalType[] getFieldTypes(org.apache.flink.table.types.logical.RowType input)

Gets fields types of sort fields accoording to input type.

builder

public static SortSpec.SortSpecBuilder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object