Package org.apache.iceberg

Class FieldMetrics<T>

java.lang.Object
org.apache.iceberg.FieldMetrics<T>
Direct Known Subclasses:
DoubleFieldMetrics, FloatFieldMetrics
public class FieldMetrics<T> extends Object
Iceberg internally tracked field level metrics.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldMetrics(int id, long valueCount, long nullValueCount)
     
    FieldMetrics(int id, long valueCount, long nullValueCount, long nanValueCount)
     
    FieldMetrics(int id, long valueCount, long nullValueCount, long nanValueCount, T lowerBound, T upperBound)
     
    FieldMetrics(int id, long valueCount, long nullValueCount, long nanValueCount, T lowerBound, T upperBound, Type originalType)
     
    FieldMetrics(int id, long valueCount, long nullValueCount, T lowerBound, T upperBound)
     
    FieldMetrics(int id, long valueCount, long nullValueCount, T lowerBound, T upperBound, Type originalType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    hasBounds()
    Returns if the metrics has bounds (i.e.
    int
    id()
    Returns the id of the field that the metrics within this class are associated with.
    T
    lowerBound()
    Returns the lower bound value of this field.
    long
    nanValueCount()
    Returns the number of NaN values for this field.
    long
    nullValueCount()
    Returns the number of null values for this field.
    Type
    originalType()
    Returns the original type of the upper/lower bound value of this field.
    T
    upperBound()
    Returns the upper bound value of this field.
    long
    valueCount()
    Returns the number of all values, including nulls, NaN and repeated, for the given field.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FieldMetrics

      public FieldMetrics(int id, long valueCount, long nullValueCount)

    • FieldMetrics

      public FieldMetrics(int id, long valueCount, long nullValueCount, T lowerBound, T upperBound)

    • FieldMetrics

      public FieldMetrics(int id, long valueCount, long nullValueCount, long nanValueCount)

    • FieldMetrics

      public FieldMetrics(int id, long valueCount, long nullValueCount, T lowerBound, T upperBound, Type originalType)

    • FieldMetrics

      public FieldMetrics(int id, long valueCount, long nullValueCount, long nanValueCount, T lowerBound, T upperBound)

    • FieldMetrics

      public FieldMetrics(int id, long valueCount, long nullValueCount, long nanValueCount, T lowerBound, T upperBound, Type originalType)

  • Method Details

    • id

      public int id()
      Returns the id of the field that the metrics within this class are associated with.

    • valueCount

      public long valueCount()
      Returns the number of all values, including nulls, NaN and repeated, for the given field.

    • nullValueCount

      public long nullValueCount()
      Returns the number of null values for this field.

    • nanValueCount

      public long nanValueCount()
      Returns the number of NaN values for this field. Will only be non-0 if this field is a double or float field.

    • lowerBound

      public T lowerBound()
      Returns the lower bound value of this field.

    • upperBound

      public T upperBound()
      Returns the upper bound value of this field.

    • originalType

      public Type originalType()
      Returns the original type of the upper/lower bound value of this field.

    • hasBounds

      public boolean hasBounds()
      Returns if the metrics has bounds (i.e. there is at least non-null value for this field)