Enum Measure.Aggregator

java.lang.Object
java.lang.Enum<Measure.Aggregator>
org.olap4j.metadata.Measure.Aggregator
All Implemented Interfaces:
Serializable, Comparable<Measure.Aggregator>, Constable, XmlaConstant
Enclosing interface:
Measure

public static enum Measure.Aggregator extends Enum<Measure.Aggregator> implements XmlaConstant
Enumeration of the aggregate functions which can be used to derive a Measure.

The values are as specified by XMLA. For example, XMLA specifies MDMEASURE_AGGR_SUM with ordinal 1, which corresponds to the value SUM, whose xmlaOrdinal is 1.

  • Enum Constant Details

    • SUM

      public static final Measure.Aggregator SUM
      Identifies that the measure was derived using the SUM aggregation function.
    • COUNT

      public static final Measure.Aggregator COUNT
      Identifies that the measure was derived using the COUNT aggregation function.
    • MIN

      public static final Measure.Aggregator MIN
      Identifies that the measure was derived using the MIN aggregation function.
    • MAX

      public static final Measure.Aggregator MAX
      Identifies that the measure was derived using the MAX aggregation function.
    • AVG

      public static final Measure.Aggregator AVG
      Identifies that the measure was derived using the AVG aggregation function.
    • VAR

      public static final Measure.Aggregator VAR
      Identifies that the measure was derived using the VAR aggregation function.
    • STD

      public static final Measure.Aggregator STD
      Identifies that the measure was derived using the STDEV aggregation function.
    • CALCULATED

      public static final Measure.Aggregator CALCULATED
      Identifies that the measure was derived from a formula that was not any single function above.
    • UNKNOWN

      public static final Measure.Aggregator UNKNOWN
      Identifies that the measure was derived from an unknown aggregation function or formula.
  • Method Details

    • values

      public static Measure.Aggregator[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Measure.Aggregator valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null
    • xmlaName

      public String xmlaName()
      Description copied from interface: XmlaConstant
      Returns the name of this constant as specified by XMLA.

      Often the name is an enumeration-specific prefix plus the name of the Java enum constant. For example, Dimension.Type has prefix "MD_DIMTYPE_", and therefore this method returns "MD_DIMTYPE_PRODUCTS" for the enum constant Dimension.Type.PRODUCTS.

      Specified by:
      xmlaName in interface XmlaConstant
      Returns:
      ordinal code as specified by XMLA.
    • getDescription

      public String getDescription()
      Description copied from interface: XmlaConstant
      Returns the description of this constant.
      Specified by:
      getDescription in interface XmlaConstant
      Returns:
      Description of this constant.
    • xmlaOrdinal

      public int xmlaOrdinal()
      Description copied from interface: XmlaConstant
      Returns the code of this constant as specified by XMLA.

      For example, the XMLA specification says that the ordinal of MD_DIMTYPE_PRODUCTS is 8, and therefore this method returns 8 for Dimension.Type.PRODUCTS.

      Specified by:
      xmlaOrdinal in interface XmlaConstant
      Returns:
      ordinal code as specified by XMLA.
    • getDictionary

      public static XmlaConstant.Dictionary<Measure.Aggregator> getDictionary()
      Per XmlaConstant, returns a dictionary of all values of this enumeration.
      Returns:
      Dictionary of all values