Enum XmlaConstants.CoordinateType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<XmlaConstants.CoordinateType>, XmlaConstant
    Enclosing class:
    XmlaConstants

    public static enum XmlaConstants.CoordinateType
    extends java.lang.Enum<XmlaConstants.CoordinateType>
    implements XmlaConstant
    How the COORDINATE restriction column is interpreted.

    Fields correspond to the XMLA values MDACTION_COORDINATE_CUBE (1), MDACTION_COORDINATE_DIMENSION (2) MDACTION_COORDINATE_LEVEL (3), MDACTION_COORDINATE_MEMBER (4), MDACTION_COORDINATE_SET (5), MDACTION_COORDINATE_CELL (6)

    • Method Detail

      • values

        public static XmlaConstants.CoordinateType[] 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 (XmlaConstants.CoordinateType c : XmlaConstants.CoordinateType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

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

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