oracle.AWXML
Class Solve

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.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 is owned by a SolveGroup. A Solve can own DimensionMemberSelection objects, which restrict the solve results by applying limits to its dimensions.

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.

Solves are ordered within a SolveGroup. When you create a new solve, it is added to the end of the solve group unless you specify a different position for it. The solve order determines the order in which solves are executed during an analytic workspace build.

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

See Also:

SolveDefinition, SolveGroup, BuildDatabase

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() Returns the list of DimensionMemberSelection objects for the Solve.
int	getSolveOrder() Returns the numeric position of the Solve within the SolveGroup.
void	readAWDefinitions(AWConnection connection, boolean readType) Reads the objects owned by the Solve into memory, making them available for processing within the current analytic workspace of the specified database connection.
void	removeDimensionMemberSelection(DimensionMemberSelection input) Removes the specified DimensionMemberSelection from the Solve.
void	setSolveOrder(int input) Sets the numeric position of the Solve within the SolveGroup.
void	setSolveOrder(java.lang.String input) Sets the position of the Solve within the SolveGroup to the numeric equivalent of the specified string.
java.lang.String	WriteToXML() Returns the Solve as an XML string.

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.

Parameters:

input - The SolveGroup that owns the Solve.

Method Detail

getSolveOrder

public int getSolveOrder()

Returns the numeric position of the Solve within the SolveGroup.

Returns:

The int position.

setSolveOrder

public void setSolveOrder(int input)

Sets the numeric position of the Solve within the SolveGroup.

Parameters:

input - The int position.

setSolveOrder

public void setSolveOrder(java.lang.String input)

Sets the position of the Solve within the SolveGroup to the numeric equivalent of the specified string.

Parameters:

input - The position as a String.

addDimensionMemberSelection

public void addDimensionMemberSelection(DimensionMemberSelection input)

Adds the specified DimensionMemberSelection to the Solve.

The DimensionMemberSelection selects a set of members within one of the dimensions of the Solve. The results of the solve will be limited to the selection.

Parameters:

input - The DimensionMemberSelection to add.

removeDimensionMemberSelection

public void removeDimensionMemberSelection(DimensionMemberSelection input)

Removes the specified DimensionMemberSelection from the Solve.

Parameters:

input - The DimensionMemberSelection to remove.

getDimensionMemberSelection

public java.util.Vector getDimensionMemberSelection()

Returns the list of DimensionMemberSelection objects for the Solve.

Returns:

A Vector of DimensionMemberSelection objects.

WriteToXML

public java.lang.String WriteToXML()

Returns the Solve as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the Solve.

createDimensionMemberSelection

public DimensionMemberSelection createDimensionMemberSelection()

Creates a DimensionMemberSelection for the Solve.

A DimensionMemberSelection selects a set of members within one of the dimensions of the Solve. The results of the solve will be limited to the selection.

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 specifies the database connection.

Returns:

"success" if successful.

readAWDefinitions

public void readAWDefinitions(AWConnection connection,
                              boolean readType)

Reads the objects owned by the Solve into memory, making them available for processing within the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

readType - Specify True to read the Solve and all its child objects. Specify False to read the Solve but omit specific child objects.