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

B14351-03 Beta Draft

oracle.AWXML
Class CalculatedMemberRef

java.lang.Object
  extended by oracle.AWXML.BaseObject
      extended by oracle.AWXML.CalculatedMemberRef

public class CalculatedMemberRef
extends BaseObject

A reference to a CalculatedMember for a Model. A CalculatedMember is a Dimension member that specifies a calculation. A Model owns an ordered list of CalculatedMemberRef objects.

See Also:
Model

Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
CalculatedMemberRef(BaseObject input)
          Creates a CalculatedMemberRef for the specified Model.
 
Method Summary
 java.lang.String Create(AWConnection connection)
          Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it to the end of the list of CalculatedMemberRef objects of the Model.
 java.lang.String CreateAfter(AWConnection connection, BaseObject referencedObj)
          Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it after the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.
 java.lang.String CreateBefore(AWConnection connection, BaseObject referencedObj)
          Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it before the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.
 java.lang.String CreateFirst(AWConnection connection)
          Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it to the beginning of the list of CalculatedMemberRef objects of the Model.
 java.lang.String Delete(AWConnection connection)
          Deletes the CalculatedMemberRef in the current analytic workspace of the specified database connection.
 CalculatedMember getCalculatedMember()
          Gets the CalculatedMember that the CalculatedMemberRef references.
 void setCalculatedMember(CalculatedMember input)
          Specifies the CalculatedMember that the CalculatedMemberRef references.
 java.lang.String WriteToXML()
          Gets an XML representation of the CalculatedMemberRef.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, 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

CalculatedMemberRef

public CalculatedMemberRef(BaseObject input)
Creates a CalculatedMemberRef for the specified Model. An application should create a CalculatedMemberRef by using a createCalculatedMemberRef method of the Model.

Parameters:
input - The Model to own the new CalculatedMemberRef.
Method Detail

WriteToXML

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

Overrides:
WriteToXML in class BaseObject
Returns:
A String that contains an XML representation of the CalculatedMemberRef.

getCalculatedMember

public CalculatedMember getCalculatedMember()
Gets the CalculatedMember that the CalculatedMemberRef references.

Returns:
The CalculatedMember referenced by the CalculatedMemberRef.

setCalculatedMember

public void setCalculatedMember(CalculatedMember input)
Specifies the CalculatedMember that the CalculatedMemberRef references.

Parameters:
input - The CalculatedMember to reference.

Create

public java.lang.String Create(AWConnection connection)
Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it to the end of the list of CalculatedMemberRef objects of the Model.

Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains success if the method succeeds.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)
Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it to the beginning of the list of CalculatedMemberRef objects of the Model.

Overrides:
CreateFirst in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains success if the method succeeds.

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)
Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it after the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.

Overrides:
CreateAfter in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
referencedObj - The CalculatedMemberRef after which to add the new CalculatedMemberRef.
Returns:
A String that contains success if the method succeeds.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)
Creates the CalculatedMemberRef in the current analytic workspace of the specified database connection and adds it before the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.

Overrides:
CreateBefore in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
referencedObj - The CalculatedMemberRef before which to add the new CalculatedMemberRef.
Returns:
A String that contains success if the method succeeds.

Delete

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

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

Copyright © 2003, 2006 Oracle. All rights reserved.