oracle.AWXML
Class AllocationSolve

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

public class AllocationSolve

extends Solve

A Solve that allocates hierarchical data in an analytic workspace.

Allocation is the process of creating detail data from aggregate data. Data is allocated by distributing it from the cells of a source object to the cells of a target. Allocation methods range from simple allocation, such as copying the source data to the cells of the target, to complex allocations, such as proportionally distributing the data using formulas and complex operators. Specific dimension combinations may be excluded from the allocation, causing the corresponding data cells to be locked in the target.

An AllocationSolve uses an AllocationDefinition to specify the allocation rules for the data.

Each AllocationSolve specifies a source that holds the aggregate data to allocate. Additionally, it may specify a measure that is the basis for the allocation, and a target to hold the allocated values. If you do not designate a target, the source values are allocated and stored in the source measure.

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

See Also:

AllocationDefinition, SolveGroup

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

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

Method Summary

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 AllocationSolve 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 AllocationSolve 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 AllocationSolve 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 AllocationSolve in the current analytic workspace of the specified database connection, and adds it to the beginning of the list of solves in the owning SolveGroup.
java.lang.String	Delete(AWConnection connection) Deletes the AllocationSolve in the current analytic workspace of the specified database connection.
AllocationDefinition	getAllocationDefinition() Returns the AllocationDefinition that defines the rules for this AllocationSolve.
Measure	getBase() Returns the measure on which the allocation is based.
Measure	getSource() Returns the source of the data to be allocated.
Measure	getTarget() Returns the target for the allocated values.
void	setAllocationDefinition(AllocationDefinition input) Sets the AllocationDefinition that defines the rules for this AllocationSolve.
void	setBase(Measure input) Sets the measure on which the allocation is based.
void	setSource(Measure input) Sets the source of the data to be allocated.
void	setTarget(Measure input) Sets the target for the allocated values.
java.lang.String	WriteToXML() Returns the AllocationSolve object 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

AllocationSolve

public AllocationSolve(BaseObject input)

Creates an AllocationSolve in the specified SolveGroup.

Parameters:

input - The SolveGroup that owns the AllocationSolve.

Method Detail

setTarget

public void setTarget(Measure input)

Sets the target for the allocated values.

Parameters:

input - The target Measure.

getTarget

public Measure getTarget()

Returns the target for the allocated values.

Returns:

The target Measure.

setAllocationDefinition

public void setAllocationDefinition(AllocationDefinition input)

Sets the AllocationDefinition that defines the rules for this AllocationSolve.

Parameters:

input - The AllocationDefinition to use.

getAllocationDefinition

public AllocationDefinition getAllocationDefinition()

Returns the AllocationDefinition that defines the rules for this AllocationSolve.

Returns:

The AllocationDefinition used by this AllocationSolve.

setSource

public void setSource(Measure input)

Sets the source of the data to be allocated.

Parameters:

input - The source Measure.

getSource

public Measure getSource()

Returns the source of the data to be allocated.

Returns:

The source Measure.

setBase

public void setBase(Measure input)

Sets the measure on which the allocation is based.

Parameters:

input - The base Measure.

getBase

public Measure getBase()

Returns the measure on which the allocation is based.

Returns:

The base Measure.

WriteToXML

public java.lang.String WriteToXML()

Returns the AllocationSolve object as an XML string.

Overrides:

WriteToXML in class Solve

Returns:

A String containing the XML that represents the AllocationSolve.

Create

public java.lang.String Create(AWConnection connection)

Creates the AllocationSolve 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 represents the database connection.

Returns:

"success" if successful.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

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

Overrides:

CreateFirst in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

"success" if successful.

CreateAfter

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

Creates the AllocationSolve 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 represents the database connection.

referencedObj - The referenced Solve.

Returns:

"success" if successful.

CreateBefore

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

Stores the AllocationSolve 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 represents the database connection.

referencedObj - The referenced Solve.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

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

Overrides:

Delete in class Solve

Parameters:

connection - The AWConnection that represents 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.