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

B14351-04

oracle.AWXML
Class SolveGroup

java.lang.Object
  extended byoracle.AWXML.BaseObject
      extended byoracle.AWXML.SolveGroup

public class SolveGroup
extends BaseObject

A collection of Solve objects. A Solve represents a calculation that an analytic workspace performs in an aggregation, allocation, or forecasting operation.

A SolveGroup maintains a list of Solve objects. During a build operation, an analytic workspace performs the calculations in the order in which the Solve objects appear in the list. The AWAction.BuildDatabase class has methods that build the analytic workspace.

A SolveGroup is logically owned by an AW object. You create a SolveGroup with the AW.createSolveGroup method.

The SolveGroup class has methods for building the logical object in memory. It also has action methods for physically creating it or deleting it within the Oracle Database. The action methods take an AWConnection argument that specifies a JDBC connection to the Database.

See Also:
BuildDatabase

Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
SolveGroup()
          Creates a SolveGroup.
 
Method Summary
 void addSolve(Solve input)
          Adds the specified SolveSolve objects of the SolveGroup.
 void addSolveAfter(Solve input, BaseObject reference)
          Adds the specified Solve after the referenced Solve in the list of Solve objects.
 void addSolveBefore(Solve input, BaseObject reference)
          Adds the specified Solve before the referenced Solve in the list of Solve objects.
 void addSolveFirst(Solve input)
          Adds the specified Solve to the beginning of the list of Solve objects.
 java.lang.String Alter(AWConnection connection)
          Alters the textual attributes of the SolveGroup in the current analytic workspace of the specified database connection.
 java.lang.String Create(AWConnection connection)
          Creates the SolveGroup in the current analytic workspace of the specified database connection.
 AggregationSolve createAggregationSolve()
          Creates an AggregationSolve and adds at the end of the list of Solve objects of the SolveGroup.
 AggregationSolve createAggregationSolveAfter(Solve input)
          Creates an AggregationSolve and adds it after the specified Solve in the list of Solve objects.
 AggregationSolve createAggregationSolveBefore(Solve input)
          Creates an AggregationSolve and adds it before the specified Solve in the list of Solve objects.
 AggregationSolve createAggregationSolveFirst()
          Creates an AggregationSolve and adds it to the beginning of the list of Solve objects.
 AllocationSolve createAllocationSolve()
          Creates an AllocationSolve and adds at the end of the list of Solve objects of the SolveGroup.
 AllocationSolve createAllocationSolveAfter(Solve input)
          Creates an AllocationSolve and adds it after the specified Solve in the list of Solve objects.
 AllocationSolve createAllocationSolveBefore(Solve input)
          Creates an AllocationSolve and adds it before the specified Solve in the list of Solve objects.
 AllocationSolve createAllocationSolveFirst()
          Creates an AllocationSolve and adds it to the beginning of the list of Solve objects.
 ForecastSolve createForecastSolve()
          Creates an ForecastSolve and adds at the end of the list of Solve objects of the SolveGroup.
 ForecastSolve createForecastSolveAfter(Solve input)
          Creates an ForecastSolve and adds it after the specified Solve in the list of Solve objects.
 ForecastSolve createForecastSolveBefore(Solve input)
          Creates a ForecastSolve and adds it before the specified Solve in the list of Solve objects.
 ForecastSolve createForecastSolveFirst()
          Creates a ForecastSolve and adds it to the beginning of the list of Solve objects.
 java.lang.String Delete(AWConnection connection)
          Deletes the SolveGroup in the current analytic workspace of the specified database connection.
 java.lang.String getId()
          Gets the identifier of the SolveGroup.
 java.util.Vector getSolves()
          Gets the list of Solve objects of the SolveGroup.
 void removeSolve(Solve input)
          Removes the specified Solve from the list of Solve objects of the SolveGroup.
 java.lang.String WriteToXML()
          Gets an XML representation of the SolveGroup.
 
Methods inherited from class oracle.AWXML.BaseObject
CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, 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

SolveGroup

public SolveGroup()
Creates a SolveGroup.

Method Detail

getId

public java.lang.String getId()
Gets the identifier of the SolveGroup. The identifier is the full name of the SolveGroup in the format name.type.

For more information on object identifiers, see Object Identifiers.

Overrides:
getId in class BaseObject
Returns:
A String that contains the identifier of the SolveGroup.

WriteToXML

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

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

Create

public java.lang.String Create(AWConnection connection)
Creates the SolveGroup in the current analytic workspace of the specified database connection.

Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains the value success if the method succeeds.

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the SolveGroup 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:
A String that contains success if the method successfully deletes the SolveGroup.

createAggregationSolve

public AggregationSolve createAggregationSolve()
Creates an AggregationSolve and adds at the end of the list of Solve objects of the SolveGroup.

Returns:
The new AggregationSolve.

createAggregationSolveAfter

public AggregationSolve createAggregationSolveAfter(Solve input)
Creates an AggregationSolve and adds it after the specified Solve in the list of Solve objects.

Parameters:
input - The Solve after which to add the new AggregationSolve.
Returns:
The new AggregationSolve.

createAggregationSolveBefore

public AggregationSolve createAggregationSolveBefore(Solve input)
Creates an AggregationSolve and adds it before the specified Solve in the list of Solve objects.

Parameters:
input - The Solve before which to add the new AggregationSolve.
Returns:
The new AggregationSolve.

createAggregationSolveFirst

public AggregationSolve createAggregationSolveFirst()
Creates an AggregationSolve and adds it to the beginning of the list of Solve objects.

Returns:
The new AggregationSolve.

createAllocationSolve

public AllocationSolve createAllocationSolve()
Creates an AllocationSolve and adds at the end of the list of Solve objects of the SolveGroup.

Returns:
The new AggregationSolve.

createAllocationSolveAfter

public AllocationSolve createAllocationSolveAfter(Solve input)
Creates an AllocationSolve and adds it after the specified Solve in the list of Solve objects.

Parameters:
input - The Solve after which to add the new AllocationSolve.
Returns:
The new AllocationSolve.

createAllocationSolveBefore

public AllocationSolve createAllocationSolveBefore(Solve input)
Creates an AllocationSolve and adds it before the specified Solve in the list of Solve objects.

Parameters:
input - The Solve before which to add the new AllocationSolve.
Returns:
The new AllocationSolve.

createAllocationSolveFirst

public AllocationSolve createAllocationSolveFirst()
Creates an AllocationSolve and adds it to the beginning of the list of Solve objects.

Returns:
The new AllocationSolve.

createForecastSolve

public ForecastSolve createForecastSolve()
Creates an ForecastSolve and adds at the end of the list of Solve objects of the SolveGroup.

Returns:
The new ForecastSolve.

createForecastSolveAfter

public ForecastSolve createForecastSolveAfter(Solve input)
Creates an ForecastSolve and adds it after the specified Solve in the list of Solve objects.

Parameters:
input - The Solve after which to add the new ForecastSolve.
Returns:
The new ForecastSolve.

createForecastSolveBefore

public ForecastSolve createForecastSolveBefore(Solve input)
Creates a ForecastSolve and adds it before the specified Solve in the list of Solve objects.

Parameters:
input - The Solve before which to add the new ForecastSolve.
Returns:
The new ForecastSolve.

createForecastSolveFirst

public ForecastSolve createForecastSolveFirst()
Creates a ForecastSolve and adds it to the beginning of the list of Solve objects.

Returns:
The new ForecastSolve.

addSolve

public void addSolve(Solve input)
Adds the specified SolveSolve objects of the SolveGroup.

Parameters:
input - The Solve to add to the SolveGroup.

addSolveBefore

public void addSolveBefore(Solve input,
                           BaseObject reference)
Adds the specified Solve before the referenced Solve in the list of Solve objects.

Parameters:
input - The Solve to add.
reference - The Solve before which to add the specified Solve.

addSolveAfter

public void addSolveAfter(Solve input,
                          BaseObject reference)
Adds the specified Solve after the referenced Solve in the list of Solve objects.

Parameters:
input - The Solve to add.
reference - The Solve after which to add the specified Solve.

addSolveFirst

public void addSolveFirst(Solve input)
Adds the specified Solve to the beginning of the list of Solve objects.

Parameters:
input - The Solve to add.

removeSolve

public void removeSolve(Solve input)
Removes the specified Solve from the list of Solve objects of the SolveGroup.

Parameters:
input - The Solve to remove from the SolveGroup.

getSolves

public java.util.Vector getSolves()
Gets the list of Solve objects of the SolveGroup.

Returns:
A Vector that contains the Solve objects associated with the SolveGroup.

Alter

public java.lang.String Alter(AWConnection connection)
Alters the textual attributes of the SolveGroup in the current analytic workspace of the specified database connection. You can use the Alter method to change the descriptive names associated with the SolveGroup. For example, you can change the long and short descriptions and the plural name of the object.

Overrides:
Alter in class BaseObject
Parameters:
connection - The AWConnection that represents the connection.
Returns:
A String that contains success if the method successfully alters the SolveGroup.

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

B14351-04

Copyright © 2003, 2007 Oracle. All rights reserved.