mondrian.olap
Interface Hierarchy

All Superinterfaces:

OlapElement

All Known Implementing Classes:

HierarchyBase, RolapCubeHierarchy, RolapHierarchy

public interface Hierarchy
extends OlapElement

A Hierarchy is a set of members, organized into levels.

Method Summary

Member	createMember(Member parent, Level level, String name, Formula formula) Creates a member of this hierarchy.
Member	getAllMember() Returns the "All" member of this hierarchy.
Member	getDefaultMember() Returns the default member of this hierarchy.
Dimension	getDimension() Returns the dimension this hierarchy belongs to.
Level[]	getLevels() Returns the levels in this hierarchy.
Member	getNullMember() Returns a special member representing the "null" value.
boolean	hasAll()

Methods inherited from interface mondrian.olap.OlapElement

getCaption, getDescription, getHierarchy, getName, getQualifiedName, getUniqueName, lookupChild, lookupChild

Method Detail

getDimension

Dimension getDimension()

Returns the dimension this hierarchy belongs to.

Specified by:

getDimension in interface OlapElement

getLevels

Level[] getLevels()

Returns the levels in this hierarchy.

If a hierarchy is subject to access-control, some of the levels may not be visible; use SchemaReader.getHierarchyLevels(mondrian.olap.Hierarchy) instead.

Post-condition:

return != null

getDefaultMember

Member getDefaultMember()

Returns the default member of this hierarchy.

If a hierarchy is subject to access-control, the default member may not be visible, so use SchemaReader.getHierarchyDefaultMember(mondrian.olap.Hierarchy).

Post-condition:

return != null

getAllMember

Member getAllMember()

Returns the "All" member of this hierarchy.

Post-condition:

return != null

getNullMember

Member getNullMember()

Returns a special member representing the "null" value. This never occurs on an axis, but may occur if functions such as Lead, NextMember and ParentMember walk off the end of the hierarchy.

Post-condition:

return != null

hasAll

boolean hasAll()

createMember

Member createMember(Member parent,
                    Level level,
                    String name,
                    Formula formula)

Creates a member of this hierarchy. If this is the measures hierarchy, a calculated member is created, and formula must not be null.