oracle.olapi.metadata.mdm

Class MdmHierarchy

java.lang.Object

oracle.olapi.metadata.BaseMetadataObject

oracle.olapi.metadata.PublicMetadataObject

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

All Implemented Interfaces:

MdmQuery, MdmViewColumnOwner, MetadataObject

Direct Known Subclasses:

MdmLevelHierarchy, MdmValueHierarchy

public abstract class MdmHierarchy
extends MdmSubDimension
implements MdmViewColumnOwner, MdmQuery

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

Modifier and Type	Method and Description
MdmAttribute	getAncestorsAttribute() Gets the ancestors attribute for this MdmHierarchy.
abstract MdmDimensionMemberInfo	getDefaultMember() Gets the MdmDimensionMemberInfo that is associated with the default member of this MdmHierarchy.
MdmQueryColumn	getETDepthColumn() Gets the MdmQueryColumn that represents the depth column of the embedded totals view associated with the MdmHierarchy.
MdmQueryColumn	getETParentColumn() Gets the MdmQueryColumn that represents the parent column of the embedded totals view associated with the MdmHierarchy.
java.lang.String	getETViewName() Gets the name of the ET (Embedded Totals) view associated with the MdmHierarchy.
MdmAttribute	getParentAttribute() Gets the parent attribute for this MdmHierarchy.
Query	getQuery() Gets the Query that is associated with the MdmHierarchy.
MdmQueryColumn	getQueryColumn(java.lang.String name) Gets the specified MdmQueryColumn.
java.util.List<MdmQueryColumn>	getQueryColumns() Gets the MdmQueryColumn objects that are associated with the MdmHierarchy.
java.lang.String	getQueryName() Gets the identifier of the MdmHierarchy.
boolean	isDefaultHierarchy() Indicates whether this MdmHierarchy is the default component of an MdmPrimaryDimension.
abstract void	setDefaultMember(MdmDimensionMemberInfo defaultMember) Specifies a default member for this MdmHierarchy.
void	setETViewName(java.lang.String name) Specifies the ET (Embedded Totals) view to associate with the MdmHierarchy.

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

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

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getContainedByObject, getID, getName, getNewName, getOwner

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 oracle.express.mdm.MetadataNotFoundException

Gets the ancestors attribute for this MdmHierarchy. The ancestors attribute relates each member of this MdmHierarchy to the members that are the ancestors of it in the hierarchy. For example, the ancestors for a given day in a time hierarchy might be month, quarter, and year.

Returns:

The MdmAttribute that is the ancestors attribute of this MdmHierarchy.

Throws:

oracle.express.mdm.MetadataNotFoundException

getParentAttribute

public MdmAttribute getParentAttribute()
                                throws oracle.express.mdm.MetadataNotFoundException

Gets the parent attribute for this MdmHierarchy. The parent attribute relates each member of this MdmHierarchy to the parent of it.

Returns:

The MdmAttribute that is the parent attribute of this MdmHierarchy.

Throws:

oracle.express.mdm.MetadataNotFoundException

getDefaultMember

public abstract MdmDimensionMemberInfo getDefaultMember()
                                                 throws oracle.express.mdm.MetadataNotFoundException

Gets the MdmDimensionMemberInfo that is associated with the default member of this MdmHierarchy. You can get the value of the default member by calling the getLocalValue or getUniqueValue method of the MdmDimensionMemberInfo.

Returns:

An MdmDimensionMemberInfo for the default member of this MdmHierarchy.

Throws:

oracle.express.mdm.MetadataNotFoundException

setDefaultMember

public abstract void setDefaultMember(MdmDimensionMemberInfo defaultMember)
                               throws oracle.express.mdm.MetadataNotFoundException,
                                      MdmInvalidValueException

Specifies a default member for this MdmHierarchy.

Parameters:

defaultMember - The MdmDimensionMemberInfo that is associated with the dimension member that you want as the default member for this MdmHierarchy.

Throws:

oracle.express.mdm.MetadataNotFoundException

MdmInvalidValueException

isDefaultHierarchy

public final boolean isDefaultHierarchy()

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

Returns:

A boolean that is true if this is the default hierarchy or false if it is not.

getETViewName

public final java.lang.String getETViewName()

Gets the name of the ET (Embedded Totals) view associated with the MdmHierarchy.

Returns:

A String that contains the name of the ET view associated with the MdmHierarchy.

setETViewName

public final void setETViewName(java.lang.String name)

Specifies the ET (Embedded Totals) view to associate with the MdmHierarchy.

Parameters:

name - A String that contains the name of the ET view to associate with the MdmHierarchy.

getETParentColumn

public final MdmQueryColumn getETParentColumn()

Gets the MdmQueryColumn that represents the parent column of the embedded totals view associated with the MdmHierarchy.

Returns:

An MdmQueryColumn that represents the parent column of the embedded totals view.

getETDepthColumn

public final MdmQueryColumn getETDepthColumn()

Gets the MdmQueryColumn that represents the depth column of the embedded totals view associated with the MdmHierarchy.

Returns:

An MdmQueryColumn that represents the depth column of the embedded totals view.

getQuery

public final Query getQuery()

Gets the Query that is associated with the MdmHierarchy.

Specified by:

getQuery in interface MdmQuery

Returns:

The Query associated with the MdmHierarchy.

getQueryName

public final java.lang.String getQueryName()

Gets the identifier of the MdmHierarchy.

Specified by:

getQueryName in interface MdmQuery

Returns:

A String that contains the identifier of the MdmHierarchy object.

getQueryColumns

public java.util.List<MdmQueryColumn> getQueryColumns()

Gets the MdmQueryColumn objects that are associated with the MdmHierarchy.

Specified by:

getQueryColumns in interface MdmQuery

Returns:

A List of the MdmQueryColumn objects associated with the MdmHierarchy.

getQueryColumn

public MdmQueryColumn getQueryColumn(java.lang.String name)

Gets the specified MdmQueryColumn.

Specified by:

getQueryColumn in interface MdmQuery

Parameters:

name - A String that contains the name of an MdmQueryColumn.

Returns:

The MdmQueryColumn that has the specified name.