oracle.AWXML
Class CalculationSpecification

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

Direct Known Subclasses:

Aggregation, ModelRef

public abstract class CalculationSpecification

extends BaseObject

An abstract class that specifies how to aggregate data over a dimension.

An AggregationDefinition owns an ordered set of CalculationSpecification objects, each one specifying how to aggregate the data along one of its dimensions. Position within the calculation list determines when each calculation is performed.

A CalculationSpecification can be either an Aggregation or a ModelRef. An Aggregation specifies the aggregation instructions for a hierarchical dimension. A ModelRef references a predefined Model to specify aggregation instructions, typically for non-hierarchical dimensions such as line items.

An AggregationDefinition is implemented in the OLAP DML as an aggmap object for aggregation. Each CalculationSpecification is either a RELATION statement or a MODEL statement in the aggmap.

For more information, see the OLAP DML Reference.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

CalculationSpecification(BaseObject input)
Creates a new CalculationSpecification for the specified AggregationDefinition.

Method Summary

java.lang.String	Create(AWConnection connection) Creates the CalculationSpecification in the current analytic workspace of the specified database connection.
java.lang.String	getAggregationText(AWConnection connection) Returns the OLAP DML RELATION or MODEL statement implemented by the CalculationSpecification in the current analytic workspace of the specified database connection.
int	getCalculationOrder() Returns the integer position within the calculation list.
void	setCalculationOrder(int input) Sets the position within the calculation list to the specified integer.
void	setCalculationOrder(java.lang.String input) Sets the position within the calculation list to the integer associated with the specified String.
java.lang.String	WriteToXML() Returns the CalculationSpecification as an XML string.

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, 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

CalculationSpecification

public CalculationSpecification(BaseObject input)

Creates a new CalculationSpecification for the specified AggregationDefinition.

Parameters:

input - The AggregationDefinition that owns the new CalculationSpecification.

Method Detail

setCalculationOrder

public void setCalculationOrder(int input)

Sets the position within the calculation list to the specified integer.

Parameters:

input - An int specifying the position in the list of CalculationSpecification objects for the AggregationDefinition.

setCalculationOrder

public void setCalculationOrder(java.lang.String input)

Sets the position within the calculation list to the integer associated with the specified String.

Parameters:

input - A String specifying the position in the list of CalculationSpecification objects for the AggregationDefinition.

getCalculationOrder

public int getCalculationOrder()

Returns the integer position within the calculation list.

Returns:

The int specifying the position in the list of CalculationSpecification objects for the AggregationDefinition.

WriteToXML

public java.lang.String WriteToXML()

Returns the CalculationSpecification as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the CalculationSpecification.

getAggregationText

public java.lang.String getAggregationText(AWConnection connection)

Returns the OLAP DML RELATION or MODEL statement implemented by the CalculationSpecification in the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

The text of the OLAP DML RELATION or MODEL statement.

Create

public java.lang.String Create(AWConnection connection)

Creates the CalculationSpecification in the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

"success" if successful