Package io.keikai.axyra.sheets

Record Class PivotCalculatedField

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.PivotCalculatedField
Record Components:
name - the field name, addressable by PivotTableView.addDataField(String, AggregateFunction)
formula - the stored formula in =-prefixed form (e.g. "=Sales/Units")
public record PivotCalculatedField(String name, String formula) extends Record
A pivot calculated-field definition: a virtual source column computed from a formula over the other source columns (ECMA-376 Part 1 §18.10.1.13 cacheField@formula). Obtained from PivotTableView.calculatedFields(); defined with PivotTableView.addCalculatedField(String, String).

  • Constructor Details

    • PivotCalculatedField

      public PivotCalculatedField(String name, String formula)
      Creates an instance of a PivotCalculatedField record class.
      Parameters:
      name - the value for the name record component
      formula - the value for the formula 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 Objects::equals(Object,Object).
      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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • formula

      public String formula()
      Returns the value of the formula record component.
      Returns:
      the value of the formula record component