oracle.AWXML
Class AggregationSolve

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Solve
              |
              +--oracle.AWXML.AggregationSolve

public class AggregationSolve

extends Solve

A Solve that aggregates data in an analytic workspace.

Aggregation is the process of creating summary data from detail data. The summarized data may be totaled, or it may be calculated using a non-additive operator such as average, max, or min. Aggregate data may be precalculated and stored in the analytic workspace, or it may be calculated at runtime in response to a query.

An AggregationSolve uses an AggregationDefinition to specify the aggregation rules for the data.

Each AggregationSolve specifies the measure to aggregate and a set of target measures to hold the results of the aggregation. If you do not specify a source, aggregation is performed on the target and the results are stored in the target. If you specify both source and target measures, aggregation is performed using the OLAP DML command AGGREGATE FROM.

For more information on OLAP aggregation, see the OLAP DML Reference and the OLAP Application Developer's Guide.

See Also:

AggregationDefinition, SolveGroup

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

AggregationSolve()
Default Constructor

AggregationSolve(BaseObject input)
Creates an AggregationSolve in the specified SolveGroup.

Method Summary

void	addTarget(Measure input) Adds a target measure to hold the aggregated data.
java.lang.String	Alter(AWConnection connection) Alters the class attributes of the object in the current analytic workspace of the specified database connection.
java.lang.String	Create(AWConnection connection) Creates the AggregationSolve in the current analytic workspace of the specified database connection and adds it to the end of the list of solves in the owning SolveGroup.
java.lang.String	CreateAfter(AWConnection connection, BaseObject referencedObj) Creates the AggregationSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup after the specified Solve.
java.lang.String	CreateBefore(AWConnection connection, BaseObject referencedObj) Stores the AggregationSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup before the specified Solve.
java.lang.String	CreateFirst(AWConnection connection) Creates the AggregationSolve in the current analytic workspace of the specified database connection, and appends it to the beginning of the list of solves in the owning SolveGroup.
java.lang.String	Delete(AWConnection connection) Deletes the AggregationSolve in the current analytic workspace of the specified database connection.
AggregationDefinition	getAggregationDefinition() Returns the AggregationDefinition that defines the rules for this AggregationSolve.
Measure	getSource() Returns the measure that contains the detail data for the aggregation.
java.util.Vector	getTargets() Returns the target measures specified for this AggregationSolve.
void	removeTarget(Measure input) Removes a target measure from the AggregationSolve.
void	setAggregationDefinition(AggregationDefinition input) Sets the AggregationDefinition that defines the rules for this AggregationSolve.
void	setSource(Measure input) Sets the measure that contains the detail data for the aggregation.
java.lang.String	WriteToXML() Returns the AggregationSolve as an XML string.

Methods inherited from class oracle.AWXML.Solve

addDimensionMemberSelection, createDimensionMemberSelection, getDimensionMemberSelection, getSolveOrder, readAWDefinitions, removeDimensionMemberSelection, setSolveOrder, setSolveOrder

Methods inherited from class oracle.AWXML.BaseObject

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

AggregationSolve

public AggregationSolve()

Default Constructor

AggregationSolve

public AggregationSolve(BaseObject input)

Creates an AggregationSolve in the specified SolveGroup.

Parameters:

input - The SolveGroup that owns the AggregationSolve.

Method Detail

setAggregationDefinition

public void setAggregationDefinition(AggregationDefinition input)

Sets the AggregationDefinition that defines the rules for this AggregationSolve.

Parameters:

input - The AggregationDefinition to use.

getAggregationDefinition

public AggregationDefinition getAggregationDefinition()

Returns the AggregationDefinition that defines the rules for this AggregationSolve.

Returns:

The AggregationDefinition used by this AggregationSolve.

getSource

public Measure getSource()

Returns the measure that contains the detail data for the aggregation.

Returns:

The source Measure.

setSource

public void setSource(Measure input)

Sets the measure that contains the detail data for the aggregation.

Parameters:

input - The source Measure.

addTarget

public void addTarget(Measure input)

Adds a target measure to hold the aggregated data. If you do not specify a separate source measure, the target measure contains both the detail and the aggregate data.

Parameters:

input - The target Measure to add.

removeTarget

public void removeTarget(Measure input)

Removes a target measure from the AggregationSolve.

Parameters:

input - The target Measure to remove.

getTargets

public java.util.Vector getTargets()

Returns the target measures specified for this AggregationSolve.

Returns:

A Vector of Measure objects.

WriteToXML

public java.lang.String WriteToXML()

Returns the AggregationSolve as an XML string.

Overrides:

WriteToXML in class Solve

Returns:

A String containing the XML that represents the AggregationSolve.

Create

public java.lang.String Create(AWConnection connection)

Creates the AggregationSolve in the current analytic workspace of the specified database connection and adds it to the end of the list of solves in the owning SolveGroup.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

Creates the AggregationSolve in the current analytic workspace of the specified database connection, and appends it to the beginning of the list of solves in the owning SolveGroup.

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 AggregationSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup after the specified Solve.

Overrides:

CreateAfter in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced Solve.

Returns:

"success" if successful.

CreateBefore

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

Stores the AggregationSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup before the specified Solve.

Overrides:

CreateBefore in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced Solve.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the AggregationSolve in the current analytic workspace of the specified database connection.

Overrides:

Delete in class Solve

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

Alter

public java.lang.String Alter(AWConnection connection)

Description copied from class: BaseObject

Alters the class attributes of the object in the current analytic workspace of the specified database connection. You can use the Alter method to change descriptive names of the object or to reset the schema of a top-level object. To alter the structural definition of a BaseObject, you must create, modify, or remove its owned objects.

Overrides:

Alter in class BaseObject

Tags copied from class: BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

If successful, a String that contains success.