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

public class MdmMeasure

extends MdmDimensionedObject

An MdmDimensionedObject that represents a set of data to be used in analytical processing. A typical MdmMeasure is based on an OLAP Catalog measure that was created by a database administrator. In most cases, the database administrator specified a column in a fact table to act as the basis for the OLAP measure (occasionally, the database administrator specified a mathematical operation or a data transformation on more than one column instead). You can create custom MdmMeasure objects with methods of an MdmCustomObjectFactory such as createNumericMeasure or createStringMeasure.

The type of an MdmMeasure is based on the data type of the information that the MdmMeasure represents. In most cases, the return value of the getType method on an MdmMeasure is the FundamentalMetadataObject that represents an OLAP API data type such as Integer or Boolean.

Because an MdmMeasure is a metadata object, it describes the structure and characteristics of a set of data, but it does not provide the ability to create queries on the data. To create a query on the data represented by an MdmMeasure, an application must get the Source for the MdmMeasure.

getMeasureMap

public MtmMeasureMap getMeasureMap()
                            throws MetadataNotFoundException

Gets the MtmMeasureMap for this MdmMeasure. The MtmMeasureMap maps the elements of this MdmMeasure to data in the relational database.

Returns:

The MtmMeasureMap for 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 labels the type of units for the values of this MdmMeasure.

See Also:

setUnits(java.lang.String)

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 specifying the type of units for the values of this MdmMeasure.

acceptVisitor

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

Calls the visitMdmMeasure method in the specified MdmObjectVisitor and passes that method this MdmObject and the specified context object.

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmMeasure method.

Overrides:

acceptVisitor in class MdmObject