Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.set
Class SingleSetSelection

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

public final class SingleSetSelection
extends AbstractSetSelection
implements SelectionConstants

SingleSetSelection is a selection that returns members from a single hierarchy only. It has a member that is used as the basis for the selection, and also an operator mask that employs values from SelectionConstants.

Using SingleSetSelection, members can be easily selected.
For example, in order to retrieve the children and ancestors of a given member:

SingleSetSelection selection = new SingleSetSelection(member, SelectionConstants.CHILDREN | SelectionConstants.ANCESTORS);
List members = selection.resolveMembers(dataSource);


Field Summary
protected  MemberSelection memberSelection
          the basis of the selection
protected  int operators
          the selection operator mask
 
Fields inherited from interface com.citra.pivot.olap.set.SelectionConstants
ANCESTORS, CHILDREN, DESCENDANTS, LEAVES, PARENT, SELF, SIBLINGS
 
Constructor Summary
protected SingleSetSelection()
          Constructs a SingleSetSelection with no given member as basis, having SELF as the selection operator.
  SingleSetSelection(MemberSelection memberSelection)
          Constructs a SingleSetSelection with a given member as basis, having SELF as the selection operator.
  SingleSetSelection(MemberSelection memberSelection, int operators)
          Constructs a SingleSetSelection with a given member as basis, and a list of operators from SelectionConstants.
  SingleSetSelection(OlapMember member)
          Constructs a SingleSetSelection with a given member as basis, having SELF as the selection operator.
  SingleSetSelection(OlapMember member, int operators)
          Constructs a SingleSetSelection with a given member as basis, and a list of operators from SelectionConstants.
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 MemberSelection getMember()
          Retrieves the member that is used as the basis for this selection.
 int getOperators()
          Retrieves the selection operator mask.
 
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

memberSelection

protected MemberSelection memberSelection
the basis of the selection


operators

protected int operators
the selection operator mask

Constructor Detail

SingleSetSelection

protected SingleSetSelection()
Constructs a SingleSetSelection with no given member as basis, having SELF as the selection operator.


SingleSetSelection

public SingleSetSelection(MemberSelection memberSelection)
Constructs a SingleSetSelection with a given member as basis, having SELF as the selection operator.


SingleSetSelection

public SingleSetSelection(MemberSelection memberSelection,
                          int operators)
Constructs a SingleSetSelection with a given member as basis, and a list of operators from SelectionConstants.


SingleSetSelection

public SingleSetSelection(OlapMember member)
Constructs a SingleSetSelection with a given member as basis, having SELF as the selection operator.


SingleSetSelection

public SingleSetSelection(OlapMember member,
                          int operators)
Constructs a SingleSetSelection with a given member as basis, and a list of operators from SelectionConstants.

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

getMember

public MemberSelection getMember()
Retrieves the member that is used as the basis for this selection.

Returns:
the member the selection is based upon

getOperators

public int getOperators()
Retrieves the selection operator mask. The operators are taken from SelectionConstants.

Returns:
the selection operator mask

Copyright © 2011 Citra Technologies. All Rights Reserved.