oracle.AWXML
Class Aggregation

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

Direct Known Subclasses:

AggregationHierarchySpecification

public abstract class Aggregation

extends CalculationSpecification

A CalculationSpecification that specifies the rules for aggregating data over a hierarchical dimension. A ModelRef is a CalculationSpecification that references a pre-defined Model to specify aggregation over a dimension that is typically a non-hierarchical dimension. A CalculationSpecification is associated with an AggregationDefinition.

An AggregationDefinition owns an ordered set of CalculationSpecification objects. The position in the calculation order determines the order in which Oracle OLAP performs the calculations.

An AggregationDefinition is implemented as an aggmap object for aggregation in the OLAP DML. Each of its Aggregation objects is a RELATION statement in the aggmap.

An Aggregation has an AggregationHierarchySpecification. It can also have an AggregationOperator and an AggregationArgument.

For more information on aggmaps and aggregation, see the Oracle OLAP DML Reference.

See Also:

AggregationDefinition

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

Aggregation(BaseObject input)
Creates an Aggregation and adds it to the specified AggregationDefinition.

Method Summary

java.lang.String	Create(AWConnection connection, int relationOffset) Creates an Aggregation in the current analytic workspace of the specified database connection.
BaseOperator	createBaseOperator() Creates a BaseOperator and makes it the AggregationOperator for this Aggregation.
ConfigurationParameters	createConfigurationParameters() Creates a ConfigurationParameters object and makes it the AggregationArgument for this Aggregation.
AggregationArgument	getAggregationArgument() Gets the AggregationArgument associated with the Aggregation.
AggregationOperator	getAggregationOperator() Gets the AggregationOperator associated with the Aggregation.
void	setAggregationArgument(AggregationArgument input) Specifies the AggregationArgument for the Aggregation.
void	setAggregationOperator(AggregationOperator input) Specifies the aggregation operator for the Aggregation.
java.lang.String	WriteToXML() Gets an XML representation of the Aggregation.

Methods inherited from class oracle.AWXML.CalculationSpecification

Create, getAggregationText, getCalculationOrder, setCalculationOrder, setCalculationOrder

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

Aggregation

public Aggregation(BaseObject input)

Creates an Aggregation and adds it to the specified AggregationDefinition.

Parameters:

input - The AggregationDefinition that has the new Aggregation.

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the Aggregation.

Overrides:

WriteToXML in class CalculationSpecification

Returns:

A String that contains XML that represents the Aggregation.

getAggregationOperator

public AggregationOperator getAggregationOperator()

Gets the AggregationOperator associated with the Aggregation. The default aggregation operation is addition.

Returns:

The AggregationOperator associated with this Aggregation.

setAggregationOperator

public void setAggregationOperator(AggregationOperator input)

Specifies the aggregation operator for the Aggregation. If you do not specify an operator, then the operation is addition, which the default.

Parameters:

input - The AggregationOperator to associate with this Aggregation.

setAggregationArgument

public void setAggregationArgument(AggregationArgument input)

Specifies the AggregationArgument for the Aggregation. The AggregationArgument is a ConfigurationParameters object that has Parameter objects. Each Parameter specifies an argument for an OLAP DML RELATION statement in an aggregation specification.

For the arguments that are valid for an aggregation specification, see Parameter.

Parameters:

input - The AggregationArgument for the Aggregation.

See Also:

Parameter

getAggregationArgument

public AggregationArgument getAggregationArgument()

Gets the AggregationArgument associated with the Aggregation.

Returns:

The AggregationArgument associated with the Aggregation.

createBaseOperator

public BaseOperator createBaseOperator()

Creates a BaseOperator and makes it the AggregationOperator for this Aggregation. The default aggregation operation is addition. To specify a different operation, call the setOpCode method of the BaseOperator returned by this method.

Returns:

The BaseOperator that is the AggregationOperator for this Aggregation.

createConfigurationParameters

public ConfigurationParameters createConfigurationParameters()

Creates a ConfigurationParameters object and makes it the AggregationArgument for this Aggregation. See setAggregationArgument(AggregationArgument input).

Returns:

The ConfigurationParameters that is the AggregationArgument for the Aggregation.

Create

public java.lang.String Create(AWConnection connection,
                               int relationOffset)

Creates an Aggregation in the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

relationOffset - An integer that specifeis the position of the Aggregation in the list of CalculationSpecification objects.

Returns:

A String that contains the value success if the method succeeds.