Package org.olap4j.metadata
Enum Dimension.Type
- All Implemented Interfaces:
Serializable
,Comparable<Dimension.Type>
,Constable
,XmlaConstant
- Enclosing interface:
Dimension
Enumeration of the types of a
Dimension
.
Some of the values are as specified by XMLA.
For example, XMLA specifies MD_DIMTYPE_PRODUCTS with ordinal 8,
which corresponds to the value PRODUCTS
,
whose xmlaOrdinal
is 8.
- See Also:
-
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 ConstantDescriptionCorresponds to the XMLA constantMD_DIMTYPE_ACCOUNTS(6)
.Corresponds to the XMLA constantMD_DIMTYPE_BILL_OF_MATERIALS(16)
.Corresponds to the XMLA constantMD_DIMTYPE_CHANNEL(13)
.Corresponds to the XMLA constantMD_DIMTYPE_CURRENCY(11)
.Corresponds to the XMLA constantMD_DIMTYPE_CUSTOMERS(7)
.Corresponds to the XMLA constantMD_DIMTYPE_GEOGRAPHY(17)
.Indicates that a dimension is the Measures dimension.Corresponds to the XMLA constantMD_DIMTYPE_ORGANIZATION(15)
.Corresponds to the XMLA constantMD_DIMTYPE_OTHER(3)
.Corresponds to the XMLA constantMD_DIMTYPE_PRODUCTS(8)
.Corresponds to the XMLA constantMD_DIMTYPE_PROMOTION(14)
.Corresponds to the XMLA constantMD_DIMTYPE_QUANTITATIVE(5)
.Corresponds to the XMLA constantMD_DIMTYPE_RATES(12)
.Corresponds to the XMLA constantMD_DIMTYPE_SCENARIO(9)
.Indicates that a dimension is a time dimension.Indicates that the dimension is not related to time.Corresponds to the XMLA constantMD_DIMTYPE_UTILIY(10)
(sic). -
Method Summary
Modifier and TypeMethodDescriptionReturns the description of this constant.PerXmlaConstant
, returns a dictionary of all values of this enumeration.static Dimension.Type
Returns the enum constant of this type with the specified name.static Dimension.Type[]
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
-
UNKNOWN
Indicates that the dimension is not related to time.Corresponds to the XMLA constant
MD_DIMTYPE_UNKNOWN(0)
. -
TIME
Indicates that a dimension is a time dimension.Corresponds to the XMLA constant
MD_DIMTYPE_TIME(1)
. -
MEASURE
Indicates that a dimension is the Measures dimension.Corresponds to the XMLA constant
MD_DIMTYPE_MEASURE(2)
. -
OTHER
Corresponds to the XMLA constantMD_DIMTYPE_OTHER(3)
. -
QUANTITATIVE
Corresponds to the XMLA constantMD_DIMTYPE_QUANTITATIVE(5)
. -
ACCOUNTS
Corresponds to the XMLA constantMD_DIMTYPE_ACCOUNTS(6)
. -
CUSTOMERS
Corresponds to the XMLA constantMD_DIMTYPE_CUSTOMERS(7)
. -
PRODUCTS
Corresponds to the XMLA constantMD_DIMTYPE_PRODUCTS(8)
. -
SCENARIO
Corresponds to the XMLA constantMD_DIMTYPE_SCENARIO(9)
. -
UTILITY
Corresponds to the XMLA constantMD_DIMTYPE_UTILIY(10)
(sic). -
CURRENCY
Corresponds to the XMLA constantMD_DIMTYPE_CURRENCY(11)
. -
RATES
Corresponds to the XMLA constantMD_DIMTYPE_RATES(12)
. -
CHANNEL
Corresponds to the XMLA constantMD_DIMTYPE_CHANNEL(13)
. -
PROMOTION
Corresponds to the XMLA constantMD_DIMTYPE_PROMOTION(14)
. -
ORGANIZATION
Corresponds to the XMLA constantMD_DIMTYPE_ORGANIZATION(15)
. -
BILL_OF_MATERIALS
Corresponds to the XMLA constantMD_DIMTYPE_BILL_OF_MATERIALS(16)
. -
GEOGRAPHY
Corresponds to the XMLA constantMD_DIMTYPE_GEOGRAPHY(17)
.
-
-
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
-
getDictionary
PerXmlaConstant
, returns a dictionary of all values of this enumeration.- Returns:
- Dictionary of all values
-
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 constantPRODUCTS
.- 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
PRODUCTS
.- Specified by:
xmlaOrdinal
in interfaceXmlaConstant
- Returns:
- ordinal code as specified by XMLA.
-