Oracle OLAP Analytic Workspace Java API Reference: Class Aggregation

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)
B12180-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

The rules for aggregating data over a dimension. In the OLAP DML, the aggregation rules for a dimension are represented by a RELATION statement in an aggregation map. For more information on aggregation in analytic workspaces, see the OLAP DML Reference.

Field Summary
`protected AggregationArgument`	`m_aggregationArgument`
`protected AggregationOperator`	`m_operator`

Fields inherited from class oracle.AWXML.CalculationSpecification

m_calculationOrder

Fields inherited from class oracle.AWXML.BaseObject

AWNULL, DATABASENULL, m_commandResults, m_commandResultText, m_id, m_listResults, m_longName, m_name, m_owner, m_pluralName, m_schema, m_shortName, s_EndElementTag, s_EndEndTag, s_EndStartTag, s_EndTag, s_Indent, s_JAVA_LINEEND, s_NEWLINE, s_objectCounter, s_StartEndTag, s_StartStartTag

Constructor Summary
`Aggregation(BaseObject input)` Constructor that takes the owner of this object.

Method Summary
`java.lang.String`	`Create(AWConnection connection, int relationOffset)` Creates an `Aggregation` in the current analytic workspace.
`BaseOperator`	`createBaseOperator()` Creates a new `BaseOperator`, which can hold any operator recognized by the RELATION statement in an aggregation map.
`ConfigurationParameters`	`createConfigurationParameters()` Creates new configuration parameters for this RELATION statement in the aggregation map.
`AggregationArgument`	`getAggregationArgument()` Returns an argument for this `RELATION` statement in the aggregation map.
`AggregationOperator`	`getAggregationOperator()` Returns the agregation operator for this `RELATION` statement in the aggregation map.
`void`	`setAggregationArgument(AggregationArgument input)` Sets an argument for this `RELATION` statement in the aggregation map.
`void`	`setAggregationOperator(AggregationOperator input)` Sets the agregation operator for this `RELATION` statement in the aggregation map.
`java.lang.String`	`WriteToXML()` This method will write the contents of the object as a valid awxml string as defined by the awxml xsd

Methods inherited from class oracle.AWXML.CalculationSpecification

Create, getAggregationText, getCalculationOrder, setCalculationOrder, setCalculationOrder

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, Delete, getId, getLongName, getName, getOwner, getParentId, getPluralName, getSchema, getShortName, setLongName, setName, setPluralName, setSchema, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_operator

protected AggregationOperator m_operator

m_aggregationArgument

protected AggregationArgument m_aggregationArgument

Constructor Detail

Aggregation

public Aggregation(BaseObject input)

Constructor that takes the owner of this object.

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

Method Detail

WriteToXML

public java.lang.String WriteToXML()

This method will write the contents of the object as a valid awxml string as defined by the awxml xsd

Overrides:: WriteToXML in class CalculationSpecification

Returns:: String the instance values formated as an xml string

getAggregationOperator

public AggregationOperator getAggregationOperator()

Returns the agregation operator for this RELATION statement in the aggregation map.

Returns:: AggregationOperator

setAggregationOperator

public void setAggregationOperator(AggregationOperator input)

Sets the agregation operator for this RELATION statement in the aggregation map.

Parameters:: input - AggregationOperator

setAggregationArgument

public void setAggregationArgument(AggregationArgument input)

Sets an argument for this RELATION statement in the aggregation map. The AggregationArgument can have one of the following Parameter values:

   DIVIDEBYZERO
   DECIMALOVERFLOW
   NASKIP
   WEIGHTBY

Parameters:: input - AggregationArgument

getAggregationArgument

public AggregationArgument getAggregationArgument()

Returns an argument for this RELATION statement in the aggregation map. The AggregationArgument can have one of the following Parameter values:

   DIVIDEBYZERO
   DECIMALOVERFLOW
   NASKIP
   WEIGHTBY

Returns:: input AggregationArgument

createBaseOperator

public BaseOperator createBaseOperator()

Creates a new BaseOperator, which can hold any operator recognized by the RELATION statement in an aggregation map.

Aggregation operators are:

   AVERAGE
   FIRST
   HAVERAGE
   HFIRST
   HLAST
   HWAVERAGE
   HWFIRST
   HWLAST
   LAST
   MIN
   MAX
   NOAGG
   SSUM
   SUM
   WAVERAGE
   WFIRST
   WLAST
   WSUM

Returns:: BaseOperator

createConfigurationParameters

public ConfigurationParameters createConfigurationParameters()

Creates new configuration parameters for this RELATION statement in the aggregation map. Configuration parameters can have one or more Parameter objects, whose values can be:

   DIVIDEBYZERO
   DECIMALOVERFLOW
   NASKIP
   WEIGHTBY

Returns:: ConfigurationParameters

Create

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

Creates an Aggregation in the current analytic workspace.

Parameters:: connection - An AWConnection; relationOffset - An int specifying the position of this RELATION statement in the aggregation map.
Returns: