oracle.olapi.metadata.mdm
Class MdmMeasure

java.lang.Object
  oracle.olapi.metadata.BaseMetadataObject
      oracle.olapi.metadata.mdm.MdmObject
          oracle.olapi.metadata.mdm.MdmSource
              oracle.olapi.metadata.mdm.MdmDimensionedObject
                  oracle.olapi.metadata.mdm.MdmMeasure

All Implemented Interfaces:

MdmMember, MdmViewColumnOwner, MetadataObject

Direct Known Subclasses:

MdmBaseMeasure, MdmDerivedMeasure

public abstract class MdmMeasure
extends MdmDimensionedObject
implements MdmMember, MdmViewColumnOwner

An MdmDimensionedObject that represents a set of data to use in analytical processing. An MdmMeasure is owned by an MdmCube. The dimensionality of the MdmMeasure is defined by the MdmCube. The type of an MdmMeasure is based on the data type of the information that the MdmMeasure represents.

Method Summary

void	addDimensionality(MdmDimensionality value) Adds an MdmDimensionality to the MdmMeasure.
MdmCube	getCube() Gets the MdmCube that is associated with this MdmMeasure.
java.util.List	getDimensionality() Gets the MdmDimensionality objects that are associated with the MdmMeasure.
MdmViewColumn	getETMeasureColumn() Gets the ET (Embedded Totals) column for the MdmMeasure.
MdmLevel	getLevel() Gets the MdmLevel of the MdmMeasureDimension of which the MdmMeasure is a member.
int	getLevelDepth() Because an MdmMeasureDimension has only one level, this method returns 0.
java.lang.String	getLocalValue() Gets the local value of this MdmMeasure, which is its name.
MdmMeasureDimension	getMeasureDimension() Gets the MdmMeasureDimension of the MdmRootSchema.
MdmMeasureModel	getMeasureModel() Gets the MdmMeasureModel for the MdmMeasure.
MdmModel	getModel() Gets the MdmModel for the MdmMeasure.
MdmPrimaryDimension	getOwnerDimension() Gets the MdmPrimaryDimension of which this MdmMeasure is a member.
MdmLevel	getParentLevel() Because an MdmMeasure does not have a parent in a dimension hierarchy, this method returns null.
java.lang.String	getParentLocalValue() Because an MdmMeasure does not have a parent in a dimension hierarchy, this method returns null.
java.lang.String	getParentValue() Because an MdmMeasure does not have a parent in a dimension hierarchy, this method returns null.
int	getPrecedence() Gets the precedence of this MdmMeasure.
MetadataObject	getType() Gets the OLAP Java API data type for the MdmMeasure.
java.lang.String	getUnits() Gets the type of units specified for this MdmMeasure.
java.lang.String	getValue() Gets the value of this MdmMeasure, which is the identifier for the Source for this MdmMeasure.
java.lang.String	getValueFormat() Gets the format specified for the values of this MdmMeasure.
void	removeDimensionality(MdmDimensionality value) Removes an MdmDimensionality from the MdmMeasure.
void	setCube(MdmCube input) Specifies the MdmCube to associate with this MdmMeasure.
void	setMeasureModel(MdmMeasureModel model) Specifies an MdmMeasureModel for the MdmMeasure.
void	setModel(MdmModel model) Specifies an MdmModel for the MdmMeasure.
void	setPrecedence(int precedence) Specifies a precedence to use as the default precedence for the Assignment objects of the MdmMeasureModel for the MdmMeasure, with the higher integer value indicating a higher precedence.
void	setUnits(java.lang.String newUnits) Specifies a type of units for the values of this MdmMeasure.
void	setValueFormat(java.lang.String formatString) Specifies a format for the values of this MdmMeasure.

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

addDimension, getDimensions, isBooleanValued, setBooleanValued

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

getDataType, getSource

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

acceptVisitor, addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getName, 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

Methods inherited from interface oracle.olapi.metadata.mdm.MdmMember

getDataType, getDescription, getShortDescription, getSource

Method Detail

getValue

public java.lang.String getValue()

Gets the value of this MdmMeasure, which is the identifier for the Source for this MdmMeasure.

Specified by:

getValue in interface MdmMember

Returns:

A String that is the identifier for the Source for this MdmMeasure.

getLocalValue

public java.lang.String getLocalValue()

Gets the local value of this MdmMeasure, which is its name.

Specified by:

getLocalValue in interface MdmMember

Returns:

A String that contains the local value of this MdmMeasure.

getOwnerDimension

public MdmPrimaryDimension getOwnerDimension()

Gets the MdmPrimaryDimension of which this MdmMeasure is a member. An MdmMeasure can be a member of an MdmMeasureDimension.

Specified by:

getOwnerDimension in interface MdmMember

Returns:

The MdmPrimaryDimension of which this MdmMeasure is a member.

getMeasureDimension

public MdmMeasureDimension getMeasureDimension()

Gets the MdmMeasureDimension of the MdmRootSchema. All MdmMeasure objects provided by the MdmMetadataProvider are members of that MdmMeasureDimension.

Returns:

The MdmMeasureDimension of the MdmRootSchema.

getLevel

public MdmLevel getLevel()

Gets the MdmLevel of the MdmMeasureDimension of which the MdmMeasure is a member.

Specified by:

getLevel in interface MdmMember

Returns:

The MdmLevel of the MdmMeasureDimension.

getLevelDepth

public int getLevelDepth()

Because an MdmMeasureDimension has only one level, this method returns 0.

Specified by:

getLevelDepth in interface MdmMember

Returns:

An integer that indicates the level of this MdmMeasure in the MdmMeasureDimension.

getParentValue

public java.lang.String getParentValue()

Because an MdmMeasure does not have a parent in a dimension hierarchy, this method returns null.

Specified by:

getParentValue in interface MdmMember

Returns:

This method returns null.

getParentLocalValue

public java.lang.String getParentLocalValue()

Because an MdmMeasure does not have a parent in a dimension hierarchy, this method returns null.

Specified by:

getParentLocalValue in interface MdmMember

Returns:

This method returns null.

getParentLevel

public MdmLevel getParentLevel()

Because an MdmMeasure does not have a parent in a dimension hierarchy, this method returns null.

Specified by:

getParentLevel in interface MdmMember

Returns:

This method returns null.

getPrecedence

public int getPrecedence()

Gets the precedence of this MdmMeasure.

Specified by:

getPrecedence in interface MdmMember

Returns:

An integer that specifies the precedence of this MdmMeasure.

getValueFormat

public java.lang.String getValueFormat()

Gets the format specified for the values of this MdmMeasure.

Returns:

A String that specifes an Oracle COLUMN FORMAT for the values of this MdmMeasure.

setValueFormat

public void setValueFormat(java.lang.String formatString)

Specifies a format for the values of this MdmMeasure.

Parameters:

formatString - A String that specifes an Oracle COLUMN FORMAT to use for the values of this MdmMeasure.

getUnits

public java.lang.String getUnits()

Gets the type of units specified for this MdmMeasure.

Returns:

A String that indicates the type of units for the values of this MdmMeasure.

setUnits

public void setUnits(java.lang.String newUnits)

Specifies a type of units for the values of this MdmMeasure. For example, the following code specifies kilograms as the type of units for the values of the MdmMeasure mdmWeight.

 mdmWeight.setUnits("kilograms");

Parameters:

newUnits - A String that indicates the type of units for the values of this MdmMeasure.

setPrecedence

public void setPrecedence(int precedence)

Specifies a precedence to use as the default precedence for the Assignment objects of the MdmMeasureModel for the MdmMeasure, with the higher integer value indicating a higher precedence. Oracle OLAP uses the precedence value in determining the order in which it evaluates the Assignment objects in calculations that involve more than one measure.

Parameters:

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

getCube

public final MdmCube getCube()

Gets the MdmCube that is associated with this MdmMeasure.

Returns:

The MdmCube associated with this MdmMeasure.

setCube

public final void setCube(MdmCube input)

Specifies the MdmCube to associate with this MdmMeasure.

Parameters:

input - The MdmCube to associate with this MdmMeasure.

getDimensionality

public final java.util.List getDimensionality()

Gets the MdmDimensionality objects that are associated with the MdmMeasure. An MdmDimensionality contains a reference to an MdmDimension.

Overrides:

getDimensionality in class MdmDimensionedObject

Returns:

A List of the MdmDimensionality objects associated with the MdmMeasure.

addDimensionality

public final void addDimensionality(MdmDimensionality value)

Adds an MdmDimensionality to the MdmMeasure.

Overrides:

addDimensionality in class MdmDimensionedObject

Parameters:

value - The MdmDimensionality to add to the MdmMeasure.

removeDimensionality

public final void removeDimensionality(MdmDimensionality value)

Removes an MdmDimensionality from the MdmMeasure.

Overrides:

removeDimensionality in class MdmDimensionedObject

Parameters:

value - The MdmDimensionality to remove from the MdmMeasure.

getMeasureModel

public final MdmMeasureModel getMeasureModel()

Gets the MdmMeasureModel for the MdmMeasure.

Returns:

The MdmMeasureModel for the MdmMeasure.

getModel

public final MdmModel getModel()

Gets the MdmModel for the MdmMeasure. The MdmModel is an instance of MdmMeasureModel.

Overrides:

getModel in class MdmSource

Returns:

The MdmModel for the MdmMeasure.

setMeasureModel

public final void setMeasureModel(MdmMeasureModel model)

Specifies an MdmMeasureModel for the MdmMeasure.

Parameters:

model - The MdmMeasureModel to associate with the MdmMeasure.

setModel

public final void setModel(MdmModel model)

Specifies an MdmModel for the MdmMeasure. The MdmModel must be an instance of MdmMeasureModel.

Overrides:

setModel in class MdmSource

Parameters:

model - The MdmModel to associate with the MdmMeasure.

getETMeasureColumn

public final MdmViewColumn getETMeasureColumn()

Gets the ET (Embedded Totals) column for the MdmMeasure.

Returns:

The MdmViewColumn that represents the ET column.

getType

public final MetadataObject getType()

Gets the OLAP Java API data type for the MdmMeasure.

Specified by:

getType in class MdmSource

Returns:

A MetadataObject that represents the OLAP Java API data type.