org.apache.iceberg

Class SortField

java.lang.Object

org.apache.iceberg.SortField

All Implemented Interfaces:

java.io.Serializable

public class SortField
extends java.lang.Object
implements java.io.Serializable

A field in a SortOrder.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
SortDirection	direction() Returns the sort direction
boolean	equals(java.lang.Object other)
int	hashCode()
NullOrder	nullOrder() Returns the null order
boolean	satisfies(SortField other) Checks whether this field's order satisfies another field's order.
int	sourceId() Returns the field id of the source field in the sort order's table schema
java.lang.String	toString()
<S,T> Transform<S,T>	transform() Returns the transform used to produce sort values from source values.

Methods inherited from class java.lang.Object

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

Method Detail

transform

public <S,T> Transform<S,T> transform()

Returns the transform used to produce sort values from source values.

Type Parameters:

S - the Java type of values transformed by the transform function

T - the Java type of values returned by the transform function

Returns:

the transform

sourceId

public int sourceId()

Returns the field id of the source field in the sort order's table schema

direction

public SortDirection direction()

Returns the sort direction

nullOrder

public NullOrder nullOrder()

Returns the null order

satisfies

public boolean satisfies(SortField other)

Checks whether this field's order satisfies another field's order.

Parameters:

other - another sort field

Returns:

true if this order satisfies the given order

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object