oracle.olapi.metadata.mdm
Class MdmMeasureDimension

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.MdmPrimaryDimension
                                |
                                +--oracle.olapi.metadata.mdm.MdmMeasureDimension

public final class MdmMeasureDimension

extends MdmPrimaryDimension

An MdmPrimaryDimension with members that are MdmMeasure objects. An MdmMeasureDimension has a single MdmLevelHierarchy component, which has a single MdmLevel component.

You get the persistent MdmMeasureDimension by calling the getMeasureDimension method of the top-level, or root, MdmSchema of the MdmMetadataProvider that you are using. You get the root MdmSchema by calling the getRootSchema method of the MdmMetadataProvider.

You can create a custom MdmMeasureDimension with the createMeasureDimension method of an MdmCustomObjectFactory.

You can create a custom measure and add it to an MdmMeasureDimension by calling one of createCustomMeasure methods of the MdmMeasureDimension. The precedence of the custom measure affects the order in which Oracle OLAP calculates values and assigns the values to the measure. Oracle OLAP evaluates the measure with the highest precedence value first, and then the measure with the next highest precedence value, and so on. If the value for one custom measure depends on the calculated value of another custom measure, then the measure with the dependent value should have a lower precedence.

To see an example program that creates a custom measure as a member of an MdmMeasureDimension, click here. For links to all of the example programs in this documentation, click here.

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmMeasureDimension method of the MdmObjectVisitor and passes that method the MdmMeasureDimension and an Object.
void	addMeasure(MdmMeasure measure) Adds an MdmMeasure to the MdmMeasureDimension.
MdmMeasure	createCustomMeasure(java.lang.String name, MdmSchema schema, Source source, int precedence) Creates a custom MdmMeasure for the specified MdmSchema.
MdmMeasure	createCustomMeasure(java.lang.String name, Source source, int precedence) Creates a custom MdmMeasure.
java.util.List	getMeasures() Gets a List that contains the MdmMeasure objects that are the members of the MdmMeasureDimension.
MdmDimensionCalculationModel	getValueCalcModel() Gets the MdmDimensionCalculationModel with the data type of Value for the MdmMeasureDimension.
void	removeMeasure(MdmMeasure measure) Removes an MdmMeasure from the MdmMeasureDimension.
void	setValueCalcModel(MdmDimensionCalculationModel model) Specifies a MdmDimensionCalculationModel to use for MdmMeasure members of the MdmMeasureDimension that have a data type of Value.

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

createBooleanAttribute, createBooleanAttribute, createDateAttribute, createDateAttribute, createLevelHierarchy, createNumericAttribute, createNumericAttribute, createSolvedLevelHierarchy, createStringAttribute, createStringAttribute, createUnsolvedLevelHierarchy, createValueHierarchy, getAncestorsAttribute, getBooleanCalcModel, getDateCalcModel, getDefaultHierarchy, getHierarchies, getHierarchyAttribute, getIsCustomMemberAttribute, getLevelAttribute, getLevelDepthAttribute, getLocalValueAttribute, getNumberCalcModel, getParentAttribute, getPrimaryDimension, getShortValueDescriptionAttribute, getStringCalcModel, getValueDescriptionAttribute, getValueLineageAttribute, getValueSeparationString, removeHierarchy, setBooleanCalcModel, setDateCalcModel, setDefaultHierarchy, setNumberCalcModel, setShortValueDescriptionAttribute, setStringCalcModel, setValueDescriptionAttribute, setValueSeparationString

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

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

acceptVisitor

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

Calls the visitMdmMeasureDimension method of the MdmObjectVisitor and passes that method the MdmMeasureDimension and an Object.

Overrides:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmMeasureDimension method.

getMeasures

public final java.util.List getMeasures()

Gets a List that contains the MdmMeasure objects that are the members of the MdmMeasureDimension.

Returns:

A List containing all the MdmMeasure objects of the MdmMeasureDimension.

addMeasure

public void addMeasure(MdmMeasure measure)

Adds an MdmMeasure to the MdmMeasureDimension.

Parameters:

measure - The MdmMeasure to add to the MdmMeasureDimension.

removeMeasure

public void removeMeasure(MdmMeasure measure)

Removes an MdmMeasure from the MdmMeasureDimension.

Parameters:

measure - The MdmMeasure to remove.

getValueCalcModel

public final MdmDimensionCalculationModel getValueCalcModel()

Gets the MdmDimensionCalculationModel with the data type of Value for the MdmMeasureDimension.

Returns:

The MdmDimensionCalculationModel with the data type of Value.

setValueCalcModel

public final void setValueCalcModel(MdmDimensionCalculationModel model)

Specifies a MdmDimensionCalculationModel to use for MdmMeasure members of the MdmMeasureDimension that have a data type of Value.

Parameters:

model - A MdmDimensionCalculationModel with the data type of Value that you want to use for members of the MdmMeasureDimension that have a data type of Value.

createCustomMeasure

public MdmMeasure createCustomMeasure(java.lang.String name,
                                      Source source,
                                      int precedence)

Creates a custom MdmMeasure.

Parameters:

name - A String that contains a name for the custom MdmMeasure.

source - A Source that specifies the values of the custom measure.

precedence - An integer that specifies the precedence for the MdmMeasure.

createCustomMeasure

public MdmMeasure createCustomMeasure(java.lang.String name,
                                      MdmSchema schema,
                                      Source source,
                                      int precedence)

Creates a custom MdmMeasure for the specified MdmSchema.

Parameters:

name - A String that contains a name for the custom MdmMeasure.

schema - The MdmSchema to which you want the custom measure to belong.

source - A Source that specifies the values of the custom measure.

precedence - An integer that specifies the precedence for the MdmMeasure.