Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.member
Class CurrentMemberSelection

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

public final class CurrentMemberSelection
extends AbstractMemberSelection

CurrentMemberSelection is a selection used to select members of a given hierarchy in an iteration.


Field Summary
protected  OlapMember currentMember
          a member used as the current member placeholder for a given hierarchy
 
Constructor Summary
protected CurrentMemberSelection()
          Constructs a CurrentMemberSelection.
  CurrentMemberSelection(OlapHierarchy hierarchy)
          Constructs a CurrentMemberSelection.
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
static OlapMember getCurrentMember(OlapHierarchy hierarchy)
          Returns a specialized member used as the current member placeholder for a given hierarchy.
 OlapHierarchy getHierarchy()
          Returns the hierarchy along which members will be iterated.
 
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

currentMember

protected OlapMember currentMember
a member used as the current member placeholder for a given hierarchy

Constructor Detail

CurrentMemberSelection

protected CurrentMemberSelection()
Constructs a CurrentMemberSelection.


CurrentMemberSelection

public CurrentMemberSelection(OlapHierarchy hierarchy)
Constructs a CurrentMemberSelection.

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

getCurrentMember

public static OlapMember getCurrentMember(OlapHierarchy hierarchy)
Returns a specialized member used as the current member placeholder for a given hierarchy.

Parameters:
hierarchy - the hierarchy along which members will be iterated
Returns:
the hiearchy's current member placeholder

getHierarchy

public OlapHierarchy getHierarchy()
Returns the hierarchy along which members will be iterated.

Returns:
the hierarchy along which members will be iterated

Copyright © 2011 Citra Technologies. All Rights Reserved.