Package io.keikai.axyra.sheets

Record Class PivotFieldSort

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.PivotFieldSort
Record Components:
ascending - true for ascending order, false for descending
byValueDataField - 0-based values-area position driving a by-value sort, or -1 for a label sort; it may point past the current values area when the sort was declared before the data fields were added
public record PivotFieldSort(boolean ascending, int byValueDataField) extends Record
The declared sort of a pivot row/column field, read back via PivotTableView.fieldSort(String).

  • Constructor Summary

    Constructors
    Constructor
    Description
    PivotFieldSort(boolean ascending, int byValueDataField)
    Creates an instance of a PivotFieldSort record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    ascending()
    Returns the value of the ascending record component.
    boolean
    byValue()
    Whether items sort by a data field's aggregate (vs.
    int
    byValueDataField()
    Returns the value of the byValueDataField record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PivotFieldSort

      public PivotFieldSort(boolean ascending, int byValueDataField)
      Creates an instance of a PivotFieldSort record class.
      Parameters:
      ascending - the value for the ascending record component
      byValueDataField - the value for the byValueDataField record component

  • Method Details

    • byValue

      public boolean byValue()
      Whether items sort by a data field's aggregate (vs. by label).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • ascending

      public boolean ascending()
      Returns the value of the ascending record component.
      Returns:
      the value of the ascending record component

    • byValueDataField

      public int byValueDataField()
      Returns the value of the byValueDataField record component.
      Returns:
      the value of the byValueDataField record component