Package org.olap4j.metadata

Interface Hierarchy

All Superinterfaces:
MetadataElement
public interface Hierarchy extends MetadataElement
An organization of the set of Members in a Dimension and their positions relative to one another.

A Hierarchy is a collection of Levels, each of which is a category of similar Members.

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 Details

    • getDimension

      Dimension getDimension()
      Returns the Dimension this Hierarchy belongs to.
      Returns:
      dimension this hierarchy belongs to

    • getLevels

      NamedList<Level> getLevels()
      Returns a list of the Level objects in this Hierarchy.

      The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.

      Returns:
      list of levels
      See Also:

    • hasAll

      boolean hasAll()
      Returns whether this Hierarchy has an 'all' member.
      Returns:
      whether this hierarchy has an 'all' member

    • getDefaultMember

      Member getDefaultMember() throws OlapException
      Returns the default Member of this Hierarchy.

      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 a NamedList rather than a mere List because the members of the root level are known to have unique names.

      Returns:
      root members of this hierarchy
      Throws:
      OlapException - on database error