oracle.olapi.metadata.mdm
Class MdmHierarchyLevel

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.MdmHierarchyLevel

All Implemented Interfaces:

MetadataObject

Direct Known Subclasses:

MdmLevel

public class MdmHierarchyLevel
extends MdmSubDimension

An MdmSubDimension whose members comprise one level of an MdmLevelHierarchy. An application creates an MdmHierarchyLevel with the findOrCreateHierarchyLevel method of the MdmLevelHierarchy. The members of an MdmHierarchyLevel are specified by an associated HierarchyLevelMap

If the MdmLevelHierarchy has more than one component MdmHierarchyLevel, then the MdmLevelHierarchy has a hierarchical structure that is specified by parent-child relationships between the members of the MdmHierarchyLevel components. Those parent-child relationships are recorded by MdmAttribute objects that you can get with the getParentAttribute and getAncestorsAttribute methods of the MdmLevelHierarchy.

An MdmHierarchyLevel is associated with an MdmDimensionLevel. The members of the MdmHierarchyLevel are a subset of the members of the MdmDimensionLevel. The getType method of the MdmDimensionLevel returns the type of data that the MdmHierarchyLevel represents.

See Also:

HierarchyLevelMap

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmHierarchyLevel method of the specified MdmObjectVisitor and passes that method this MdmHierarchyLevel and an Object.
HierarchyLevelMap	findOrCreateHierarchyLevelMap() Gets the HierarchyLevelMap that is associated with this MdmHierarchyLevel or creates a new HierarchyLevelMap if one does not already exist.
MdmDimensionLevel	getDimensionLevel() Gets the MdmDimensionLevel associated with this MdmHierarchyLevel.
HierarchyLevelMap	getHierarchyLevelMap() Gets the HierarchyLevelMap associated with this MdmHierarchyLevel.
int	getLevelDepth() Gets the depth of this MdmHierarchyLevel in the hierarchy of levels of the MdmHierarchy of which this level is a component.
MdmLevelHierarchy	getLevelHierarchy() Gets the MdmLevelHierarchy of which this MdmLevel is a component.
java.lang.String	getName() Gets the name of this MdmObject.
void	setHierarchyLevelMap(HierarchyLevelMap value) Specifies the HierarchyLevelMap to associate with this MdmHierarchyLevel.

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

addAttribute, getAttributes, removeAttribute

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

getCardinality, getCustomOrder, getPluralDescription, getPrimaryDimension, getShortPluralDescription, setCardinality, setCustomOrder, setPluralDescription, setShortPluralDescription

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

getDataType, getSource, getType

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

addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getNewName, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getContainedByObject, getID, getOwner

Methods inherited from class java.lang.Object

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

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmHierarchyLevel method of the specified MdmObjectVisitor and passes that method this MdmHierarchyLevel and an Object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An Mdm11_ObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmHierarchyLevel method.

getLevelHierarchy

public MdmLevelHierarchy getLevelHierarchy()

Gets the MdmLevelHierarchy of which this MdmLevel is a component.

Returns:

The MdmLevelHierarchy of which this MdmLevel is a component.

getName

public final java.lang.String getName()
                               throws oracle.express.mdm.MetadataNotFoundException

Gets the name of this MdmObject.

Overrides:

getName in class MdmObject

Returns:

A String that contains the name of this MdmObject.

Throws:

oracle.express.mdm.MetadataNotFoundException - Indicates that the requested metadata object does not exist or is not available to the MdmMetadataProvider.

getLevelDepth

public int getLevelDepth()

Gets the depth of this MdmHierarchyLevel in the hierarchy of levels of the MdmHierarchy of which this level is a component.

Returns:

An integer that indicates the level depth of the level in a hierarchy of levels.

getDimensionLevel

public MdmDimensionLevel getDimensionLevel()

Gets the MdmDimensionLevel associated with this MdmHierarchyLevel.

Returns:

The MdmDimensionLevel associated with this MdmHierarchyLevel.

getHierarchyLevelMap

public final HierarchyLevelMap getHierarchyLevelMap()

Gets the HierarchyLevelMap associated with this MdmHierarchyLevel. The HierarchyLevelMap maps the members of the MdmHierarchyLevel to data in the relational database.

Returns:

The HierarchyLevelMap for the MdmLevel.

findOrCreateHierarchyLevelMap

public HierarchyLevelMap findOrCreateHierarchyLevelMap()

Gets the HierarchyLevelMap that is associated with this MdmHierarchyLevel or creates a new HierarchyLevelMap if one does not already exist.

Returns:

The HierarchyLevelMap associated with this MdmHierarchyLevel.

setHierarchyLevelMap

public void setHierarchyLevelMap(HierarchyLevelMap value)

Specifies the HierarchyLevelMap to associate with this MdmHierarchyLevel.

Parameters:

value - The HierarchyLevelMap to associate with this MdmHierarchyLevel.