Package org.olap4j.metadata
Enum Member.TreeOp
- java.lang.Object
-
- java.lang.Enum<Member.TreeOp>
-
- org.olap4j.metadata.Member.TreeOp
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Member.TreeOp>
,XmlaConstant
- Enclosing interface:
- Member
public static enum Member.TreeOp extends java.lang.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
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends java.lang.Enum<E> & XmlaConstant>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANCESTORS
Tree operation which returns all of the ancestors.CHILDREN
Tree operation which returns only the immediate children.DESCENDANTS
Tree operation which returns all of the descendants.PARENT
Tree operation which returns only the immediate parent.SELF
Tree operation which returns itself in the list of returned rows.SIBLINGS
Tree operation which returns members on the same level.
-
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<Member.TreeOp>
getDictionary()
PerXmlaConstant
, returns a dictionary of all values of this enumeration.static Member.TreeOp
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static Member.TreeOp[]
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.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static Member.TreeOp[] 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 (Member.TreeOp c : Member.TreeOp.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Member.TreeOp 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 namejava.lang.NullPointerException
- if the argument is null
-
getDictionary
public static XmlaConstant.Dictionary<Member.TreeOp> getDictionary()
PerXmlaConstant
, returns a dictionary of all values of this enumeration.- Returns:
- Dictionary of all values
-
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 constantDimension.Type.PRODUCTS
.- Specified by:
xmlaName
in interfaceXmlaConstant
- 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 interfaceXmlaConstant
- 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 interfaceXmlaConstant
- Returns:
- ordinal code as specified by XMLA.
-
-