oracle.AWXML
Class AggregationDefinition

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.SolveDefinition
              |
              +--oracle.AWXML.AggregationDefinition

public class AggregationDefinition

extends SolveDefinition

A SolveDefinition that specifies aggregation instructions for an AggregationSolve. For a diagram of AggregationDefinition associations, see AggregationDefinition Class Associations.

An AggregationDefinition is owned by a Cube. 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 uses a Model to specify aggregation instructions, typically for non-hierarchical dimensions such as line items.

The AggregationDefinition class includes methods for specifying AGGINDEX, CACHE, and NA/NONA statements in the aggregation specification. Those statements affect the aggregation operation. For more information on OLAP aggregation, see the Oracle OLAP Application Developer's Guide.

See Also:

AggregationSolve

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

AggregationDefinition(BaseObject input)
Creates an AggregationDefinition for the specified Cube.

Method Summary

void	addCalculationSpecification(CalculationSpecification input) Adds the specified CalculationSpecification to the end of the list of CalculationSpecification objects for the AggregationDefinition.
void	addCalculationSpecificationAfter(CalculationSpecification input, BaseObject reference) Adds the specified CalculationSpecification after the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.
void	addCalculationSpecificationBefore(CalculationSpecification input, BaseObject reference) Adds the specified CalculationSpecification before the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.
void	addCalculationSpecificationFirst(CalculationSpecification input) Adds the specified CalculationSpecification to the beginning of the list of CalculationSpecification objects for the AggregationDefinition.
void	addSolveDefDimRef(SolveDefDimRef input) Adds the specified dimension reference to the AggregationDefinition.
java.lang.String	Create(AWConnection connection) Creates the AggregationDefinition in the current analytic workspace of the specified database connection.
AggregationHierarchySpecification	createAggregationHierarchySpecification() Creates an AggregationHierarchySpecification and adds it to the end of the list of CalculationSpecification objects for the AggregationDefinition.
AggregationHierarchySpecification	createAggregationHierarchySpecificationAfter(CalculationSpecification input) Creates an AggregationHierarchySpecification and adds it after the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.
AggregationHierarchySpecification	createAggregationHierarchySpecificationBefore(CalculationSpecification input) Creates an AggregationHierarchySpecification and adds it before the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.
AggregationHierarchySpecification	createAggregationHierarchySpecificationFirst() Creates an AggregationHierarchySpecification and adds it to the beginning of the list of CalculationSpecification objects for the AggregationDefinition.
ModelRef	createModelRef() Creates a new ModelRef and adds it to the end of the list of CalculationSpecification objects for the AggregationDefinition.
ModelRef	createModelRefAfter(CalculationSpecification input) Creates a ModelRef and adds it after the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.
ModelRef	createModelRefBefore(CalculationSpecification input) Creates a ModelRef and adds it before the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.
ModelRef	createModelRefFirst() Creates a new ModelRef and adds it to the beginning of the list of CalculationSpecification objects for the AggregationDefinition.
SolveDefDimRef	createSolveDefDimRef() Creates a dimension member selection and adds it to the list of SolveDefDimRef objects for the AggregationDefinition.
java.lang.String	Delete(AWConnection connection) Deletes the AggregationDefinition in the current analytic workspace of the specified database connection.
java.lang.String	getAggIndex() Gets a value that indicates whether the AggregationDefinition specifies the creation of indexes for data that is calculated by the aggregation operation.
java.lang.String	getCacheNa() Gets a value that indicates whether the AggregationDefinition specifies the storing of NA values that result from the aggregation operation.
java.lang.String	getCacheStore() Gets a value that indicates whether the AggregationDefinition specifies the storing of data that is calculated by the aggregation operation.
java.util.Vector	getCalculationSpecification() Gets the list of CalculationSpecification objects for the AggregationDefinition.
java.util.Vector	getSolveDefDimRefs() Gets the list of dimension references for the AggregationDefinition.
void	readAWDefinitions(AWConnection connection, boolean readType) Reads the objects owned by the AggregationDefinition into memory, making them available for processing within the current analytic workspace of the specified database connection.
void	removeCalculationSpecification(CalculationSpecification input) Removes the specified CalculationSpecification from the list of CalculationSpecification objects for the AggregationDefinition.
void	removeSolveDefDimRef(SolveDefDimRef input) Removes the specified dimension reference from the AggregationDefinition.
void	setAggIndex(java.lang.String input) Specifies whether the AggregationDefinition creates indexes for values that are calculated by the aggregation operation.
void	setCacheNa(java.lang.String input) Specifies whether the analytic workspace stores NA values that result from the calculations of the aggregation operation.
void	setCacheStore(java.lang.String input) Specifies whether Oracle OLAP stores the data calculated by the aggregation operation.
java.lang.String	WriteToXML() Gets an XML representation of the AggregationDefinition.

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

AggregationDefinition

public AggregationDefinition(BaseObject input)

Creates an AggregationDefinition for the specified Cube.

Parameters:

input - The Cube that you want to own the AggregationDefinition.

Method Detail

getAggIndex

public java.lang.String getAggIndex()

Gets a value that indicates whether the AggregationDefinition specifies the creation of indexes for data that is calculated by the aggregation operation.

Returns:

A String that contains YES if the AggregationDefinition specifies the creation of indexes or NO if it does not.

setAggIndex

public void setAggIndex(java.lang.String input)

Specifies whether the AggregationDefinition creates indexes for values that are calculated by the aggregation operation. If you want the aggregation to create indexes, then specify YES as the input value. If you do not want to create indexes, then specify NO.

Parameters:

input - A String that contains YES if you want the aggregation operation to create indexes for data values that it calculates or NO if you do not.

getCacheStore

public java.lang.String getCacheStore()

Gets a value that indicates whether the AggregationDefinition specifies the storing of data that is calculated by the aggregation operation.

Returns:

A String that contains STORES if the AggregationDefinition specifies the storing of aggregated data or NOSTORE if it does not.

setCacheStore

public void setCacheStore(java.lang.String input)

Specifies whether Oracle OLAP stores the data calculated by the aggregation operation. If you want to store the aggregated data, then specify STORE as the input value. If you do not want to store the aggregated data, specify NOSTORE.

Parameters:

input - A String that contains STORE if you want to store the data calculated by the aggregation operation or NOSTORE if you do not.

getCacheNa

public java.lang.String getCacheNa()

Gets a value that indicates whether the AggregationDefinition specifies the storing of NA values that result from the aggregation operation.

Returns:

A String that contains NA if the AggregationDefinition specifies the storing of NA values or NONA if it does not.

setCacheNa

public void setCacheNa(java.lang.String input)

Specifies whether the analytic workspace stores NA values that result from the calculations of the aggregation operation. If you want to store the calcualted NA values, then specify NA as the input value. If you do not want to store NA values, specify NONA.

Parameters:

input - A String that contains NA if you want to store NA values calculated by the aggregation operation or NONA if you do not.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the AggregationDefinition.

Overrides:

WriteToXML in class SolveDefinition

Returns:

An XML String that represents the AggregationDefinition.

getCalculationSpecification

public java.util.Vector getCalculationSpecification()

Gets the list of CalculationSpecification objects for the AggregationDefinition.

Returns:

A Vector that contains CalculationSpecification objects.

removeCalculationSpecification

public void removeCalculationSpecification(CalculationSpecification input)

Removes the specified CalculationSpecification from the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification to remove from the list.

addCalculationSpecification

public void addCalculationSpecification(CalculationSpecification input)

Adds the specified CalculationSpecification to the end of the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification to add to the end of the list.

addCalculationSpecificationAfter

public void addCalculationSpecificationAfter(CalculationSpecification input,
                                             BaseObject reference)

Adds the specified CalculationSpecification after the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification to add to the list.

reference - The CalculationSpecification in the list after which to add the CalculationSpecification.

addCalculationSpecificationBefore

public void addCalculationSpecificationBefore(CalculationSpecification input,
                                              BaseObject reference)

Adds the specified CalculationSpecification before the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification to add to the list.

reference - The CalculationSpecification in the list before which to add the CalculationSpecification.

addCalculationSpecificationFirst

public void addCalculationSpecificationFirst(CalculationSpecification input)

Adds the specified CalculationSpecification to the beginning of the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification to add to the beginning of the list.

addSolveDefDimRef

public void addSolveDefDimRef(SolveDefDimRef input)

Adds the specified dimension reference to the AggregationDefinition.

Parameters:

input - The SolveDefDimRef to add to the AggregationDefinition.

removeSolveDefDimRef

public void removeSolveDefDimRef(SolveDefDimRef input)

Removes the specified dimension reference from the AggregationDefinition.

Parameters:

input - The SolveDefDimRef to remove from the AggregationDefinition.

getSolveDefDimRefs

public java.util.Vector getSolveDefDimRefs()

Gets the list of dimension references for the AggregationDefinition.

Returns:

A Vector of the SolveDefDimRef objects owned by the AggregationDefinition.

createSolveDefDimRef

public SolveDefDimRef createSolveDefDimRef()

Creates a dimension member selection and adds it to the list of SolveDefDimRef objects for the AggregationDefinition.

Returns:

The new SolveDefDimRef for the AggregationDefinition.

createAggregationHierarchySpecification

public AggregationHierarchySpecification createAggregationHierarchySpecification()

Creates an AggregationHierarchySpecification and adds it to the end of the list of CalculationSpecification objects for the AggregationDefinition.

Returns:

The new AggregationHierarchySpecification for the AggregationDefinition.

createAggregationHierarchySpecificationAfter

public AggregationHierarchySpecification createAggregationHierarchySpecificationAfter(CalculationSpecification input)

Creates an AggregationHierarchySpecification and adds it after the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification in the list after which to add the new AggregationHierarchySpecification.

Returns:

The new AggregationHierarchySpecification.

createAggregationHierarchySpecificationBefore

public AggregationHierarchySpecification createAggregationHierarchySpecificationBefore(CalculationSpecification input)

Creates an AggregationHierarchySpecification and adds it before the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification in the list before which to add the new CalculationSpecification.

Returns:

The new AggregationHierarchySpecification.

createAggregationHierarchySpecificationFirst

public AggregationHierarchySpecification createAggregationHierarchySpecificationFirst()

Creates an AggregationHierarchySpecification and adds it to the beginning of the list of CalculationSpecification objects for the AggregationDefinition.

Returns:

The new AggregationHierarchySpecification for the AggregationDefinition.

createModelRef

public ModelRef createModelRef()

Creates a new ModelRef and adds it to the end of the list of CalculationSpecification objects for the AggregationDefinition.

Returns:

The new ModelRef for the AggregationDefinition.

createModelRefAfter

public ModelRef createModelRefAfter(CalculationSpecification input)

Creates a ModelRef and adds it after the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification in the list after which to add the new ModelRef.

Returns:

The new ModelRef.

createModelRefBefore

public ModelRef createModelRefBefore(CalculationSpecification input)

Creates a ModelRef and adds it before the referenced CalculationSpecification in the list of CalculationSpecification objects for the AggregationDefinition.

Parameters:

input - The CalculationSpecification in the list before which to add the new ModelRef.

Returns:

The new ModelRef.

createModelRefFirst

public ModelRef createModelRefFirst()

Creates a new ModelRef and adds it to the beginning of the list of CalculationSpecification objects for the AggregationDefinition.

Returns:

The new ModelRef for the AggregationDefinition.

Create

public java.lang.String Create(AWConnection connection)

Creates the AggregationDefinition 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:

A String that contains success if the method creates the AggregationDefinition.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the AggregationDefinition 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 the method deletes the AggregationDefinition.

readAWDefinitions

public void readAWDefinitions(AWConnection connection,
                              boolean readType)

Reads the objects owned by the AggregationDefinition into memory, making them available for processing within the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

readType - Specify True to read the AggregationDefinition and all its child objects. Specify False to read the AggregationDefinition but to not read the child objects.