org.olap4j.query
Enum Selection.Operator

java.lang.Object
  extended by java.lang.Enum<Selection.Operator>
      extended by org.olap4j.query.Selection.Operator
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Selection.Operator>
Enclosing interface:
Selection

public static enum Selection.Operator
extends java.lang.Enum<Selection.Operator>

Defines which selection operators are allowed, relative to a root member.


Enum Constant Summary
ANCESTORS
          Selects the set of the ascendants of a specified member, including the member itself.
CHILDREN
          Only the children of the root member will be selected.
DESCENDANTS
          Selects the set of the descendants of a specified member, including the member itself.
INCLUDE_CHILDREN
          The root member will be selected along with all it's children.
MEMBER
          Only the root member will be selected.
SIBLINGS
          Will select the root member along with all it's siblings.
 
Method Summary
static Selection.Operator valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Selection.Operator[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
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

MEMBER

public static final Selection.Operator MEMBER
Only the root member will be selected.


CHILDREN

public static final Selection.Operator CHILDREN
Only the children of the root member will be selected. This excludes the root member itself.

Implemented via the MDX .Children member property.


INCLUDE_CHILDREN

public static final Selection.Operator INCLUDE_CHILDREN
The root member will be selected along with all it's children.


SIBLINGS

public static final Selection.Operator SIBLINGS
Will select the root member along with all it's siblings.

Implemented via the MDX .Siblings member property.


ANCESTORS

public static final Selection.Operator ANCESTORS
Selects the set of the ascendants of a specified member, including the member itself.

Implemented via the MDX Ascendants() function.


DESCENDANTS

public static final Selection.Operator DESCENDANTS
Selects the set of the descendants of a specified member, including the member itself.

Implemented via the MDX Descendants() function.

Method Detail

values

public static Selection.Operator[] 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 (Selection.Operator c : Selection.Operator.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Selection.Operator 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

SourceForge.net_Logo