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

B14351-03 Beta Draft

oracle.AWXML
Class CalculatedMember

java.lang.Object
  extended by oracle.AWXML.BaseObject
      extended by oracle.AWXML.CalculatedMember
Direct Known Subclasses:
PermanentCalculatedMember, SessionCalculatedMember

public abstract class CalculatedMember
extends BaseObject

An abstract class that represents a Dimension member that specifies a calculation that involves other Dimension members. After you build the analytic workspace with the CalculatedMember, a Measure dimensioned by the Dimension has the calculated value for the CalculatedMember. For a diagram of the class associations of CalculatedMember, see CalculatedMember Associations.

You specify the Dimension member value with the setName method. You specify the calculation with the setExpressionText method.

A CalculatedMember requires an associated Model.


Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
CalculatedMember(BaseObject input)
          Creates a CalculatedMember for the specified Dimension.
 
Method Summary
 java.lang.String Alter(AWConnection connection)
          Alters the textual attributes of the CalculatedMember in the current analytic workspace of the specified database connection.
 java.lang.String Delete(AWConnection connection)
          Deletes the CalculatedMember in the current analytic workspace of the specified database connection.
 java.lang.String getExpressionText()
          Gets the expression that specifies the calculation for the CalculatedMember.
 void setExpressionText(java.lang.String input)
          Specifies the calculation for the CalculatedMember.
 java.lang.String WriteToXML()
          Gets an XML representation of the CalculatedMember.
 
Methods inherited from class oracle.AWXML.BaseObject
Create, CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getId, 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

CalculatedMember

public CalculatedMember(BaseObject input)
Creates a CalculatedMember for the specified Dimension. An application should create a CalculatedMember by using the createPermanentCalculatedMember or createSessionCalculatedMember methods of the Dimension.

Parameters:
input - The Dimension to own the new CalculatedMember.
Method Detail

WriteToXML

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

Overrides:
WriteToXML in class BaseObject
Returns:
An XML String that represents the CalculatedMember.

getExpressionText

public java.lang.String getExpressionText()
Gets the expression that specifies the calculation for the CalculatedMember.

Returns:
A String that contains the expression that specifies the calcualation for the CalculatedMember.

setExpressionText

public void setExpressionText(java.lang.String input)
Specifies the calculation for the CalculatedMember. The analytic workspace uses the value that results from the calculation as the value of a Measure that is specified by the CalculatedMember.

Parameters:
input - A String that contains the expression that produces the Measure value specified by the CalculatedMember.

Delete

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

Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that represents the connection.
Returns:
A String that contains success if the method successfully deletes the CalculatedMember.

Alter

public java.lang.String Alter(AWConnection connection)
Alters the textual attributes of the CalculatedMember in the current analytic workspace of the specified database connection. You can use the Alter method to change the descriptive names associated with the CalculatedMember. For example, you can change the long and short descriptions and the plural name of the object.

Overrides:
Alter in class BaseObject
Parameters:
connection - The AWConnection that represents the connection.
Returns:
An empty String if the method successfully alters the CalculatedMember.

Copyright © 2003, 2006 Oracle. All rights reserved.