org.olap4j.metadata
Interface Level

All Superinterfaces:
MetadataElement

public interface Level
extends MetadataElement

Group of Member objects in a Hierarchy, all with the same attributes and at the same depth in the hierarchy.

Since:
Aug 23, 2006
Version:
$Id: Level.java 242 2009-05-19 23:18:41Z jhyde $
Author:
jhyde

Nested Class Summary
static class Level.Type
          Enumeration of the types of a Level.
 
Method Summary
 int getCardinality()
          Returns the number of members in this Level.
 int getDepth()
          Returns the depth of this Level.
 Dimension getDimension()
          Returns the Dimension this Level belongs to.
 Hierarchy getHierarchy()
          Returns the Hierarchy this Level belongs to.
 Level.Type getLevelType()
          Returns the type of this Level.
 java.util.List<Member> getMembers()
          Returns a list of Member objects which belong to this Level.
 NamedList<Property> getProperties()
          Returns a list of definitions for the properties available to members of this Level.
 boolean isCalculated()
          Returns whether the level is calculated.
 
Methods inherited from interface org.olap4j.metadata.MetadataElement
getCaption, getDescription, getName, getUniqueName
 

Method Detail

getDepth

int getDepth()
Returns the depth of this Level.

Note #1: In an access-controlled context, the first visible level of a hierarchy may not have a depth of 0.

Note #2: In a parent-child hierarchy, the depth of a member (as returned by may not be the same as the depth of its level.

Returns:
depth of this level

getHierarchy

Hierarchy getHierarchy()
Returns the Hierarchy this Level belongs to.

Returns:
hierarchy this level belongs to

getDimension

Dimension getDimension()
Returns the Dimension this Level belongs to. (Always equivalent to getHierarchy().getDimension().)

Returns:
dimension this level belongs to

getLevelType

Level.Type getLevelType()
Returns the type of this Level.

Returns:
level type

isCalculated

boolean isCalculated()
Returns whether the level is calculated.


getProperties

NamedList<Property> getProperties()
Returns a list of definitions for the properties available to members of this Level.

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

Returns:
properties of this Level
See Also:
OlapDatabaseMetaData.getProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getMembers

java.util.List<Member> getMembers()
                                  throws OlapException
Returns a list of Member objects which belong to this Level.

Some levels have a very many members. In this case, calling this method may be expensive in space and/or time and is not recommended.

The members of a level do not have unique names, so unlike Hierarchy.getRootMembers() and Member.getChildMembers() the result type is a List not a NamedList.

Returns:
List of members in this Level
Throws:
OlapException

getCardinality

int getCardinality()
Returns the number of members in this Level.

Returns:
number of members

SourceForge.net_Logo