Interface Hierarchy
-
- All Superinterfaces:
MetadataElement
public interface Hierarchy extends MetadataElement
An organization of the set ofMember
s in aDimension
and their positions relative to one another.A Hierarchy is a collection of
Level
s, each of which is a category of similarMember
s.A Dimension must have at least one Hierarchy, and may have more than one, but most have exactly one Hierarchy.
- Since:
- Aug 23, 2006
- Author:
- jhyde
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Member
getDefaultMember()
Returns the defaultMember
of thisHierarchy
.Dimension
getDimension()
Returns theDimension
thisHierarchy
belongs to.NamedList<Level>
getLevels()
Returns a list of theLevel
objects in thisHierarchy
.NamedList<Member>
getRootMembers()
Returns the root member or members of this Dimension.boolean
hasAll()
Returns whether thisHierarchy
has an 'all' member.-
Methods inherited from interface org.olap4j.metadata.MetadataElement
getCaption, getDescription, getName, getUniqueName, isVisible
-
-
-
-
Method Detail
-
getDimension
Dimension getDimension()
Returns theDimension
thisHierarchy
belongs to.- Returns:
- dimension this hierarchy belongs to
-
getLevels
NamedList<Level> getLevels()
Returns a list of theLevel
objects in thisHierarchy
.The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
-
hasAll
boolean hasAll()
Returns whether thisHierarchy
has an 'all' member.- Returns:
- whether this hierarchy has an 'all' member
-
getDefaultMember
Member getDefaultMember() throws OlapException
Returns the defaultMember
of thisHierarchy
.If the hierarchy has an 'all' member, this member is often the default.
- Returns:
- the default member of this hierarchy
- Throws:
OlapException
-
getRootMembers
NamedList<Member> getRootMembers() throws OlapException
Returns the root member or members of this Dimension.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 aNamedList
rather than a mereList
because the members of the root level are known to have unique names.- Returns:
- root members of this hierarchy
- Throws:
OlapException
- on database error
-
-