org.olap4j.metadata
public interface Hierarchy extends MetadataElement
Member
s in a Dimension
and
their positions relative to one another.
A Hierarchy is a collection of Level
s, each of which is a
category of similar Member
s.
A Dimension must have at least one Hierarchy, and may have more than one, but most have exactly one Hierarchy.
Modifier and Type | Method and Description |
---|---|
Member |
getDefaultMember()
Returns the default
Member of this Hierarchy . |
Dimension |
getDimension()
Returns the
Dimension this Hierarchy belongs to. |
NamedList<Level> |
getLevels()
Returns a list of the
Level objects in this
Hierarchy . |
NamedList<Member> |
getRootMembers()
Returns the root member or members of this Dimension.
|
boolean |
hasAll()
Returns whether this
Hierarchy has an 'all' member. |
getCaption, getDescription, getName, getUniqueName, isVisible
Dimension getDimension()
Dimension
this Hierarchy
belongs to.NamedList<Level> getLevels()
Level
objects in this
Hierarchy
.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
boolean hasAll()
Hierarchy
has an 'all' member.Member getDefaultMember() throws OlapException
Member
of this Hierarchy
.
If the hierarchy has an 'all' member, this member is often the default.
OlapException
NamedList<Member> getRootMembers() throws OlapException
If the dimension has an 'all' member, then this will be the sole root member.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
The result is similar to that returned by
getLevels().get(0).getMembers()
; the contents will be the
same, but this method returns a NamedList
rather than a
mere List
because the members of the root level are
known to have unique names.
OlapException
- on database error