Package org.apache.iceberg

Class SortOrder.Builder

java.lang.Object

org.apache.iceberg.SortOrder.Builder

All Implemented Interfaces:

SortOrderBuilder<SortOrder.Builder>

Enclosing class:

SortOrder

public static class SortOrder.Builder
extends java.lang.Object
implements SortOrderBuilder<SortOrder.Builder>

A builder used to create valid sort orders.

Call SortOrder.builderFor(Schema) to create a new builder.

Method Summary

Modifier and Type	Method	Description
SortOrder.Builder	asc(Term term, NullOrder nullOrder)	Add an expression term to the sort, ascending with the given null order.
SortOrder	build()
SortOrder.Builder	caseSensitive(boolean sortCaseSensitive)	Set case sensitivity of sort column name resolution.
SortOrder.Builder	desc(Term term, NullOrder nullOrder)	Add an expression term to the sort, descending with the given null order.
SortOrder.Builder	sortBy(java.lang.String name, SortDirection direction, NullOrder nullOrder)
SortOrder.Builder	sortBy(Term term, SortDirection direction, NullOrder nullOrder)
SortOrder.Builder	withOrderId(int newOrderId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.SortOrderBuilder

asc, asc, asc, desc, desc, desc

Method Detail

asc

public SortOrder.Builder asc(Term term,
                             NullOrder nullOrder)

Add an expression term to the sort, ascending with the given null order.

Specified by:

asc in interface SortOrderBuilder<SortOrder.Builder>

Parameters:

term - an expression term

nullOrder - a null order (first or last)

Returns:

this for method chaining

desc

public SortOrder.Builder desc(Term term,
                              NullOrder nullOrder)

Add an expression term to the sort, descending with the given null order.

Specified by:

desc in interface SortOrderBuilder<SortOrder.Builder>

Parameters:

term - an expression term

nullOrder - a null order (first or last)

Returns:

this for method chaining

sortBy

public SortOrder.Builder sortBy(java.lang.String name,
                                SortDirection direction,
                                NullOrder nullOrder)

sortBy

public SortOrder.Builder sortBy(Term term,
                                SortDirection direction,
                                NullOrder nullOrder)

withOrderId

public SortOrder.Builder withOrderId(int newOrderId)

caseSensitive

public SortOrder.Builder caseSensitive(boolean sortCaseSensitive)

Description copied from interface: SortOrderBuilder

Set case sensitivity of sort column name resolution.

Specified by:

caseSensitive in interface SortOrderBuilder<SortOrder.Builder>

Parameters:

sortCaseSensitive - when true, column name resolution is case-sensitive

Returns:

this for method chaining

build

public SortOrder build()