Skip navigation links

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-04


oracle.AWXML
Class AggregationHierarchySpecification

java.lang.Object
  extended byoracle.AWXML.BaseObject
      extended byoracle.AWXML.CalculationSpecification
          extended byoracle.AWXML.Aggregation
              extended byoracle.AWXML.AggregationHierarchySpecification


public class AggregationHierarchySpecification
extends Aggregation

An Aggregation that specifies the rules for aggregating data for members of a hierarchy of a dimension. An AggregationHierarchySpecification is owned by an AggregationDefinition, which has an ordered list of CalculationSpecification objects.

An AggregationHierarchySpecification can own a PrecomputeClause, which designates dimension members for which the data should be precalculated. The selection of dimension members in the hierarchy is specified by a DimensionMemberSelection that is owned by the Dimension associated with the AggregationHierarchySpecification.


Field Summary

 

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 a Hierarchy to the list of Hierarchy objects of the AggregationHierarchySpecification.
 java.lang.String Create(AWConnection connection)
          Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it to the end of the list of CalculationSpecification objects for the owning AggregationDefinition.
 java.lang.String CreateAfter(AWConnection connection, BaseObject referencedObj)
          Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it after the referenced object in the list of CalculationSpecification objects for the owning AggregationDefinition.
 java.lang.String CreateBefore(AWConnection connection, BaseObject referencedObj)
          Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it before the referenced object in the list of CalculationSpecification objects for the owning AggregationDefinition.
 java.lang.String CreateFirst(AWConnection connection)
          Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it at the beginning of the list of CalculationSpecification objects for the owning AggregationDefinition.
 PreComputeClause createPreComputeClause()
          Creates a PreComputeClause for the AggregationHierarchySpecification.
 java.lang.String Delete(AWConnection connection)
          Removes the AggregationHierarchySpecification from the list of AggregationHierarchySpecification objects of the owning AggregationDefinition.
 Dimension getDimension()
          Gets the Dimension for the AggregationHierarchySpecification.
 java.util.Vector getHierarchy()
          Gets the list of Hierarchy objects for the AggregationHierarchySpecification.
 PreComputeClause getPreComputeClause()
          Gets the PreComputeClause for the AggregationHierarchySpecification.
 void removeHierarchy(Hierarchy input)
          Removes the specified Hierarchy from the list of Hierarchy objects for the AggregationHierarchySpecification.
 void setDimension(Dimension input)
          Specifies a Dimension for the AggregationHierarchySpecification.
 void setPreComputeClause(PreComputeClause input)
          Specifies a PreComputeClause for the AggregationHierarchySpecification.
 java.lang.String WriteToXML()
          Gets an XML representation of the AggregationHierarchySpecification.

 

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 to own the new AggregationHierarchySpecification.

Method Detail

createPreComputeClause

public PreComputeClause createPreComputeClause()
Creates a PreComputeClause for the AggregationHierarchySpecification. A PreComputeClause designates dimension members for which the analytic workspace precalculates data in an aggregation operation.
Returns:
The PreComputeClause for the AggregationHierarchySpecification.

getPreComputeClause

public PreComputeClause getPreComputeClause()
Gets the PreComputeClause for the AggregationHierarchySpecification.
Returns:
The PreComputeClause for the AggregationHierarchySpecification.

setPreComputeClause

public void setPreComputeClause(PreComputeClause input)
Specifies a PreComputeClause for the AggregationHierarchySpecification. The PreComputeClausee designates dimension members for which the analytic workspace precalculates data in an aggregation operation.
Parameters:
input - The PreComputeClause for the AggregationHierarchySpecification.

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the AggregationHierarchySpecification.
Overrides:
WriteToXML in class Aggregation
Returns:
An XML String that represents the AggregationHierarchySpecification.

addHierarchy

public void addHierarchy(Hierarchy input)
Adds a Hierarchy to the list of Hierarchy objects of the AggregationHierarchySpecification. The Hierarchy must be owned by the Dimension for the AggregationHierarchySpecification.
Parameters:
input - The Hierarchy to add for the AggregationHierarchySpecification.

removeHierarchy

public void removeHierarchy(Hierarchy input)
Removes the specified Hierarchy from the list of Hierarchy objects for the AggregationHierarchySpecification.
Parameters:
input - The Hierarchy to remove from the AggregationHierarchySpecification.

setDimension

public void setDimension(Dimension input)
Specifies a Dimension for the AggregationHierarchySpecification.
Parameters:
input - The Dimension to specify for the AggregationHierarchySpecification.

getHierarchy

public java.util.Vector getHierarchy()
Gets the list of Hierarchy objects for the AggregationHierarchySpecification.
Returns:
A Vector that contains the Hierarchy objects associated with the AggregationHierarchySpecification.

getDimension

public Dimension getDimension()
Gets the Dimension for the AggregationHierarchySpecification.
Returns:
The Dimension associated with the AggregationHierarchySpecification.

Create

public java.lang.String Create(AWConnection connection)
Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it to the end of the list of CalculationSpecification objects for the owning AggregationDefinition.
Overrides:
Create in class CalculationSpecification
Parameters:
connection - The AWConnection that represents the database connection.
Returns:
A String that contains success if the method successfully creates the AggregationHierarchySpecification.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)
Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it at the beginning of the list of CalculationSpecification objects for the owning AggregationDefinition.
Overrides:
CreateFirst in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
Returns:
A String that contains success if the method successfully creates the AggregationHierarchySpecification.

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)
Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it after the referenced object in the list of CalculationSpecification objects for the owning AggregationDefinition.
Overrides:
CreateAfter in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
referencedObj - The AggregationHierarchySpecification after which you want to add the new AggregationHierarchySpecification.
Returns:
A String that contains success if the method successfully creates the AggregationHierarchySpecification.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)
Creates an AggregationHierarchySpecification in the current analytic workspace of the specified database connection and adds it before the referenced object in the list of CalculationSpecification objects for the owning AggregationDefinition.
Overrides:
CreateBefore in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
referencedObj - The AggregationHierarchySpecification before which you want to add the new AggregationHierarchySpecification.
Returns:
A String that contains success if the method successfully creates the AggregationHierarchySpecification.

Delete

public java.lang.String Delete(AWConnection connection)
Removes the AggregationHierarchySpecification from the list of AggregationHierarchySpecification objects of the owning AggregationDefinition.
Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains success if the method removes the AggregationHierarchySpecification from the AggregationDefinition.

Skip navigation links

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-04


Copyright © 2003, 2007 Oracle. All rights reserved.