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>

Enclosing interface:

Member

public static enum Member.TreeOp
extends java.lang.Enum<Member.TreeOp>

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:

OlapDatabaseMetaData.getMembers(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Set)

Enum Constant Summary

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

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.
int	xmlaOrdinal() Returns the ordinal code as specified by XMLA.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 name

java.lang.NullPointerException - if the argument is null

xmlaOrdinal

public int xmlaOrdinal()

Returns the ordinal code as specified by XMLA.

For example, the XMLA specification says that the ordinal of ANCESTORS is 32.

Returns:

ordinal code as specified by XMLA.