Enum XmlaConstants.Access

java.lang.Object
java.lang.Enum<XmlaConstants.Access>
org.olap4j.metadata.XmlaConstants.Access
All Implemented Interfaces:
Serializable, Comparable<XmlaConstants.Access>, Constable, XmlaConstant
Enclosing class:
XmlaConstants

public static enum XmlaConstants.Access extends Enum<XmlaConstants.Access> implements XmlaConstant
  • Enum Constant Details

  • Method Details

    • values

      public static XmlaConstants.Access[] 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

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

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