Package org.olap4j.metadata
Enum Measure.Aggregator
- All Implemented Interfaces:
Serializable
,Comparable<Measure.Aggregator>
,Constable
,XmlaConstant
- Enclosing interface:
- Measure
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIdentifies that the measure was derived using the AVG aggregation function.Identifies that the measure was derived from a formula that was not any single function above.Identifies that the measure was derived using the COUNT aggregation function.Identifies that the measure was derived using the MAX aggregation function.Identifies that the measure was derived using the MIN aggregation function.Identifies that the measure was derived using the STDEV aggregation function.Identifies that the measure was derived using the SUM aggregation function.Identifies that the measure was derived from an unknown aggregation function or formula.Identifies that the measure was derived using the VAR aggregation function. -
Method Summary
Modifier and TypeMethodDescriptionReturns the description of this constant.PerXmlaConstant
, returns a dictionary of all values of this enumeration.static Measure.Aggregator
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.xmlaName()
Returns the name of this constant as specified by XMLA.int
Returns the code of this constant as specified by XMLA.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
SUM
Identifies that the measure was derived using the SUM aggregation function. -
COUNT
Identifies that the measure was derived using the COUNT aggregation function. -
MIN
Identifies that the measure was derived using the MIN aggregation function. -
MAX
Identifies that the measure was derived using the MAX aggregation function. -
AVG
Identifies that the measure was derived using the AVG aggregation function. -
VAR
Identifies that the measure was derived using the VAR aggregation function. -
STD
Identifies that the measure was derived using the STDEV aggregation function. -
CALCULATED
Identifies that the measure was derived from a formula that was not any single function above. -
UNKNOWN
Identifies that the measure was derived from an unknown aggregation function or formula.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
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 constantDimension.Type.PRODUCTS
.- Specified by:
xmlaName
in interfaceXmlaConstant
- Returns:
- ordinal code as specified by XMLA.
-
getDescription
Description copied from interface:XmlaConstant
Returns the description of this constant.- Specified by:
getDescription
in interfaceXmlaConstant
- 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 interfaceXmlaConstant
- Returns:
- ordinal code as specified by XMLA.
-
getDictionary
PerXmlaConstant
, returns a dictionary of all values of this enumeration.- Returns:
- Dictionary of all values
-