oracle.AWXML
Class AggregationHierarchySpecification

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

public class AggregationHierarchySpecification

extends Aggregation

A hierarchy specification in an AggregationDefinition.

An AggregationHierarchySpecification may own a PrecomputeClause, which designates dimension members for which the data should be precalculated.

AggregationHierarchySpecification objects are ordered within an AggregationDefinition.

See Also:

AggregationDefinition

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

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

Method Summary

void	addHierarchy(Hierarchy input) Adds the hierarchy for this AggregationHierarchySpecification.
java.lang.String	Create(AWConnection connection) Creates the AggregationHierarchySpecification in the current analytic workspace of the specified database connection.
java.lang.String	CreateAfter(AWConnection connection, BaseObject referencedObj) Creates the AggregationHierarchySpecification after the specified CalculationSpecification in the AggregationDefinition in the current analytic workspace of the specified database connection.
java.lang.String	CreateBefore(AWConnection connection, BaseObject referencedObj) Creates the AggregationHierarchySpecification before the specified CalculationSpecification in the AggregationDefinition in the current analytic workspace of the specified database connection.
java.lang.String	CreateFirst(AWConnection connection) Creates the AggregationHierarchySpecification at the beginnning of the calculation list for the AggregationDefinition in the current analytic workspace of the specified database connection.
PreComputeClause	createPreComputeClause() Creates a precompute clause for the AggregationHierarchySpecification.
java.lang.String	Delete(AWConnection connection) Deletes the AggregationHierarchySpecification in the current analytic workspace of the specified database connection.
Dimension	getDimension() Returns the dimension for this AggregationHierarchySpecification.
java.util.Vector	getHierarchy() Returns the hierarchies for this AggregationHierarchySpecification.
PreComputeClause	getPreComputeClause() Returns the precompute clause for the AggregationHierarchySpecification.
void	removeHierarchy(Hierarchy input) Removes the hierarchy for this AggregationHierarchySpecification.
void	setDimension(Dimension input) Sets the dimension for this AggregationHierarchySpecification.
void	setPreComputeClause(PreComputeClause input) Sets the precompute clause for the AggregationHierarchySpecification.
java.lang.String	WriteToXML() Returns the AggregationHierarchySpecification as an XML string.

Methods inherited from class oracle.AWXML.Aggregation

Create, createBaseOperator, createConfigurationParameters, getAggregationArgument, getAggregationOperator, setAggregationArgument, setAggregationOperator

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

AggregationHierarchySpecification

public AggregationHierarchySpecification(BaseObject input)

Creates an AggregationHierarchySpecification for the specified AggregationDefinition.

Parameters:

input - The AggregationDefinition that owns this AggregationHierarchySpecification,

Method Detail

createPreComputeClause

public PreComputeClause createPreComputeClause()

Creates a precompute clause for the AggregationHierarchySpecification. The precompute clause specifies dimension members for which data should be precalculated with the OLAP DML AGGREGATE command.

Returns:

The PreComputeClause for the AggregationHierarchySpecification.

getPreComputeClause

public PreComputeClause getPreComputeClause()

Returns the precompute clause for the AggregationHierarchySpecification.

Returns:

The PreComputeClause for the AggregationHierarchySpecification.

setPreComputeClause

public void setPreComputeClause(PreComputeClause input)

Sets the precompute clause for the AggregationHierarchySpecification. The precompute clause specifies dimension members for which data should be precalculated with the OLAP DML AGGREGATE command.

Parameters:

input - The PreComputeClause for the AggregationHierarchySpecification.

WriteToXML

public java.lang.String WriteToXML()

Returns the AggregationHierarchySpecification as an XML string.

Overrides:

WriteToXML in class Aggregation

Returns:

A String containing the XML that represents the AggregationHierarchySpecification.

addHierarchy

public void addHierarchy(Hierarchy input)

Adds the hierarchy for this AggregationHierarchySpecification.

Parameters:

input - The Hierarchy.

removeHierarchy

public void removeHierarchy(Hierarchy input)

Removes the hierarchy for this AggregationHierarchySpecification.

Parameters:

input - The Hierarchy.

setDimension

public void setDimension(Dimension input)

Sets the dimension for this AggregationHierarchySpecification. The hierarchy must belong to this dimension.

Parameters:

input - The Dimension that owns the Hierarchy.

getHierarchy

public java.util.Vector getHierarchy()

Returns the hierarchies for this AggregationHierarchySpecification.

Returns:

The Hierarchy.

getDimension

public Dimension getDimension()

Returns the dimension for this AggregationHierarchySpecification.

Returns:

The Dimension that owns the Hierarchy.

Create

public java.lang.String Create(AWConnection connection)

Creates the AggregationHierarchySpecification in the current analytic workspace of the specified database connection. If other CalculationSpecification objects already exist for the AggregationDefinition, creates the new one at the end of the list.

Overrides:

Create in class CalculationSpecification

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

Creates the AggregationHierarchySpecification at the beginnning of the calculation list for the AggregationDefinition in the current analytic workspace of the specified database connection.

Overrides:

CreateFirst in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)

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

Overrides:

CreateAfter in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced CalculationSpecification.

Returns:

"success" if successful.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)

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

Overrides:

CreateBefore in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced CalculationSpecification.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the AggregationHierarchySpecification 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:

"success" if successful.