Package io.keikai.axyra.sheets

Enum Class TotalsRowFunction

java.lang.Object
java.lang.Enum<TotalsRowFunction>
io.keikai.axyra.sheets.TotalsRowFunction
All Implemented Interfaces:
Serializable, Comparable<TotalsRowFunction>, Constable
public enum TotalsRowFunction extends Enum<TotalsRowFunction>
Table totals-row aggregation (ECMA-376 §18.18.92 ST_TotalsRowFunction). The built-in kinds map to the SUBTOTAL(101..110, …) formulas Excel writes into the totals-row cell; CUSTOM carries an explicit formula.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AVERAGE
    SUBTOTAL(101, column): mean of the visible values.
    COUNT
    SUBTOTAL(103, column): COUNTA, the number of non-empty visible cells.
    COUNT_NUMS
    SUBTOTAL(102, column): COUNT, the number of numeric visible cells.
    CUSTOM
    The caller's own formula, written unchanged into the totals-row cell.
    MAX
    SUBTOTAL(104, column): largest visible value.
    MIN
    SUBTOTAL(105, column): smallest visible value.
    NONE
    No total; the totals-row cell holds no formula.
    STD_DEV
    SUBTOTAL(107, column): sample standard deviation of the visible values.
    SUM
    SUBTOTAL(109, column): sum of the visible values.
    VAR
    SUBTOTAL(110, column): sample variance of the visible values.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    code()
    Returns the ECMA-376 token for this function, e.g.
    static TotalsRowFunction
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TotalsRowFunction[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final TotalsRowFunction NONE
      No total; the totals-row cell holds no formula.

    • SUM

      public static final TotalsRowFunction SUM
      SUBTOTAL(109, column): sum of the visible values.

    • MIN

      public static final TotalsRowFunction MIN
      SUBTOTAL(105, column): smallest visible value.

    • MAX

      public static final TotalsRowFunction MAX
      SUBTOTAL(104, column): largest visible value.

    • AVERAGE

      public static final TotalsRowFunction AVERAGE
      SUBTOTAL(101, column): mean of the visible values.

    • COUNT

      public static final TotalsRowFunction COUNT
      SUBTOTAL(103, column): COUNTA, the number of non-empty visible cells.

    • COUNT_NUMS

      public static final TotalsRowFunction COUNT_NUMS
      SUBTOTAL(102, column): COUNT, the number of numeric visible cells.

    • STD_DEV

      public static final TotalsRowFunction STD_DEV
      SUBTOTAL(107, column): sample standard deviation of the visible values.

    • VAR

      public static final TotalsRowFunction VAR
      SUBTOTAL(110, column): sample variance of the visible values.

    • CUSTOM

      public static final TotalsRowFunction CUSTOM
      The caller's own formula, written unchanged into the totals-row cell.

  • Method Details

    • values

      public static TotalsRowFunction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TotalsRowFunction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • code

      public String code()
      Returns the ECMA-376 token for this function, e.g. "sum".