Package net.pricefx.common.api.chart

Enum Class AggregationFormula

Object
Enum<AggregationFormula>
AggregationFormula
All Implemented Interfaces:
Serializable, Comparable<AggregationFormula>, Constable
public enum AggregationFormula extends Enum<AggregationFormula>
The aggregation formula applied to a chart series' measure or additional measure, set with AbstractChartMeasures.withAggregation(AggregationFormula) or an equivalent withAggregation method on a concrete series or axis type. The withPercent, withPerUnit, withAverage, and withTotal shortcut methods cover the most common of these constants without passing the enum directly. Corresponds to the options in the Data Analyzer UI's Aggregation dropdown.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AVERAGE
    Averages the measure's values across the group, the "Average" aggregation option.
    CONTRIB
    Shows each row's share of the total, the "Contribution" aggregation option.
    COUNT
    Counts the number of rows in the group, the "Count" aggregation option.
    COUNTDISTINCT
    Counts the number of distinct values in the group, the "Count Distinct" aggregation option.
    CUMCONTRIB
    Runs a cumulative sum of each row's contribution, the "Cumulative Contribution" aggregation option.
    CUMSUM
    Runs a cumulative sum across the series, the "Cumulative Sum" aggregation option.
    FORMULA
    Computes the value from a named Pricing Formula rather than aggregating a Datamart field.
    FUNCTION
    Computes the value from a Datamart function rather than a fixed aggregation formula, the "Function" aggregation option.
    INDEX
    Shows each row's value relative to a base value, the "Index" aggregation option.
    MORE
    The catch-all option used when the measure or axis is computed from something other than a fixed aggregation formula, for example a Datamart Expression set via AggrFieldAxis.withExpression(); the "Editor…" aggregation option in the Data Analyzer UI.
    PERCENT
    Shows each row's value as a percentage of the group total, the "Percent" aggregation option.
    PERUNIT
    Divides the measure's total by a unit quantity, the "Per Unit" aggregation option.
    PERUNIT_INDEX
    Combines PERUNIT and INDEX, the "Per-Unit Index" aggregation option.
    SUM
    Sums the measure's values across the group, the "Sum" aggregation option.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AggregationFormula
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static AggregationFormula[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SUM

      public static final AggregationFormula SUM
      Sums the measure's values across the group, the "Sum" aggregation option. Equivalent to the withTotal() shortcut.

    • PERUNIT

      public static final AggregationFormula PERUNIT
      Divides the measure's total by a unit quantity, the "Per Unit" aggregation option.

    • AVERAGE

      public static final AggregationFormula AVERAGE
      Averages the measure's values across the group, the "Average" aggregation option.

    • PERCENT

      public static final AggregationFormula PERCENT
      Shows each row's value as a percentage of the group total, the "Percent" aggregation option.

    • INDEX

      public static final AggregationFormula INDEX
      Shows each row's value relative to a base value, the "Index" aggregation option.

    • PERUNIT_INDEX

      public static final AggregationFormula PERUNIT_INDEX
      Combines PERUNIT and INDEX, the "Per-Unit Index" aggregation option.

    • CUMSUM

      public static final AggregationFormula CUMSUM
      Runs a cumulative sum across the series, the "Cumulative Sum" aggregation option.

    • CONTRIB

      public static final AggregationFormula CONTRIB
      Shows each row's share of the total, the "Contribution" aggregation option.

    • CUMCONTRIB

      public static final AggregationFormula CUMCONTRIB
      Runs a cumulative sum of each row's contribution, the "Cumulative Contribution" aggregation option.

    • COUNT

      public static final AggregationFormula COUNT
      Counts the number of rows in the group, the "Count" aggregation option.

    • COUNTDISTINCT

      public static final AggregationFormula COUNTDISTINCT
      Counts the number of distinct values in the group, the "Count Distinct" aggregation option.

    • FORMULA

      public static final AggregationFormula FORMULA
      Computes the value from a named Pricing Formula rather than aggregating a Datamart field. Set via withFormula() on the axis or measure, which only marks the aggregation as FORMULA; the formula itself must be selected separately with AbstractChartSeries.setFormula() and Formula.setFormulaName(String) on the series.

    • FUNCTION

      public static final AggregationFormula FUNCTION
      Computes the value from a Datamart function rather than a fixed aggregation formula, the "Function" aggregation option.

    • MORE

      public static final AggregationFormula MORE
      The catch-all option used when the measure or axis is computed from something other than a fixed aggregation formula, for example a Datamart Expression set via AggrFieldAxis.withExpression(); the "Editor…" aggregation option in the Data Analyzer UI.

  • Method Details

    • values

      public static AggregationFormula[] 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 AggregationFormula 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