Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2.0.3)

B14351-03 Beta Draft

oracle.AWXML
Class DerivedMeasure

java.lang.Object
  extended by oracle.AWXML.BaseObject
      extended by oracle.AWXML.Measure
          extended by oracle.AWXML.DerivedMeasure
All Implemented Interfaces:
DerivedMeasureInput

public class DerivedMeasure
extends Measure

A Measure the values of which result from mathematical operations or data transformations on values of other Measure objects. For example, the values of a DerivedMeasure can be derived by calculating the averages, totals, percentages, or differences of the values of existing Measure objects.

A DerivedMeasure is owned by a Cube. To create a DerivedMeasure object, use the createDerivedMeasure method of a Cube. To create the DerivedMeasure in the analytic workspace, call the Create method of the DerivedMeasure.

To update the analytic workspace so that it retains the definition of the DerivedMeasure, call the Commit method of the AW. Because the analytic workspace dynamically calculates the values of a DerivedMeasure, you do not need to create AWAction.BuildDatabase and AWAction.Interaction objects to load the data in the measure.

See Also:
OlapMeasure

Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
DerivedMeasure(BaseObject input)
          Creates a DerivedMeasure object and associates it with the specified Cube.
 
Method Summary
 java.lang.String Alter(AWConnection connection)
          Alters textual attributes of the DerivedMeasure in the current analytic workspace of the specified database connection.
 java.lang.String Create(AWConnection connection)
          Creates the DerivedMeasure in the current analytic workspace of the specified database connection.
 java.lang.String Delete(AWConnection connection)
          Deletes the DerivedMeasure in the current analytic workspace of the specified database connection.
 java.lang.String getExpressionText()
          Gets the expression that specifies the operation that results in the values of the DerivedMeasure.
 java.lang.String getId()
          Gets the identifier of the DerivedMeasure.
 boolean isValid()
          Indicates whether the DerivedMeasure is a valid object in the analytic workspace.
 void setExpressionText(java.lang.String input)
          Specifies the calculation that results in the values of the DerivedMeasure.
 java.lang.String WriteToXML()
          Gets an XML representation of the DerivedMeasure.
 
Methods inherited from class oracle.AWXML.Measure
getAutoSolve, getDataType, getSolveDefinition, setAutoSolve, setDataType, setSolveDefinition
 
Methods inherited from class oracle.AWXML.BaseObject
CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DerivedMeasure

public DerivedMeasure(BaseObject input)
Creates a DerivedMeasure object and associates it with the specified Cube. An application should create a DerivedMeasure object by using the createDerivedMeasure method of a Cube.

Parameters:
input - The Cube to own the DerivedMeasure.
Method Detail

getId

public java.lang.String getId()
Gets the identifier of the DerivedMeasure. The identifier is the full name of the DerivedMeasure in the format owner.name.type. For example, the identifier of a DerivedMeasure with the name MARGIN that is owned by a Cube named PRICE_COST_CUBE_AW is PRICE_COST_CUBE_AW.MARGIN.MEASURE.

For more information on object identifiers, see Object Identifiers.

Overrides:
getId in class BaseObject
Returns:
A String that contains the identifier of the Cube.

setExpressionText

public void setExpressionText(java.lang.String input)
Specifies the calculation that results in the values of the DerivedMeasure. For example, the following expression specifies subtracting the values of one Measure from another Measure.

PRICE_COST_CUBE_AW.PRICE_AW.MEASURE - PRICE_COST_CUBE_AW.COST_AW.MEASURE

Parameters:
input - A String that specifies the operation that results in the values of the DerivedMeasure.

getExpressionText

public java.lang.String getExpressionText()
Gets the expression that specifies the operation that results in the values of the DerivedMeasure.

Returns:
A String that specifies the operation that results in the values of the DerivedMeasure.

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the DerivedMeasure.

Overrides:
WriteToXML in class Measure
Returns:
An XML String that represents the DerivedMeasure.

Create

public java.lang.String Create(AWConnection connection)
Creates the DerivedMeasure in the current analytic workspace of the specified database connection.

Overrides:
Create in class Measure
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
An empty String if this method successfully creates the DerivedMeasure.

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the DerivedMeasure in the current analytic workspace of the specified database connection.

Overrides:
Delete in class Measure
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
An empty String if this method successfully deletes the DerivedMeasure.

Alter

public java.lang.String Alter(AWConnection connection)
Alters textual attributes of the DerivedMeasure in the current analytic workspace of the specified database connection.

Overrides:
Alter in class Measure
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
An empty String if this method successfully alters the DerivedMeasure.

isValid

public boolean isValid()
Indicates whether the DerivedMeasure is a valid object in the analytic workspace.

Returns:
A boolean that is true if the DerivedMeasure is valid or false if it is not valid.

Copyright © 2003, 2006 Oracle. All rights reserved.