org.olap4j.metadata
Enum Dimension.Type

java.lang.Object
  extended by java.lang.Enum<Dimension.Type>
      extended by org.olap4j.metadata.Dimension.Type
All Implemented Interfaces:
Serializable, Comparable<Dimension.Type>, XmlaConstant
Enclosing interface:
Dimension

public static enum Dimension.Type
extends Enum<Dimension.Type>
implements XmlaConstant

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:
Level.Type, Member.Type, Dimension.getDimensionType()

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant>
 
Enum Constant Summary
ACCOUNTS
           
BILL_OF_MATERIALS
           
CHANNEL
           
CURRENCY
           
CUSTOMERS
           
GEOGRAPHY
           
MEASURE
          Indicates that a dimension is the Measures dimension.
ORGANIZATION
           
OTHER
           
PRODUCTS
           
PROMOTION
           
QUANTITATIVE
           
RATES
           
SCENARIO
           
TIME
          Indicates that a dimension is a time dimension.
UNKNOWN
          Indicates that the dimension is not related to time.
UTILITY
           
 
Method Summary
 String getDescription()
          Returns the description of this constant.
static XmlaConstant.Dictionary<Dimension.Type> getDictionary()
          Per XmlaConstant, returns a dictionary of all values of this enumeration.
static Dimension.Type valueOf(String name)
          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.
 String xmlaName()
          Returns the name of this constant as specified by XMLA.
 int xmlaOrdinal()
          Returns the code of this constant 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

UNKNOWN

public static final Dimension.Type UNKNOWN
Indicates that the dimension is not related to time.


TIME

public static final Dimension.Type TIME
Indicates that a dimension is a time dimension.


MEASURE

public static final Dimension.Type MEASURE
Indicates that a dimension is the Measures dimension.


OTHER

public static final Dimension.Type OTHER

QUANTITATIVE

public static final Dimension.Type QUANTITATIVE

ACCOUNTS

public static final Dimension.Type ACCOUNTS

CUSTOMERS

public static final Dimension.Type CUSTOMERS

PRODUCTS

public static final Dimension.Type PRODUCTS

SCENARIO

public static final Dimension.Type SCENARIO

UTILITY

public static final Dimension.Type UTILITY

CURRENCY

public static final Dimension.Type CURRENCY

RATES

public static final Dimension.Type RATES

CHANNEL

public static final Dimension.Type CHANNEL

PROMOTION

public static final Dimension.Type PROMOTION

ORGANIZATION

public static final Dimension.Type ORGANIZATION

BILL_OF_MATERIALS

public static final Dimension.Type BILL_OF_MATERIALS

GEOGRAPHY

public static final Dimension.Type GEOGRAPHY
Method Detail

values

public static Dimension.Type[] 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 (Dimension.Type c : Dimension.Type.values())
    System.out.println(c);

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

valueOf

public static Dimension.Type 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

getDictionary

public static XmlaConstant.Dictionary<Dimension.Type> getDictionary()
Per XmlaConstant, returns a dictionary of all values of this enumeration.

Returns:
Dictionary of all values

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 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 PRODUCTS.

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

SourceForge.net_Logo