Package com.appliedolap.essbase.impl

Class EssMemberImpl

java.lang.Object

com.appliedolap.essbase.AbstractEssObject

com.appliedolap.essbase.impl.EssMemberImpl

All Implemented Interfaces:

EssMember, EssObject

public class EssMemberImpl
extends AbstractEssObject
implements EssMember

A member in an Essbase cube.

Nested Class Summary

Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssObject

EssObject.Type

Field Summary

Fields inherited from class com.appliedolap.essbase.AbstractEssObject

api

Method Summary

Modifier and Type	Method	Description
int	getChildCount()	Returns the count of children of this member.
List<EssMember>	getChildren()	Gets the children of this member.
List<EssMember>	getLeafDescendants()	Gets the level-0 descendants of this member.
int	getLevel()	Gets the level of the member as indicated by the REST API
String	getName()	Returns the name of the member.
EssMember	getParent()	Gets the parent member (not implemented yet).
EssObject.Type	getType()	Gets the type of this object.
boolean	isDimension()	Check if the member is a normal member or a dimension member.
boolean	isLeaf()	Checks if the member is a leaf node or level 0 (has no children).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getName

public String getName()

Description copied from interface: EssMember

Returns the name of the member.

Specified by:

getName in interface EssMember

Specified by:

getName in interface EssObject

Returns:

the member name

getType

public EssObject.Type getType()

Description copied from interface: EssObject

Gets the type of this object.

Specified by:

getType in interface EssMember

Specified by:

getType in interface EssObject

Returns:

the object type

getParent

public EssMember getParent()

Description copied from interface: EssMember

Gets the parent member (not implemented yet).

Specified by:

getParent in interface EssMember

Returns:

the parent member, null if none (it's a dimension)

getLevel

public int getLevel()

Description copied from interface: EssMember

Gets the level of the member as indicated by the REST API

Specified by:

getLevel in interface EssMember

Returns:

the member level

isDimension

public boolean isDimension()

Description copied from interface: EssMember

Check if the member is a normal member or a dimension member.

Specified by:

isDimension in interface EssMember

Returns:

true if it's a dimension, false if normal member

isLeaf

public boolean isLeaf()

Description copied from interface: EssMember

Checks if the member is a leaf node or level 0 (has no children).

Specified by:

isLeaf in interface EssMember

Returns:

true if level 0, false otherwise

getChildren

public List<EssMember> getChildren()

Description copied from interface: EssMember

Gets the children of this member.

Specified by:

getChildren in interface EssMember

Returns:

the children of this member or an empty collection if none.

getChildCount

public int getChildCount()

Description copied from interface: EssMember

Returns the count of children of this member.

Specified by:

getChildCount in interface EssMember

Returns:

the number of children

getLeafDescendants

public List<EssMember> getLeafDescendants()

Description copied from interface: EssMember

Gets the level-0 descendants of this member. There is currently no REST API to do this in one call, so this method works recursively to fetch children of children and so on until the member has been explored.

Specified by:

getLeafDescendants in interface EssMember

Returns:

the level-0 descendants of this member, or a collection containing just this member if it has no children.