Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)

B12180-01

oracle.AWXML
Class Model

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Model

public class Model
extends BaseObject

A set of calculations to be performed on a dimension. The calculations are formulated as a model in the OLAP DML. The result of a model is a set of dimension members. A model can be included in an aggregation map, often to specify the aggregation of a non-hierarchical dimension.

Use the following link to view a graphical representation of oracle.AWXML.Model.

OLAP Analytic Workspace Modeling Model


Fields inherited from class oracle.AWXML.BaseObject
AWNULL, DATABASENULL, m_commandResults, m_commandResultText, m_id, m_listResults, m_longName, m_name, m_owner, m_pluralName, m_schema, m_shortName, s_EndElementTag, s_EndEndTag, s_EndStartTag, s_EndTag, s_Indent, s_JAVA_LINEEND, s_NEWLINE, s_objectCounter, s_StartEndTag, s_StartStartTag

 

Constructor Summary
Model()
          Default Constructor
Model(BaseObject input)
          Constructor that takes the owner of this object.

 

Method Summary
 void addCalculatedMemberRef(CalculatedMemberRef input)
          Adds a CalculatedMemberRef to the model.
 void addCalculatedMemberRefAfter(CalculatedMemberRef input, BaseObject reference)
          Adds a CalculatedMemberRef after the referenced object.
 void addCalculatedMemberRefBefore(CalculatedMemberRef input, BaseObject reference)
          Adds a CalculatedMemberRef before the referenced object.
 void addCalculatedMemberRefFirst(CalculatedMemberRef input)
          Adds a CalculatedMemberRef as the first CalculatedMemberRef in the model.
 java.lang.String Create(AWConnection connection)
          Creates a new model in the analytic workspace.
 CalculatedMemberRef createCalculatedMemberRef()
          Creates a new calculated dimension member in the model
 CalculatedMemberRef createCalculatedMemberRefAfter(CalculatedMemberRef input)
          Creates a new calculated dimension member after the referenced calculated dimension member.
 CalculatedMemberRef createCalculatedMemberRefBefore(CalculatedMemberRef input)
          Creates a new calculated dimension member before the referenced calculated dimension member.
 CalculatedMemberRef createCalculatedMemberRefFirst()
          Creates a new calculated dimension member as the first calculated dimension member in the model.
 java.lang.String Delete(AWConnection connection)
          Removes a model from the analytic workspace.
 java.lang.String getAggregationText()
          Returns the OLAP DML aggregation commands in the model.
 java.util.Vector getCalculatedMemberRefs()
          Returns the calculated dimension members in the model
 java.lang.String getContents()
          Returns the OLAP DML commands that make up the model.
 Dimension getDimension()
          Returns the dimension to which the model applies.
 java.lang.String getId()
          Returns the full name of the object.
 void removeCalculatedMemberRef(CalculatedMemberRef input)
          Removes a CalculatedMemberRef from the model.
 void setContents(java.lang.String input)
          Assigns OLAP DML commands to the model.
 void setDimension(Dimension input)
          Sets the dimension to which the model applies.
 java.lang.String WriteToXML()
          Returns the object as an XML string.

 

Methods inherited from class oracle.AWXML.BaseObject
Alter, CreateAfter, CreateBefore, CreateFirst, getLongName, getName, getOwner, getParentId, getPluralName, getSchema, getShortName, setLongName, setName, setPluralName, setSchema, setShortName

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

Model

public Model()
Default Constructor

Model

public Model(BaseObject input)
Constructor that takes the owner of this object.
Parameters:
input - BaseObject that is the owner of this object in the object model
Method Detail

getId

public java.lang.String getId()
Returns the full name of the object.
Overrides:
getId in class BaseObject
Returns:
String

addCalculatedMemberRef

public void addCalculatedMemberRef(CalculatedMemberRef input)
Adds a CalculatedMemberRef to the model.
Parameters:
input - CalculatedMemberRef

addCalculatedMemberRefAfter

public void addCalculatedMemberRefAfter(CalculatedMemberRef input,
BaseObject reference)
Adds a CalculatedMemberRef after the referenced object.
Parameters:
input - CalculatedMemberRef
reference - BaseObject

addCalculatedMemberRefBefore

public void addCalculatedMemberRefBefore(CalculatedMemberRef input,
BaseObject reference)
Adds a CalculatedMemberRef before the referenced object.
Parameters:
input - CalculatedMemberRef
reference - BaseObject

addCalculatedMemberRefFirst

public void addCalculatedMemberRefFirst(CalculatedMemberRef input)
Adds a CalculatedMemberRef as the first CalculatedMemberRef in the model.
Parameters:
input - CalculatedMemberRef

removeCalculatedMemberRef

public void removeCalculatedMemberRef(CalculatedMemberRef input)
Removes a CalculatedMemberRef from the model.
Parameters:
input - CalculatedMemberRef

getCalculatedMemberRefs

public java.util.Vector getCalculatedMemberRefs()
Returns the calculated dimension members in the model
Returns:
Vector

createCalculatedMemberRef

public CalculatedMemberRef createCalculatedMemberRef()
Creates a new calculated dimension member in the model
Returns:
The new CalculatedMemberRef

createCalculatedMemberRefAfter

public CalculatedMemberRef createCalculatedMemberRefAfter(CalculatedMemberRef input)
Creates a new calculated dimension member after the referenced calculated dimension member.
Parameters:
input - CalculatedMemberRef
Returns:
The new CalculatedMemberRef

createCalculatedMemberRefBefore

public CalculatedMemberRef createCalculatedMemberRefBefore(CalculatedMemberRef input)
Creates a new calculated dimension member before the referenced calculated dimension member.
Parameters:
input - CalculatedMemberRef
Returns:
The new CalculatedMemberRef

createCalculatedMemberRefFirst

public CalculatedMemberRef createCalculatedMemberRefFirst()
Creates a new calculated dimension member as the first calculated dimension member in the model.
Returns:
The new CalculatedMemberRef

WriteToXML

public java.lang.String WriteToXML()
Returns the object as an XML string.
Overrides:
WriteToXML in class BaseObject
Returns:
A String containing the XML that represents the object

getContents

public java.lang.String getContents()
Returns the OLAP DML commands that make up the model.
Returns:
String containing the OLAP DML commands

setContents

public void setContents(java.lang.String input)
Assigns OLAP DML commands to the model.
Parameters:
String - containing the OLAP DML commands

getDimension

public Dimension getDimension()
Returns the dimension to which the model applies.
Returns:
Dimension

setDimension

public void setDimension(Dimension input)
Sets the dimension to which the model applies.
Parameters:
input - Dimension

getAggregationText

public java.lang.String getAggregationText()
Returns the OLAP DML aggregation commands in the model.
Returns:
String containing the OLAP DML aggregation commands.

Create

public java.lang.String Create(AWConnection connection)
Creates a new model in the analytic workspace.
Overrides:
Create in class BaseObject
Parameters:
connection - AWConnection
Returns:
String containing "success" if successful

Delete

public java.lang.String Delete(AWConnection connection)
Removes a model from the analytic workspace.
Overrides:
Delete in class BaseObject
Parameters:
connection - AWConnection
Returns:
String containing "success" if successful

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)

B12180-01

Copyright © 2003, Oracle. All Rights Reserved.