Package io.keikai.axyra.sheets

Record Class PivotValueFilter

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.PivotValueFilter
Record Components:
dataField - 0-based position of the values-area field supplying the aggregates
type - the comparison
value1 - the threshold (the lower bound for PivotValueFilterType.BETWEEN)
value2 - the upper bound for PivotValueFilterType.BETWEEN; 0 otherwise
public record PivotValueFilter(int dataField, PivotValueFilterType type, double value1, double value2) extends Record
A value filter on a pivot row/column field, read back via PivotTableView.valueFilter(String).

  • Constructor Details

    • PivotValueFilter

      public PivotValueFilter(int dataField, PivotValueFilterType type, double value1, double value2)
      Creates an instance of a PivotValueFilter record class.
      Parameters:
      dataField - the value for the dataField record component
      type - the value for the type record component
      value1 - the value for the value1 record component
      value2 - the value for the value2 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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

    • type

      public PivotValueFilterType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • value1

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

    • value2

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