iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
iceberg::SortField Class Reference

a field with its transform. More...

#include <sort_field.h>

Inheritance diagram for iceberg::SortField:
iceberg::util::Formattable

Public Member Functions

 SortField (int32_t source_id, std::shared_ptr< Transform > transform, SortDirection direction, NullOrder null_order)
 Construct a field.
 
int32_t source_id () const
 Get the source field ID.
 
const std::shared_ptr< Transform > & transform () const
 Get the transform type.
 
SortDirection direction () const
 Get the sort direction.
 
NullOrder null_order () const
 Get the null order.
 
bool Satisfies (const SortField &other) const
 Checks whether this field's order satisfies another field's order.
 
std::string ToString () const override
 Get a user-readable string representation.
 

Friends

bool operator== (const SortField &lhs, const SortField &rhs)
 

Detailed Description

a field with its transform.

Constructor & Destructor Documentation

◆ SortField()

iceberg::SortField::SortField ( int32_t  source_id,
std::shared_ptr< Transform transform,
SortDirection  direction,
NullOrder  null_order 
)

Construct a field.

Parameters
[in]source_idThe source field ID.
[in]transformThe transform function.
[in]directionThe sort direction.
[in]null_orderThe null order.

Member Function Documentation

◆ ToString()

std::string iceberg::SortField::ToString ( ) const
overridevirtual

Get a user-readable string representation.

Implements iceberg::util::Formattable.


The documentation for this class was generated from the following files: