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

B14351-04

oracle.AWXML
Class ModelRef

java.lang.Object
  extended byoracle.AWXML.BaseObject
      extended byoracle.AWXML.CalculationSpecification
          extended byoracle.AWXML.ModelRef

public class ModelRef
extends CalculationSpecification

A reference to a Model in an AggregationDefinition. An AggregationDefinition has a list of CalculationSpecification objects. The position in the list determines the order in which the analytic workspace performs the calculations specified by the CalculationSpecification objects.


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

ModelRef

public ModelRef(BaseObject input)
Creates a new ModelRef for the specified AggregationDefinition. An application should use one of the createModelRef methods of the AggregationDefinition rather than this constructor to create a ModelRef.

Parameters:
input - The AggregationDefinition to own the new ModelRef.
Method Detail

WriteToXML

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

Overrides:
WriteToXML in class CalculationSpecification
Returns:
An XML String that represents the ModelRef.

getModel

public Model getModel()
Gets the Model that the ModelRef references.

Returns:
The Model referenced by the ModelRef.

setModel

public void setModel(Model input)
Specifies the Model that the ModelRef references.

Parameters:
input - The Model referenced by the ModelRef.

Create

public java.lang.String Create(AWConnection connection)
Creates the ModelRef in the current analytic workspace of the specified database connection and adds it to the end of the list of CalculationSpecification objects of the AggregationDefinition that owns it.

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

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)
Creates the ModelRef in the current analytic workspace of the specified database connection and adds it to the beginning of the list of CalculationSpecification objects of the AggregationDefinition that owns it.

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

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)
Creates the ModelRef in the current analytic workspace of the specified database connection and adds it after the referenced CalculationSpecification to the list of CalculationSpecification objects of the AggregationDefinition that owns it.

Overrides:
CreateAfter in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
referencedObj - The CalculationSpecification after which to add the ModelRef.
Returns:
A String that contains success if this method successfully creates the ModelRef.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)
Creates the ModelRef in the current analytic workspace of the specified database connection and adds it before the referenced CalculationSpecification to the list of CalculationSpecification objects of the AggregationDefinition that owns it.

Overrides:
CreateBefore in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
referencedObj - The CalculationSpecification before which to add the ModelRef.
Returns:
A String that contains success if this method successfully creates the ModelRef.

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the ModelRef 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 deletes the ModelRef.

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

B14351-04

Copyright © 2003, 2007 Oracle. All rights reserved.