Package org.olap4j.metadata
Enum Member.TreeOp
- All Implemented Interfaces:
Serializable
,Comparable<Member.TreeOp>
,Constable
,XmlaConstant
- Enclosing interface:
- Member
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 class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionTree operation which returns all of the ancestors.Tree operation which returns only the immediate children.Tree operation which returns all of the descendants.Tree operation which returns only the immediate parent.Tree operation which returns itself in the list of returned rows.Tree operation which returns members on the same level. -
Method Summary
Modifier and TypeMethodDescriptionReturns the description of this constant.static XmlaConstant.Dictionary<Member.TreeOp>
PerXmlaConstant
, returns a dictionary of all values of this enumeration.static Member.TreeOp
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.xmlaName()
Returns the name of this constant as specified by XMLA.int
Returns the code of this constant as specified by XMLA.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
CHILDREN
Tree operation which returns only the immediate children. -
SIBLINGS
Tree operation which returns members on the same level. -
PARENT
Tree operation which returns only the immediate parent. -
SELF
Tree operation which returns itself in the list of returned rows. -
DESCENDANTS
Tree operation which returns all of the descendants. -
ANCESTORS
Tree operation which returns all of the ancestors.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getDictionary
PerXmlaConstant
, returns a dictionary of all values of this enumeration.- Returns:
- Dictionary of all values
-
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
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.
-