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

B14351-03 Beta Draft

oracle.AWXML
Class Model

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

public class Model
extends BaseObject

A set of calculations that reference CalculatedMember objects of a non-hierarchical Dimension, such as a dimension of financial line items. A Model has an ordered list of CalculatedMemberRef objects. Each CalculatedMemberRef associates the Model with a CalculatedMember. For a diagram of the class associations of Model, see Model Class Associations.

A ModelRef associates a Model with an AggregationDefinition. When the analytic workspace solves the calculations specified by the AggregationDefinition, it references the CalculatedMember objects in the order in which their associated CalculatedMemberRef objects appear in the list of CalculatedMemberRef objects of the Model.

A Model is owned by a Dimension. To create a Model, call the createModel method of the Dimension.


Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
Model(BaseObject input)
          Creates a Model for the specified Dimension.
 
Method Summary
 void addCalculatedMemberRef(CalculatedMemberRef input)
          Adds the specified CalculatedMemberRef to the end of the list of CalculatedMemberRef objects of the Model.
 void addCalculatedMemberRefAfter(CalculatedMemberRef input, BaseObject reference)
          Adds the specified CalculatedMemberRef after the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.
 void addCalculatedMemberRefBefore(CalculatedMemberRef input, BaseObject reference)
          Adds the specified CalculatedMemberRef before the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.
 void addCalculatedMemberRefFirst(CalculatedMemberRef input)
          Adds the specified CalculatedMemberRef at the beginning of the list of CalculatedMemberRef objects of the Model.
 java.lang.String Create(AWConnection connection)
          Creates the Model in the current analytic workspace of the specified database connection.
 CalculatedMemberRef createCalculatedMemberRef()
          Creates a new CalculatedMemberRef and adds it at the end of the list of CalculatedMemberRef objects of the Model.
 CalculatedMemberRef createCalculatedMemberRefAfter(CalculatedMemberRef input)
          Creates a new CalculatedMemberRef and adds it to the list of CalculatedMemberRef objects after the specified CalculatedMemberRef.
 CalculatedMemberRef createCalculatedMemberRefBefore(CalculatedMemberRef input)
          Creates a new CalculatedMemberRef and adds it to the list of CalculatedMemberRef objects before the specified CalculatedMemberRef.
 CalculatedMemberRef createCalculatedMemberRefFirst()
          Creates a new CalculatedMemberRef and adds it at the beginning of the list of CalculatedMemberRef objects.
 java.lang.String Delete(AWConnection connection)
          Deletes the Model in the current analytic workspace of the specified database connection.
 java.lang.String getAggregationText()
          Gets the name of the Model.
 java.util.Vector getCalculatedMemberRefs()
          Gets the list of CalculatedMemberRef objects of the Model.
 Dimension getDimension()
          Gets the Dimension that owns the Model.
 void removeCalculatedMemberRef(CalculatedMemberRef input)
          Removes the specified CalculatedMemberRef from the list of CalculatedMemberRef objects of the Model.
 java.lang.String WriteToXML()
          Gets an XML representation of the Model.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, 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

Model

public Model(BaseObject input)
Creates a Model for the specified Dimension. An application should use the createModel method of the Dimension rather than this constructor to create a Model.

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

addCalculatedMemberRef

public void addCalculatedMemberRef(CalculatedMemberRef input)
Adds the specified CalculatedMemberRef to the end of the list of CalculatedMemberRef objects of the Model.

Parameters:
input - The CalculatedMemberRef to add to the list.

addCalculatedMemberRefAfter

public void addCalculatedMemberRefAfter(CalculatedMemberRef input,
                                        BaseObject reference)
Adds the specified CalculatedMemberRef after the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.

Parameters:
input - The CalculatedMemberRef to add to the list.
reference - The CalculatedMemberRef after which to add the CalculatedMemberRef.

addCalculatedMemberRefBefore

public void addCalculatedMemberRefBefore(CalculatedMemberRef input,
                                         BaseObject reference)
Adds the specified CalculatedMemberRef before the referenced CalculatedMemberRef in the list of CalculatedMemberRef objects of the Model.

Parameters:
input - The CalculatedMemberRef to add to the list.
reference - The code>CalculatedMemberRef before which to add the CalculatedMemberRef.

addCalculatedMemberRefFirst

public void addCalculatedMemberRefFirst(CalculatedMemberRef input)
Adds the specified CalculatedMemberRef at the beginning of the list of CalculatedMemberRef objects of the Model.

Parameters:
input - The CalculatedMemberRef to add at the beginning of the list.

removeCalculatedMemberRef

public void removeCalculatedMemberRef(CalculatedMemberRef input)
Removes the specified CalculatedMemberRef from the list of CalculatedMemberRef objects of the Model.

Parameters:
input - The CalculatedMemberRef to remove from the list.

getCalculatedMemberRefs

public java.util.Vector getCalculatedMemberRefs()
Gets the list of CalculatedMemberRef objects of the Model.

Returns:
A Vector of CalculatedMemberRef objects.

createCalculatedMemberRef

public CalculatedMemberRef createCalculatedMemberRef()
Creates a new CalculatedMemberRef and adds it at the end of the list of CalculatedMemberRef objects of the Model.

Returns:
The new CalculatedMemberRef.

createCalculatedMemberRefAfter

public CalculatedMemberRef createCalculatedMemberRefAfter(CalculatedMemberRef input)
Creates a new CalculatedMemberRef and adds it to the list of CalculatedMemberRef objects after the specified CalculatedMemberRef.

Parameters:
input - The CalculatedMemberRef after which to add the new CalculatedMemberRef.
Returns:
The new CalculatedMemberRef.

createCalculatedMemberRefBefore

public CalculatedMemberRef createCalculatedMemberRefBefore(CalculatedMemberRef input)
Creates a new CalculatedMemberRef and adds it to the list of CalculatedMemberRef objects before the specified CalculatedMemberRef.

Parameters:
input - The CalculatedMemberRef before which to add the new CalculatedMemberRef.
Returns:
The new CalculatedMemberRef.

createCalculatedMemberRefFirst

public CalculatedMemberRef createCalculatedMemberRefFirst()
Creates a new CalculatedMemberRef and adds it at the beginning of the list of CalculatedMemberRef objects.

Returns:
The new CalculatedMemberRef.

WriteToXML

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

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

getDimension

public Dimension getDimension()
Gets the Dimension that owns the Model.

Returns:
The owning Dimension.

getAggregationText

public java.lang.String getAggregationText()
Gets the name of the Model.

Returns:
A String that contains the name.

Create

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

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

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the Model 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 this method successfully creates the Model.

Copyright © 2003, 2006 Oracle. All rights reserved.