com.datastrato.gravitino.dto.rel

Class SortOrderDTO

java.lang.Object

com.datastrato.gravitino.dto.rel.SortOrderDTO

All Implemented Interfaces:

Expression, SortOrder

public class SortOrderDTO
extends java.lang.Object
implements SortOrder

Data Transfer Object for SortOrder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortOrderDTO.Builder Builder for SortOrderDTO.

Field Summary

Fields

Modifier and Type	Field and Description
static SortOrderDTO[]	EMPTY_SORT An empty array of SortOrderDTO.

Fields inherited from interface com.datastrato.gravitino.rel.expressions.Expression

EMPTY_EXPRESSION, EMPTY_NAMED_REFERENCE

Method Summary

Modifier and Type	Method and Description
static SortOrderDTO.Builder	builder()
SortDirection	direction()
Expression	expression()
NullOrdering	nullOrdering()
FunctionArg	sortTerm()
void	validate(ColumnDTO[] columns) Validates the sort order.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastrato.gravitino.rel.expressions.sorts.SortOrder

children

Methods inherited from interface com.datastrato.gravitino.rel.expressions.Expression

references

Field Detail

EMPTY_SORT

public static final SortOrderDTO[] EMPTY_SORT

An empty array of SortOrderDTO.

Method Detail

sortTerm

public FunctionArg sortTerm()

Returns:

The sort term.

expression

public Expression expression()

Specified by:

expression in interface SortOrder

Returns:

The sort expression.

direction

public SortDirection direction()

Specified by:

direction in interface SortOrder

Returns:

The sort direction.

nullOrdering

public NullOrdering nullOrdering()

Specified by:

nullOrdering in interface SortOrder

Returns:

The null ordering.

validate

public void validate(ColumnDTO[] columns)
              throws java.lang.IllegalArgumentException

Validates the sort order.

Parameters:

columns - The column DTOs to validate against.

Throws:

java.lang.IllegalArgumentException - If the sort order is invalid, this exception is thrown.

builder

public static SortOrderDTO.Builder builder()

Returns:

the builder for creating a new instance of SortOrderDTO.