Package io.deephaven.api

Class SortColumn

java.lang.Object

io.deephaven.api.SortColumn

All Implemented Interfaces:

SortSpec

@Immutable
public abstract class SortColumn
extends Object
implements SortSpec

Represents a column and order pair.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.api.SortSpec

SortSpec.Order

Constructor Summary

Constructors

Constructor	Description
SortColumn()

Method Summary

Modifier and Type	Method	Description
static SortColumn	asc(ColumnName columnName)	Create an SortSpec.Order.ASCENDING sort column.
abstract ColumnName	column()	The column name.
static SortColumn	desc(ColumnName columnName)	Create a SortSpec.Order.DESCENDING sort column.
abstract SortSpec.Order	order()	The order.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.api.SortSpec

isAscending

Constructor Details

SortColumn

public SortColumn()

Method Details

asc

public static SortColumn asc(ColumnName columnName)

Create an SortSpec.Order.ASCENDING sort column.

Parameters:

columnName - the column name

Returns:

the ascending sort column

desc

public static SortColumn desc(ColumnName columnName)

Create a SortSpec.Order.DESCENDING sort column.

Parameters:

columnName - the column name

Returns:

the descending sort column

column

@Parameter
public abstract ColumnName column()

The column name.

Specified by:

column in interface SortSpec

Returns:

the column name

order

@Parameter
public abstract SortSpec.Order order()

The order.

Specified by:

order in interface SortSpec

Returns:

the order