SortField

java.lang.Object

org.apache.iceberg.SortField

All Implemented Interfaces:: Serializable

public class SortField extends Object implements Serializable

A field in a SortOrder.

See Also:

Serialized Form

Method Summary

Modifier and Type

Method

Description

SortDirection

direction()

Returns the sort direction

boolean

equals(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

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 Details
- 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 String toString()
  
  Overrides:
  
  toString in class Object
- equals
  
  public boolean equals(Object other)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object