Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap
Class OlapRootMember

java.lang.Object
  extended by com.citra.pivot.olap.OlapRootMember
All Implemented Interfaces:
OlapMember, OlapObject

public class OlapRootMember
extends Object
implements OlapMember

OlapRootMember is a special member which is defined as a hierarchy's root. This member is virtual and not actually contained in the cube.


Method Summary
 String getCaption()
          Retrieves the caption of the olap object.
 String getDescription()
          Retrieves the description of the olap object.
 String getID()
          Retrieves the id of the olap object.
 OlapLevel getLevel()
          Retrieves the level this member is part of.
 int getMemberCount()
          Retrieves the number of children this member has.
 String getName()
          Retrieves the name of the olap object.
static OlapMember getRootMember(OlapHierarchy hierarchy)
          Returns the root member for a given hierarchy.
static boolean isRootMember(OlapMember member)
          Determines whether a member is the hierarchy's root member.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getCaption

public String getCaption()
Retrieves the caption of the olap object.

Specified by:
getCaption in interface OlapObject
Returns:
the caption as string

getDescription

public String getDescription()
Retrieves the description of the olap object.

Specified by:
getDescription in interface OlapObject
Returns:
the description as string

getID

public String getID()
Retrieves the id of the olap object.

Specified by:
getID in interface OlapObject
Returns:
the id as string

getLevel

public OlapLevel getLevel()
Retrieves the level this member is part of.

Specified by:
getLevel in interface OlapMember
Returns:
the member's level

getMemberCount

public int getMemberCount()
Retrieves the number of children this member has.

Specified by:
getMemberCount in interface OlapMember
Returns:
the member's children count

getName

public String getName()
Retrieves the name of the olap object.

Specified by:
getName in interface OlapObject
Returns:
the name as string

getRootMember

public static OlapMember getRootMember(OlapHierarchy hierarchy)
Returns the root member for a given hierarchy.

Parameters:
hierarchy - the hierarchy whose root member is returned
Returns:
the hierarchy's root member

isRootMember

public static boolean isRootMember(OlapMember member)
Determines whether a member is the hierarchy's root member.

Parameters:
member - the member to test whether it is the hierarchy's root
Returns:
true if the member is the root member, false otherwise

Copyright © 2011 Citra Technologies. All Rights Reserved.