oracle.AWXML
Class AggregationDefinition

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

public class AggregationDefinition

extends SolveDefinition

The aggregation rules for a measure or a group of measures within a cube. The aggregation rules are formulated as an aggregation map (AGGMAP) in the OLAP DML. An AGGMAP object specifies the data that should be aggregated for each dimension of the measure. An AGGMAP also specifies which data should be precalculated and which data should be calculated on the fly.

The AggregationDefinition consists of one or more CalculationSpecifications, each one specifying an ordered set of RELATION and MODEL statements in the aggregation map.

The AggregationDefinition includes methods for specifying AGGINDEX and CACHE statements for the aggregation map. An AGGINDEX statement specifies indexes for data that is aggregated on the fly by the AGGREGATE function. A CACHE statement specifies how to cache aggregated data.

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

OLAP Analytic Workspace Aggregation Definition Model

For more information, see the AGGREGATE command in the OLAP DML Reference.

AggregationDefinition

public AggregationDefinition()

Default Constructor

AggregationDefinition

public AggregationDefinition(BaseObject input)

Constructor that takes the owner of this object.

Parameters:

input - BaseObject that is the owner of this object in the object model

getAggIndex

public java.lang.String getAggIndex()

Returns the aggregation index (the AGGINDEX argument of the RELATION statement in the aggregation map).

Returns:

String containing the aggregation index

setAggIndex

public void setAggIndex(java.lang.String input)

Sets the aggregation index (the AGGINDEX argument of the RELATION statement in the aggregation map).

Parameters:

String - containing the aggregation index

getCacheStore

public java.lang.String getCacheStore()

Returns the aggregation cache (the CACHE argument of the RELATION statement in the aggregation map.)

Parameters:

-  

Returns:

String containing the aggregation cache

setCacheStore

public void setCacheStore(java.lang.String input)

Sets the aggregation cache (the CACHE argument of the RELATION statement in the aggregation map.)

Parameters:

String - containing the aggregation cache

getCacheNa

public java.lang.String getCacheNa()

Returns the aggregation cache that is NA.

Returns:

String specifying the aggregation cache

setCacheNa

public void setCacheNa(java.lang.String input)

Sets the aggregation cache to NA.

Parameters:

String - specifying the aggregation cache

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:

WriteToXML in class SolveDefinition

Returns:

A String containing the XML that represents the object

getCalculationSpecification

public java.util.Vector getCalculationSpecification()

Returns the ordered list of RELATION statements and MODEL statements that make up the aggregation map.

Returns:

Vector

removeCalculationSpecification

public void removeCalculationSpecification(CalculationSpecification input)

Removes a RELATION statement or MODEL statement from the aggregation map.

Parameters:

input - CalculationSpecification

addCalculationSpecification

public void addCalculationSpecification(CalculationSpecification input)

Adds a RELATION statement or MODEL statement to the aggregation map.

Parameters:

input - CalculationSpecification

addCalculationSpecificationAfter

public void addCalculationSpecificationAfter(CalculationSpecification input,
BaseObject reference)

Adds a RELATION statement or MODEL statement to the aggregation map. Adds the statement after the RELATION or MODEL statement for another dimension.

Parameters:

input - CalculationSpecification

reference - BaseObject representing the CalculationSpecification that should come before the current CalculationSpecification.

addCalculationSpecificationBefore

public void addCalculationSpecificationBefore(CalculationSpecification input,
BaseObject reference)

Adds a RELATION statement or MODEL statement to the aggregation map. Adds the statement before the RELATION or MODEL statement for another dimension.

Parameters:

input - CalculationSpecification

reference - BaseObject representing the CalculationSpecification that should come after the current CalculationSpecification.

addCalculationSpecificationFirst

public void addCalculationSpecificationFirst(CalculationSpecification input)

Adds a RELATION statement or MODEL statement to the aggregation map. Makes this statement the first in the list of statements.

Parameters:

input - CalculationSpecification

addSolveDefDimRef

public void addSolveDefDimRef(SolveDefDimRef input)

Adds a dimension member selection to the aggregation map.

Parameters:

input - SolveDefDimRef

removeSolveDefDimRef

public void removeSolveDefDimRef(SolveDefDimRef input)

Removes a dimension member selection from the aggregation map.

Parameters:

input - SolveDefDimRef

getSolveDefDimRefs

public java.util.Vector getSolveDefDimRefs()

Returns a dimension member selection associated with the aggregation map.

Returns:

Vector

createSolveDefDimRef

public SolveDefDimRef createSolveDefDimRef()

Creates a dimension member selection for the aggregation map.

Returns:

SolveDefDimRef

createAggregationHierarchySpecification

public AggregationHierarchySpecification createAggregationHierarchySpecification()

Creates an AggregationHierarchySpecification for the RELATION statement in the aggregation map. The AggregationHierarchySpecification specifies the aggregation rules for a hierarchy of a dimension. The rules may designate specific levels or dimension members to include or exclude in the aggregation.

Returns:

the new AggregationHierarchySpecification

createAggregationHierarchySpecificationAfter

public AggregationHierarchySpecification createAggregationHierarchySpecificationAfter(CalculationSpecification input)

Creates an AggregationHierarchySpecification after the specified RELATION or MODEL statement in the aggregation map.

Parameters:

input - CalculationSpecification

Returns:

the new AggregationHierarchySpecification

createAggregationHierarchySpecificationBefore

public AggregationHierarchySpecification createAggregationHierarchySpecificationBefore(CalculationSpecification input)

Creates an AggregationHierarchySpecification before the specified RELATION or MODEL statement in the aggregation map.

Parameters:

input - CalculationSpecification

Returns:

the new AggregationHierarchySpecification

createAggregationHierarchySpecificationFirst

public AggregationHierarchySpecification createAggregationHierarchySpecificationFirst()

Creates an AggregationHierarchySpecification in the first RELATION or MODEL statement in the aggregation map.

Returns:

the new AggregationHierarchySpecification

createModelRef

public ModelRef createModelRef()

Creates a new MODEL statement in the aggregation map.

Returns:

the new ModelRef

createModelRefAfter

public ModelRef createModelRefAfter(CalculationSpecification input)

Creates a new MODEL statement after the specified MODEL or RELATION statment in the aggregation map.

Parameters:

input - CalculationSpecification that should come before the MODEL statement

Returns:

the new ModelRef

createModelRefBefore

public ModelRef createModelRefBefore(CalculationSpecification input)

Creates a new MODEL statement before the specified MODEL or RELATION statment in the aggregation map.

Parameters:

input - CalculationSpecification that should come after the MODEL statement

Returns:

the new ModelRef

createModelRefFirst

public ModelRef createModelRefFirst()

Creates a new MODEL statement as the first statement in the aggregation map.

Returns:

the new ModelRef

Create

public java.lang.String Create(AWConnection connection)

Creates an AggregationDefinition in the current 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 an AggregationDefinition from the current analytic workspace.

Overrides:

Delete in class BaseObject

Parameters:

connection - AWConnection

Returns:

String containing 'success' if successful

readAWMetaData

public void readAWMetaData(AWConnection connection)

Reads the metadata in the analytic workspace.

Parameters:

connection - AWConnection