org.olap4j.metadata

Interface Dimension

All Superinterfaces:

MetadataElement

public interface Dimension
extends MetadataElement

An organized hierarchy of categories, known as levels, that describes data in a cube.

A Dimension typically describes a similar set of members upon which the user wants to base an analysis.

A Dimension must have at least one Hierarchy, and may have more than one, but most have exactly one Hierarchy.

Since:

Aug 22, 2006

Author:

jhyde

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Dimension.Type Enumeration of the types of a Dimension.

Method Summary

Modifier and Type	Method and Description
Hierarchy	getDefaultHierarchy() Returns the default Hierarchy of this Dimension.
Dimension.Type	getDimensionType() Returns the type of this Dimension.
NamedList<Hierarchy>	getHierarchies() Returns the hierarchies in this Dimension.

Methods inherited from interface org.olap4j.metadata.MetadataElement

getCaption, getDescription, getName, getUniqueName, isVisible

Method Detail

getHierarchies

NamedList<Hierarchy> getHierarchies()

Returns the hierarchies in this Dimension.

Many dimensions have only one Hierarchy, whose name is the same as the Dimension.

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

Returns:

hierarchies in this dimension

See Also:

OlapDatabaseMetaData.getHierarchies(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getDimensionType

Dimension.Type getDimensionType()
                         throws OlapException

Returns the type of this Dimension.

Returns:

dimension type

Throws:

OlapException - if database error occurs

getDefaultHierarchy

Hierarchy getDefaultHierarchy()

Returns the default Hierarchy of this Dimension.

Returns:

default hierarchy