oracle.olapi.metadata.mtm
Class MtmMeasureMap

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mtm.MtmObject
              |
              +--oracle.olapi.metadata.mtm.MtmSourceMap
                    |
                    +--oracle.olapi.metadata.mtm.MtmMeasureMap

public class MtmMeasureMap

extends MtmSourceMap

An MtmSourceMap for an MdmMeasure. Each MtmMeasureMap is associated with a single MtmCube.

Method Summary

java.lang.Object	acceptVisitor(MtmObjectVisitor visitor, java.lang.Object context) Calls the visitMtmMeasureMap method of the specified MtmObjectVisitor and passes that method this MtmMeasureMap and the specified context object.
MtmCube	getCube() Gets the MtmCube for this MtmMeasureMap.
MtmValueExpression	getDefaultMappedExpression() Gets the MtmValueExpression that specifies a default value for the MdmMeasure for which this is the MtmMeasureMap, or null if no default expression has been set.
MtmValueExpression	getMappedExpression(MtmBaseCube cube) Gets the MtmValueExpression that describes the user expression or fact table column that holds the values for this MtmMeasureMap for the specified MtmBaseCube.
void	setDefaultMappedExpression(MtmValueExpression expression) Specifies an MtmValueExpression as the default measure value.
void	setMappedExpression(MtmBaseCube cube, MtmValueExpression expression) Specifies the MtmValueExpression that describes the user expression or fact table column that holds the values of the MdmMeasure, for which this is the MtmMeasureMap, for the specified MtmBaseCube.

Methods inherited from class oracle.olapi.metadata.mtm.MtmSourceMap

getMdmSource, setMdmSource

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(MtmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMtmMeasureMap method of the specified MtmObjectVisitor and passes that method this MtmMeasureMap and the specified context object.

Overrides:

acceptVisitor in class MtmObject

Parameters:

visitor - An MtmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMtmMeasureMap method.

getCube

public MtmCube getCube()

Gets the MtmCube for this MtmMeasureMap.

Returns:

The MtmCube for this MtmMeasureMap.

getMappedExpression

public MtmValueExpression getMappedExpression(MtmBaseCube cube)

Gets the MtmValueExpression that describes the user expression or fact table column that holds the values for this MtmMeasureMap for the specified MtmBaseCube.

Parameters:

cube - The MtmBaseCube for which you want the MtmValueExpression for this MtmMeasureMap.

Returns:

The MtmValueExpression for this MtmMeasureMap for the specified MtmBaseCube.

setMappedExpression

public void setMappedExpression(MtmBaseCube cube,
                                MtmValueExpression expression)

Specifies the MtmValueExpression that describes the user expression or fact table column that holds the values of the MdmMeasure, for which this is the MtmMeasureMap, for the specified MtmBaseCube.

Parameters:

cube - The MtmBaseCube for which you want the MtmValueExpression to specify the measure values.

expression - An MtmValueExpression that specifies the measure values for cube.

getDefaultMappedExpression

public MtmValueExpression getDefaultMappedExpression()

Gets the MtmValueExpression that specifies a default value for the MdmMeasure for which this is the MtmMeasureMap, or null if no default expression has been set.

Returns:

An MtmValueExpression that specifies a default expression for this MtmMeasureMap, or null if no default expression is defined.

setDefaultMappedExpression

public void setDefaultMappedExpression(MtmValueExpression expression)

Specifies an MtmValueExpression as the default measure value. Oracle OLAP uses this value when an MtmBaseCube does not have an MtmValueExpression specified for it. For example, if this MtmMeasureMap has an MtmValueExpression for some of the MtmBaseCube objects of an MtmPartitionedCube but not for others and the default expresssion is a constant of 0 (zero), then the value of the measure is 0 for any MtmBaseCube without a specified MtmValueExpression.

The default expression specified must be valid for all cubes. Therefore, it must be a constant expression, or it must be a calculation that is based on columns that appear in the table of every cube. If you do not set a default expression, the default value is null.

Parameters:

expression - The default MtmValueExpression for this MtmMeasureMap.