Package io.keikai.axyra.sheets

Record Class PivotTopNFilter

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.PivotTopNFilter
Record Components:
dataField - 0-based values-area position supplying the aggregates
value - N in count mode; in percent mode the percent of the total, 0 to 100 (10 means 10 %)
byPercent - percent mode vs item count
bottom - keep the bottom instead of the top
public record PivotTopNFilter(int dataField, double value, boolean byPercent, boolean bottom) extends Record
The Top-N ("Top 10") filter of a pivot row/column field, read back via PivotTableView.topNFilter(String): items rank by their aggregate of a values-area entry and only the top (or bottom) value items / percent survive a refresh.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PivotTopNFilter(int dataField, double value, boolean byPercent, boolean bottom)
    Creates an instance of a PivotTopNFilter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    bottom()
    Returns the value of the bottom record component.
    boolean
    byPercent()
    Returns the value of the byPercent record component.
    int
    dataField()
    Returns the value of the dataField 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.
    double
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PivotTopNFilter

      public PivotTopNFilter(int dataField, double value, boolean byPercent, boolean bottom)
      Creates an instance of a PivotTopNFilter record class.
      Parameters:
      dataField - the value for the dataField record component
      value - the value for the value record component
      byPercent - the value for the byPercent record component
      bottom - the value for the bottom record component

  • Method Details

    • 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.

    • dataField

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

    • value

      public double value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • byPercent

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

    • bottom

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