Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.member
Class AncestorMemberSelection

java.lang.Object
  extended by com.citra.pivot.olap.member.AbstractMemberSelection
      extended by com.citra.pivot.olap.member.AncestorMemberSelection
All Implemented Interfaces:
OlapSelection, MemberSelection

public final class AncestorMemberSelection
extends AbstractMemberSelection

AncestorMemberSelection is a selection that returns the ancestor of a member.


Field Summary
protected  int distance
          the distance in the number of levels between the member and its ancestor
protected  OlapLevel level
          the level to which the ancestor belongs
protected  MemberSelection memberSelection
          the member whose ancestor is retrieved
 
Constructor Summary
protected AncestorMemberSelection()
          Constructs an AncestorMemberSelection.
  AncestorMemberSelection(MemberSelection memberSelection, int distance)
          Constructs an AncestorMemberSelection.
  AncestorMemberSelection(MemberSelection memberSelection, OlapLevel level)
          Constructs an AncestorMemberSelection.
  AncestorMemberSelection(OlapMember member, int distance)
          Constructs an AncestorMemberSelection.
  AncestorMemberSelection(OlapMember member, OlapLevel level)
          Constructs an AncestorMemberSelection.
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 OlapLevel getLevel()
          Returns the level to which the ancestor belongs.
 int getLevelDistance()
          Returns the distance in the number of levels between the member and its ancestor.
 MemberSelection getMember()
          Returns the member whose ancestor is retrieved.
 
Methods inherited from class com.citra.pivot.olap.member.AbstractMemberSelection
resolveMember, resolveSelection
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

memberSelection

protected MemberSelection memberSelection
the member whose ancestor is retrieved


level

protected OlapLevel level
the level to which the ancestor belongs


distance

protected int distance
the distance in the number of levels between the member and its ancestor

Constructor Detail

AncestorMemberSelection

protected AncestorMemberSelection()
Constructs an AncestorMemberSelection.


AncestorMemberSelection

public AncestorMemberSelection(MemberSelection memberSelection,
                               int distance)
Constructs an AncestorMemberSelection.


AncestorMemberSelection

public AncestorMemberSelection(MemberSelection memberSelection,
                               OlapLevel level)
Constructs an AncestorMemberSelection.


AncestorMemberSelection

public AncestorMemberSelection(OlapMember member,
                               int distance)
Constructs an AncestorMemberSelection.


AncestorMemberSelection

public AncestorMemberSelection(OlapMember member,
                               OlapLevel level)
Constructs an AncestorMemberSelection.

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

getLevel

public OlapLevel getLevel()
Returns the level to which the ancestor belongs.

Returns:
the ancestor's level

getLevelDistance

public int getLevelDistance()
Returns the distance in the number of levels between the member and its ancestor.

Returns:
the ancestor's level difference between itself and the member

getMember

public MemberSelection getMember()
Returns the member whose ancestor is retrieved.

Returns:
the member whose ancestor is retrieved

Copyright © 2011 Citra Technologies. All Rights Reserved.