oracle.dss.metadataManager.common
Class MDMeasure

java.lang.Object
  |
  +--oracle.dss.metadataUtil.PropertyBag
        |
        +--oracle.dss.metadataManager.common.MDObject
              |
              +--oracle.dss.metadataManager.common.MDMeasure

All Implemented Interfaces:

java.io.Serializable

public class MDMeasure

extends MDObject

A client-side representation of a measure in an analytic workspace. An MDMeasure provides, to a java client, information about a measure in the workspace.

A measure represents data in an analytic workspace. The data is usually numeric and additive. Examples of measures are Sales, Cost, and Profit.

See Also:

Serialized Form

Method Summary

java.lang.String	getDataType() Retrieves the data type of this measure.
MDDimension[]	getDimensions() Retrieves the dimensions of this measure.
MDFolder	getFolder() Retrieves the folder that contains this MDMeasure.
MDFolder[]	getFolders() Retrieves the folders that contain this measure.
java.lang.String	getNumberFormatString() Retrieves the number format mask that specifies how a number should be formatted.
int	setDimensions(MDDimension[] dimensions) Specifies the dimensions of this measure.
int	setFolder(MDFolder folder) Specifies a folder that contains this measure.
void	setNumberFormatString(java.lang.String strNumberFormatString) Specifies how a number should be formatted based on the specified format mask.

Methods inherited from class oracle.dss.metadataManager.common.MDObject

getClassName, getDescription, getDriverType, getDriverTypes, getLabel, getLongLabel, getMetadataManagerServices, getName, getObjectType, getPath, getShortLabel, getSubObjectType, getUniqueID, nameEquals, setClassName, setDriverType, setMetadataManagerServices, setName, setObjectType, setSubObjectType, toString, toString

Methods inherited from class oracle.dss.metadataUtil.PropertyBag

getIntPropertyValue, getLongPropertyValue, getObjPropertyValue, getPropertyDataType, getStringVectorPropertyValue, getStrPropertyValue, mergePropertyBags, removeProperty, setIntPropertyValue, setIntPropertyValue, setLongPropertyValue, setLongPropertyValue, setObjPropertyValue, setObjPropertyValue, setProperty, setPropertyBag, setStringVectorPropertyValue, setStringVectorPropertyValue, setStrPropertyValue, setStrPropertyValue, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFolder

public MDFolder getFolder()
                   throws MetadataManagerException

Retrieves the folder that contains this MDMeasure.

Returns:

The folder that contains this MDMeasure.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getFolders

public MDFolder[] getFolders()
                      throws MetadataManagerException

Retrieves the folders that contain this measure.

Returns:

The folders that contain this measure.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

setFolder

public int setFolder(MDFolder folder)
              throws MetadataManagerException

Specifies a folder that contains this measure. Call this method on a custom measure only. You cannot change the location of a measure that is stored in the analytic workspace.

Parameters:

folder - A MDFolder object that this measure uses.

Returns:

A constant that represents success or failure. Possible constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getDimensions

public MDDimension[] getDimensions()
                            throws MetadataManagerException

Retrieves the dimensions of this measure. For example, for a Sales measure, the dimensions might be Product, Time, and Geography.

Returns:

The dimensions of this measure.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

setDimensions

public int setDimensions(MDDimension[] dimensions)

Specifies the dimensions of this measure. Call this method on a custom measure only. You cannot change the dimensionality of a measure that is stored in the analytic workspace.

Parameters:

dimensions - An array of MDDimension objects, one for each dimension of this measure.

Returns:

A constant that represents success or failure. Possible constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getDataType

public java.lang.String getDataType()

Retrieves the data type of this measure.

Returns:

A constant that represents the data type. The valid constants are listed in the See Also section.

See Also:

MM.BOOLEAN, MM.SHORT, MM.INTEGER, MM.LONG, MM.FLOAT, MM.DOUBLE, MM.STRING

setNumberFormatString

public void setNumberFormatString(java.lang.String strNumberFormatString)

Specifies how a number should be formatted based on the specified format mask.

Parameters:

strNumberFormatString - A String value which contains the number format mask.

See Also:

oracle.dss.metadataManager.common.MM#NUMBER_FORMAT_STRING

getNumberFormatString

public java.lang.String getNumberFormatString()

Retrieves the number format mask that specifies how a number should be formatted.

Returns:

String which is the number format mask being used.

See Also:

oracle.dss.metadataManager.common.MM#NUMBER_FORMAT_STRING