Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.set
Class DescendantsSetSelection

java.lang.Object
  extended by com.citra.pivot.olap.set.AbstractSetSelection
      extended by com.citra.pivot.olap.set.DescendantsSetSelection
All Implemented Interfaces:
OlapSelection, SetSelection

public final class DescendantsSetSelection
extends AbstractSetSelection

DescendantsSetSelection is a selection that returns descendants of a given member. If a set is supplied, the descendants function is applied to each member in the set separately and the sets are then unioned.


Field Summary
static int AFTER
          indicates that only members from a level lower than a given one will be selected
static int BEFORE
          indicates that only members from a level higher than a given one will be selected
static int BEFORE_AND_AFTER
          indicates that only members from a level lower and higher than a given one will be selected
protected  int flag
          an int showing the descendant selection algorithm
static int LEAVES
          indicates that only leaf members will be selected
protected  OlapLevel level
          the level parameter of the selection
protected  int levelDistance
          the level distance parameter of the selection
static int SELF
          indicates that only members from a given level will be selected
static int SELF_AND_AFTER
          indicates that only members from a level lower or equal to a given one will be selected
static int SELF_AND_BEFORE
          indicates that only members from a level higher or equal to a given one will be selected
static int SELF_BEFORE_AFTER
          indicates that only members from a level lower, higher and equal to a given one will be selected
protected  SetSelection set
          the set whose descendants are selected
 
Constructor Summary
protected DescendantsSetSelection()
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(MemberSelection member)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(MemberSelection member, int levelDistance)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(MemberSelection member, int levelDistance, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(MemberSelection member, OlapLevel level)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(MemberSelection member, OlapLevel level, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapMember member)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapMember member, int levelDistance)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapMember member, int levelDistance, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapMember member, OlapLevel level)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapMember member, OlapLevel level, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapSet set)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapSet set, int levelDistance)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapSet set, int levelDistance, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapSet set, OlapLevel level)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(OlapSet set, OlapLevel level, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(SetSelection set)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(SetSelection set, int levelDistance)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(SetSelection set, int levelDistance, int flag)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(SetSelection set, OlapLevel level)
          Constructs a DescendantsSetSelection.
  DescendantsSetSelection(SetSelection set, OlapLevel level, int flag)
          Constructs a DescendantsSetSelection.
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 int getFlag()
          Returns the algorithm to use when selecting the descendants.
 OlapLevel getLevel()
          Returns the defined level required by the descendants selection.
 int getLevelDistance()
          Returns the defined difference in levels required by the descendants selection.
 SetSelection getSet()
          Determines the set whose descendants are selected.
 
Methods inherited from class com.citra.pivot.olap.set.AbstractSetSelection
resolveSelection, resolveSet
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

set

protected SetSelection set
the set whose descendants are selected


level

protected OlapLevel level
the level parameter of the selection


levelDistance

protected int levelDistance
the level distance parameter of the selection


flag

protected int flag
an int showing the descendant selection algorithm


SELF

public static final int SELF
indicates that only members from a given level will be selected

See Also:
Constant Field Values

AFTER

public static final int AFTER
indicates that only members from a level lower than a given one will be selected

See Also:
Constant Field Values

BEFORE

public static final int BEFORE
indicates that only members from a level higher than a given one will be selected

See Also:
Constant Field Values

BEFORE_AND_AFTER

public static final int BEFORE_AND_AFTER
indicates that only members from a level lower and higher than a given one will be selected

See Also:
Constant Field Values

SELF_AND_AFTER

public static final int SELF_AND_AFTER
indicates that only members from a level lower or equal to a given one will be selected

See Also:
Constant Field Values

SELF_AND_BEFORE

public static final int SELF_AND_BEFORE
indicates that only members from a level higher or equal to a given one will be selected

See Also:
Constant Field Values

SELF_BEFORE_AFTER

public static final int SELF_BEFORE_AFTER
indicates that only members from a level lower, higher and equal to a given one will be selected

See Also:
Constant Field Values

LEAVES

public static final int LEAVES
indicates that only leaf members will be selected

See Also:
Constant Field Values
Constructor Detail

DescendantsSetSelection

protected DescendantsSetSelection()
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapSet set)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapSet set,
                               int levelDistance)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapSet set,
                               int levelDistance,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapSet set,
                               OlapLevel level)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapSet set,
                               OlapLevel level,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(MemberSelection member)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(MemberSelection member,
                               int levelDistance)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(MemberSelection member,
                               int levelDistance,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(MemberSelection member,
                               OlapLevel level)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(MemberSelection member,
                               OlapLevel level,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapMember member)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapMember member,
                               int levelDistance)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapMember member,
                               int levelDistance,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapMember member,
                               OlapLevel level)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(OlapMember member,
                               OlapLevel level,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(SetSelection set)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(SetSelection set,
                               int levelDistance)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(SetSelection set,
                               int levelDistance,
                               int flag)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(SetSelection set,
                               OlapLevel level)
Constructs a DescendantsSetSelection.


DescendantsSetSelection

public DescendantsSetSelection(SetSelection set,
                               OlapLevel level,
                               int flag)
Constructs a DescendantsSetSelection.

Method Detail

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:
equals in class Object
Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Object.hashCode(), Hashtable

getFlag

public int getFlag()
Returns the algorithm to use when selecting the descendants.
The flag may be:
  • SELF
  • AFTER
  • BEFORE
  • BEFORE_AND_AFTER
  • SELF_AND_AFTER
  • SELF_AND_BEFORE
  • SELF_BEFORE_AFTER
  • LEAVES
  • Returns:
    the descendant's selection algorithm

    getLevel

    public OlapLevel getLevel()
    Returns the defined level required by the descendants selection.

    Returns:
    the level defined

    getLevelDistance

    public int getLevelDistance()
    Returns the defined difference in levels required by the descendants selection.

    Returns:
    the distance in levels from the member being evaluated

    getSet

    public SetSelection getSet()
    Determines the set whose descendants are selected.

    Returns:
    the set whose descendants are selected

    Copyright © 2011 Citra Technologies. All Rights Reserved.