org.olap4j.metadata
Enum Measure.Aggregator

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

public static enum Measure.Aggregator
extends java.lang.Enum<Measure.Aggregator>

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 Summary
AVG
          Identifies that the measure was derived using the AVG aggregation function.
CALCULATED
          Identifies that the measure was derived from a formula that was not any single function above.
COUNT
          Identifies that the measure was derived using the COUNT aggregation function.
MAX
          Identifies that the measure was derived using the MAX aggregation function.
MIN
          Identifies that the measure was derived using the MIN aggregation function.
STD
          Identifies that the measure was derived using the STDEV aggregation function.
SUM
          Identifies that the measure was derived using the SUM aggregation function.
UNKNOWN
          Identifies that the measure was derived from an unknown aggregation function or formula.
VAR
          Identifies that the measure was derived using the VAR aggregation function.
 
Method Summary
static Measure.Aggregator forXmlaOrdinal(int xmlaOrdinal)
          Looks up an Aggregator by its XMLA ordinal.
static Measure.Aggregator valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Measure.Aggregator[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 int xmlaOrdinal()
          Returns the ordinal code as specified by XMLA.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

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 Detail

values

public static Measure.Aggregator[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Measure.Aggregator c : Measure.Aggregator.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Measure.Aggregator valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

xmlaOrdinal

public final int xmlaOrdinal()
Returns the ordinal code as specified by XMLA.

For example, the XMLA specification says that the ordinal of CALCULATED is 127.

Returns:
ordinal code as specified by XMLA.

forXmlaOrdinal

public static Measure.Aggregator forXmlaOrdinal(int xmlaOrdinal)
Looks up an Aggregator by its XMLA ordinal.

Parameters:
xmlaOrdinal - Ordinal of an Aggregator according to the XMLA specification.
Returns:
Aggregator with the given ordinal, or null if there is no such Aggregator

SourceForge.net_Logo