Package 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 aSortOrder
.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SortDirection
direction()
Returns the sort directionboolean
equals(java.lang.Object other)
int
hashCode()
NullOrder
nullOrder()
Returns the null orderboolean
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 thesort order's
table schemajava.lang.String
toString()
<S,T>
Transform<S,T>transform()
Returns the transform used to produce sort values from source values.
-
-
-
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 functionT
- 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 thesort 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 classjava.lang.Object
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-