Enum Dimension.Type

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCOUNTS
      Corresponds to the XMLA constant MD_DIMTYPE_ACCOUNTS(6).
      BILL_OF_MATERIALS
      Corresponds to the XMLA constant MD_DIMTYPE_BILL_OF_MATERIALS(16).
      CHANNEL
      Corresponds to the XMLA constant MD_DIMTYPE_CHANNEL(13).
      CURRENCY
      Corresponds to the XMLA constant MD_DIMTYPE_CURRENCY(11).
      CUSTOMERS
      Corresponds to the XMLA constant MD_DIMTYPE_CUSTOMERS(7).
      GEOGRAPHY
      Corresponds to the XMLA constant MD_DIMTYPE_GEOGRAPHY(17).
      MEASURE
      Indicates that a dimension is the Measures dimension.
      ORGANIZATION
      Corresponds to the XMLA constant MD_DIMTYPE_ORGANIZATION(15).
      OTHER
      Corresponds to the XMLA constant MD_DIMTYPE_OTHER(3).
      PRODUCTS
      Corresponds to the XMLA constant MD_DIMTYPE_PRODUCTS(8).
      PROMOTION
      Corresponds to the XMLA constant MD_DIMTYPE_PROMOTION(14).
      QUANTITATIVE
      Corresponds to the XMLA constant MD_DIMTYPE_QUANTITATIVE(5).
      RATES
      Corresponds to the XMLA constant MD_DIMTYPE_RATES(12).
      SCENARIO
      Corresponds to the XMLA constant MD_DIMTYPE_SCENARIO(9).
      TIME
      Indicates that a dimension is a time dimension.
      UNKNOWN
      Indicates that the dimension is not related to time.
      UTILITY
      Corresponds to the XMLA constant MD_DIMTYPE_UTILIY(10) (sic).
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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​(java.lang.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.
      java.lang.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.

        Corresponds to the XMLA constant MD_DIMTYPE_UNKNOWN(0).

      • TIME

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

        Corresponds to the XMLA constant MD_DIMTYPE_TIME(1).

      • MEASURE

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

        Corresponds to the XMLA constant MD_DIMTYPE_MEASURE(2).

      • OTHER

        public static final Dimension.Type OTHER
        Corresponds to the XMLA constant MD_DIMTYPE_OTHER(3).
      • QUANTITATIVE

        public static final Dimension.Type QUANTITATIVE
        Corresponds to the XMLA constant MD_DIMTYPE_QUANTITATIVE(5).
      • ACCOUNTS

        public static final Dimension.Type ACCOUNTS
        Corresponds to the XMLA constant MD_DIMTYPE_ACCOUNTS(6).
      • CUSTOMERS

        public static final Dimension.Type CUSTOMERS
        Corresponds to the XMLA constant MD_DIMTYPE_CUSTOMERS(7).
      • PRODUCTS

        public static final Dimension.Type PRODUCTS
        Corresponds to the XMLA constant MD_DIMTYPE_PRODUCTS(8).
      • SCENARIO

        public static final Dimension.Type SCENARIO
        Corresponds to the XMLA constant MD_DIMTYPE_SCENARIO(9).
      • UTILITY

        public static final Dimension.Type UTILITY
        Corresponds to the XMLA constant MD_DIMTYPE_UTILIY(10) (sic).
      • CURRENCY

        public static final Dimension.Type CURRENCY
        Corresponds to the XMLA constant MD_DIMTYPE_CURRENCY(11).
      • RATES

        public static final Dimension.Type RATES
        Corresponds to the XMLA constant MD_DIMTYPE_RATES(12).
      • CHANNEL

        public static final Dimension.Type CHANNEL
        Corresponds to the XMLA constant MD_DIMTYPE_CHANNEL(13).
      • PROMOTION

        public static final Dimension.Type PROMOTION
        Corresponds to the XMLA constant MD_DIMTYPE_PROMOTION(14).
      • ORGANIZATION

        public static final Dimension.Type ORGANIZATION
        Corresponds to the XMLA constant MD_DIMTYPE_ORGANIZATION(15).
      • BILL_OF_MATERIALS

        public static final Dimension.Type BILL_OF_MATERIALS
        Corresponds to the XMLA constant MD_DIMTYPE_BILL_OF_MATERIALS(16).
      • GEOGRAPHY

        public static final Dimension.Type GEOGRAPHY
        Corresponds to the XMLA constant MD_DIMTYPE_GEOGRAPHY(17).
    • 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​(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
      • xmlaName

        public java.lang.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 java.lang.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.