oracle.olapi.metadata.mdm
Class MdmHierarchy

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mdm.MdmObject
              |
              +--oracle.olapi.metadata.mdm.MdmSource
                    |
                    +--oracle.olapi.metadata.mdm.MdmDimension
                          |
                          +--oracle.olapi.metadata.mdm.MdmSubDimension
                                |
                                +--oracle.olapi.metadata.mdm.MdmHierarchy

Direct Known Subclasses:

MdmLevelHierarchy, MdmValueHierarchy

public abstract class MdmHierarchy

extends MdmSubDimension

An MdmSubDimension that represents members of an Oracle OLAP dimension that are organized either hierarchically or nonhierarchically. An MdmHierarchy is a component of an MdmPrimaryDimension.

A hierarchical organization is defined by parent-child relationships between the members of the hierarchy. If the parent-child relationships are defined by levels, then the MdmHierarchy is an MdmLevelHierarchy, which has a component MdmLevel object for each level. If the parent-child relationships are defined by values and not by levels, then the MdmHierarchy is an MdmValueHierarchy.

A nonhierarchical MdmHierarchy is one that is not organized by parent-child relationships. It is represented by an MdmLevelHierarchy that has only one level.

MdmAttribute objects record the parent-child relationships among the members of an MdmHierarchy You use the getParentAttribute and getAncestorsAttribute methods to get the MdmAttribute objects that relate parents to children and ancestors to descendents, respectively.

Method Summary

MdmAttribute	getAncestorsAttribute() Gets the ancestors attribute for this MdmHierarchy.
abstract MdmDimensionMemberInfo	getDefaultMember() Gets the MdmDimensionMemberInfo that specifies the default member of this MdmHierarchy.
MdmAttribute	getParentAttribute() Gets the parent attribute for this MdmHierarchy.
boolean	isDefaultHierarchy() Indicates whether this MdmHierarchy is the default component of its MdmPrimaryDimension.
abstract void	setDefaultMember(MdmDimensionMemberInfo defaultMember) Specifies a default member for this MdmHierarchy.

Methods inherited from class oracle.olapi.metadata.mdm.MdmSubDimension

getPrimaryDimension

Methods inherited from class oracle.olapi.metadata.mdm.MdmDimension

getAttributes, getCardinality, getPluralDescription, getShortPluralDescription, removeAttribute, setCardinality, setPluralDescription, setShortPluralDescription

Methods inherited from class oracle.olapi.metadata.mdm.MdmSource

getDataType, getModel, getSource, getSourceMap, getType, setModel

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject

acceptVisitor, getDescription, getMetadataProvider, getName, getShortDescription, setDescription, setName, setShortDescription

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAncestorsAttribute

public MdmAttribute getAncestorsAttribute()
                                   throws MetadataNotFoundException

Gets the ancestors attribute for this MdmHierarchy. The ancestors attribute maps each member of this MdmHierarchy to its group of ancestors in the hierarchy. For example, the ancestors for a given day in a time hierarchy might be month, quarter, and year. An ancestors attribute is sometimes referred to as an ancestors relation.

Returns:

The MdmAttribute that is the ancestors attribute of this MdmHierarchy.

getParentAttribute

public MdmAttribute getParentAttribute()
                                throws MetadataNotFoundException

Gets the parent attribute for this MdmHierarchy. The parent attribute maps each member of this MdmHierarchy to its parent. A parent attribute is sometimes referred to as a parent relation.

Returns:

The MdmAttribute that is the parent attribute of this MdmHierarchy.

getDefaultMember

public abstract MdmDimensionMemberInfo getDefaultMember()
                                                 throws MetadataNotFoundException

Gets the MdmDimensionMemberInfo that specifies the default member of this MdmHierarchy. From the MdmDimensionMemberInfo you can get the value of the default member by calling its getLocalValue or getUniqueValue method.

Returns:

An MdmDimensionMemberInfo that has the default member of this MdmHierarchy.

setDefaultMember

public abstract void setDefaultMember(MdmDimensionMemberInfo defaultMember)
                               throws MetadataNotFoundException,
                                      MdmInvalidValueException

Specifies a default member for this MdmHierarchy.

Parameters:

defaultMember - An MdmDimensionMemberInfo that has the value that you want the default member of this MdmHierarchy to have.

isDefaultHierarchy

public final boolean isDefaultHierarchy()

Indicates whether this MdmHierarchy is the default component of its MdmPrimaryDimension.

Returns:

true if this is the default hierarchy and false if it is not.