Package io.keikai.axyra.sheets

Record Class PivotFieldGroup

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.PivotFieldGroup
Record Components:
dateBy - the date component, or null for a numeric grouping
start - the numeric range start (0 for date groupings)
end - the numeric range end (0 for date groupings)
interval - the numeric bin width (0 for date groupings)
public record PivotFieldGroup(PivotDateGroupBy dateBy, double start, double end, double interval) extends Record
The grouping of a pivot row/column field, read back via PivotTableView.fieldGroup(String): either a date-component grouping (dateBy() non-null) or numeric range bins.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PivotFieldGroup(PivotDateGroupBy dateBy, double start, double end, double interval)
    Creates an instance of a PivotFieldGroup record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    PivotDateGroupBy
    dateBy()
    Returns the value of the dateBy record component.
    double
    end()
    Returns the value of the end 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.
    double
    interval()
    Returns the value of the interval record component.
    boolean
    isDate()
    Whether this is a date-component grouping (vs numeric bins).
    double
    start()
    Returns the value of the start record component.
    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

    • PivotFieldGroup

      public PivotFieldGroup(PivotDateGroupBy dateBy, double start, double end, double interval)
      Creates an instance of a PivotFieldGroup record class.
      Parameters:
      dateBy - the value for the dateBy record component
      start - the value for the start record component
      end - the value for the end record component
      interval - the value for the interval record component

  • Method Details

    • isDate

      public boolean isDate()
      Whether this is a date-component grouping (vs numeric bins).

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

    • dateBy

      public PivotDateGroupBy dateBy()
      Returns the value of the dateBy record component.
      Returns:
      the value of the dateBy record component

    • start

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

    • end

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

    • interval

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