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

B14351-04

oracle.AWXML
Class Solve

java.lang.Object
  extended byoracle.AWXML.BaseObject
      extended byoracle.AWXML.Solve
Direct Known Subclasses:
AggregationSolve, AllocationSolve, ForecastSolve

public abstract class Solve
extends BaseObject

An abstract class that represents a calculation on multidimensional data. For a diagram of the class hierarchy and associations of Solve, see Solve Class Hierarchy. A Solve can specify how to aggregate or allocate the data that results from a calculation or how to generate a forecast based on the data.

A Solve can own DimensionMemberSelection objects, which specify dimension members to include or exclude during the calculation or forecast. A Solve uses a SolveDefinition to specify the parameters and settings of the calculation. A SolveDefinition can be an AggregationDefinition, an AllocationDefinition, or a ForecastDefinition.

A Solve is owned by a SolveGroup, which maintains a list of Solve objects. The analytic workspace build process executes the Solve objects in the order in which they appear in the list.

See Also:
SolveDefinition, SolveGroup, BuildDatabase

Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
Solve(BaseObject input)
          Creates a Solve in the specified SolveGroup.
 
Method Summary
 void addDimensionMemberSelection(DimensionMemberSelection input)
          Adds the specified DimensionMemberSelection to the Solve.
 DimensionMemberSelection createDimensionMemberSelection()
          Creates a DimensionMemberSelection for the Solve.
 java.lang.String Delete(AWConnection connection)
          Deletes the Solve in the current analytic workspace of the specified database connection.
 java.util.Vector getDimensionMemberSelection()
          Gets the list of DimensionMemberSelection objects of the Solve.
 int getSolveOrder()
          Gets the position of the Solve in the list of Solve objects owned by the SolveGroup.
 void removeDimensionMemberSelection(DimensionMemberSelection input)
          Removes the specified DimensionMemberSelection from the list of DimensionMemberSelection objects of the Solve.
 void setSolveOrder(int input)
          Specifies the position of the Solve in the list of Solve objects owned by the SolveGroup.
 void setSolveOrder(java.lang.String input)
          Specifies the position of the Solve in the list of Solve objects owned by the SolveGroup.
 java.lang.String WriteToXML()
          Gets an XML representation of the Solve.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, CreateAfter, CreateBefore, CreateFirst, 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

Solve

public Solve(BaseObject input)
Creates a Solve in the specified SolveGroup. To create a Solve, an application should use a factory method of the SolveGroup, such as createAggregationSolve().

Parameters:
input - The SolveGroup to own the Solve.
Method Detail

getSolveOrder

public int getSolveOrder()
Gets the position of the Solve in the list of Solve objects owned by the SolveGroup.

Returns:
An integer that indicates the position of the Solve in the list.

setSolveOrder

public void setSolveOrder(int input)
Specifies the position of the Solve in the list of Solve objects owned by the SolveGroup. For example, the following code specifies that the Solve is the third object in the list of Solve objects of the SolveGroup.
 solve.setSolveOrder(3);

Parameters:
input - An int that specifies the position of the Solve in the SolveGroup.

setSolveOrder

public void setSolveOrder(java.lang.String input)
Specifies the position of the Solve in the list of Solve objects owned by the SolveGroup. For example, the following code specifies that the Solve is the second object in the list of Solve objects of the SolveGroup.
 solve.setSolveOrder("2");

Parameters:
input - A String that contains a number that specifies the position of the Solve in the SolveGroup.

addDimensionMemberSelection

public void addDimensionMemberSelection(DimensionMemberSelection input)
Adds the specified DimensionMemberSelection to the Solve.

Parameters:
input - The DimensionMemberSelection to add.

removeDimensionMemberSelection

public void removeDimensionMemberSelection(DimensionMemberSelection input)
Removes the specified DimensionMemberSelection from the list of DimensionMemberSelection objects of the Solve.

Parameters:
input - The DimensionMemberSelection to remove.

getDimensionMemberSelection

public java.util.Vector getDimensionMemberSelection()
Gets the list of DimensionMemberSelection objects of the Solve.

Returns:
A Vector of DimensionMemberSelection objects.

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the Solve.

Overrides:
WriteToXML in class BaseObject
Returns:
A String that contains an XML representation of the Solve.

createDimensionMemberSelection

public DimensionMemberSelection createDimensionMemberSelection()
Creates a DimensionMemberSelection for the Solve. A DimensionMemberSelection specifies a selection of members of one of the Dimension objects that are owned by the Cube that is associated with the SolveDefinition that is specified by the Solve. Only the selected Dimension members participate in calculation specified by the Solve.

Returns:
The new DimensionMemberSelection.

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the Solve in the current analytic workspace of the specified database connection.

Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that represents the connection.
Returns:
A String that contains success if the method successfully deletes the Solve.

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

B14351-04

Copyright © 2003, 2007 Oracle. All rights reserved.