Enum Class Member.TreeOp

java.lang.Object
java.lang.Enum<Member.TreeOp>
org.olap4j.metadata.Member.TreeOp
All Implemented Interfaces:
Serializable, Comparable<Member.TreeOp>, Constable, XmlaConstant
Enclosing interface:
Member

public static enum Member.TreeOp extends Enum<Member.TreeOp> implements XmlaConstant
Enumeration of tree operations which can be used when querying members.

Some of the values are as specified by XMLA. For example, XMLA specifies MDTREEOP_CHILDREN with ordinal 1, which corresponds to the value CHILDREN.

See Also:
  • Enum Constant Details

    • CHILDREN

      public static final Member.TreeOp CHILDREN
      Tree operation which returns only the immediate children.
    • SIBLINGS

      public static final Member.TreeOp SIBLINGS
      Tree operation which returns members on the same level.
    • PARENT

      public static final Member.TreeOp PARENT
      Tree operation which returns only the immediate parent.
    • SELF

      public static final Member.TreeOp SELF
      Tree operation which returns itself in the list of returned rows.
    • DESCENDANTS

      public static final Member.TreeOp DESCENDANTS
      Tree operation which returns all of the descendants.
    • ANCESTORS

      public static final Member.TreeOp ANCESTORS
      Tree operation which returns all of the ancestors.
  • Method Details

    • values

      public static Member.TreeOp[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Member.TreeOp valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • getDictionary

      public static XmlaConstant.Dictionary<Member.TreeOp> 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.