|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.4) B14351-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectoracle.AWXML.BaseObject
oracle.AWXML.Solve
oracle.AWXML.AllocationSolve
A Solve that allocates data down one or more dimension
hierarchies from a source measure to a target measure in an analytic
workspace.
An allocation operation creates detail data from aggregate data.
Allocation methods range from a simple allocation, such as copying values from
the source measure to the target measure, to complex allocations, such as
proportionally distributing the data using formulas and complex allocation
operator types.
Specific dimension combinations can be excluded from the
allocation, causing the corresponding measure values to be locked
in the target.
An AllocationSolve uses an AllocationDefinition
to specify the allocation operator types and the members of the hierarchies
that participate in the allocation.
Each AllocationSolve specifies a source that has the aggregate
data to allocate.
Additionally, the AllocationSolve can specify a measure
that is the basis for the allocation, and a target that receives the
allocated values.
If you do not designate a target, then the source values are allocated and
stored in the source measure.
| Field Summary |
| 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 text attributes of the AllocationSolve in an
analytic workspace. |
java.lang.String |
Create(AWConnection connection)
Creates an AllocationSolve and adds it to the end of the list
of Solve objects of the SolveGroup that is owned
by the AW object that represents the current analytic
workspace of the specified database connection. |
java.lang.String |
CreateAfter(AWConnection connection,
BaseObject referencedObj)
Creates an AllocationSolve and adds it after the referenced
AllocationSolve to the list of Solve objects of
the SolveGroup that is owned by the AW object
that represents the current analytic workspace of the specified database
connection. |
java.lang.String |
CreateBefore(AWConnection connection,
BaseObject referencedObj)
Creates an AllocationSolve and adds it before the referenced
AllocationSolve to the list of Solve objects of
the SolveGroup that is owned by the AW object
that represents the current analytic workspace of the specified database
connection. |
java.lang.String |
CreateFirst(AWConnection connection)
Creates an AllocationSolve and adds it at the beginning of the
list of Solve objects of the SolveGroup that is
owned by the AW object that represents the current analytic
workspace of the specified database connection. |
java.lang.String |
Delete(AWConnection connection)
Deletes the AllocationSolve from the list of Solve
objects of the SolveGroup that is owned by the
AW object that represents the current analytic workspace of
the specified database connection. |
AllocationDefinition |
getAllocationDefinition()
Gets the AllocationDefinition that defines the rules for the
AllocationSolve. |
Measure |
getBase()
Gets the Measure on which the allocation is based. |
Measure |
getSource()
Gets the source of the data to allocate. |
Measure |
getTarget()
Gets the Measure that is the target of the allocation
operation. |
void |
setAllocationDefinition(AllocationDefinition input)
Specifies the AllocationDefinition that defines the rules
for this AllocationSolve. |
void |
setBase(Measure input)
Specifies a Measure that provides the data that determines
which values of the target receive allocated data and, in an even or
proportional operation, the amount of the source data that is allocated to
a target Measure. |
void |
setSource(Measure input)
Specifies the source of the data to allocate. |
void |
setTarget(Measure input)
Specifies the target Measure for the allocated values. |
java.lang.String |
WriteToXML()
Gets an XML representation of the AllocationSolve. |
| Methods inherited from class oracle.AWXML.Solve |
addDimensionMemberSelection, createDimensionMemberSelection, getDimensionMemberSelection, getSolveOrder, 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 |
public AllocationSolve(BaseObject input)
AllocationSolve in
the specified SolveGroup.
input - The SolveGroup for which you want to create a
new AllocationSolve.| Method Detail |
public void setTarget(Measure input)
Measure for the allocated values.
input - The Measure that you want to receive the
allocated data.public Measure getTarget()
Measure that is the target of the allocation
operation.
Measure that receives the allocated data.public void setAllocationDefinition(AllocationDefinition input)
AllocationDefinition that defines the rules
for this AllocationSolve.
input - The AllocationDefinition to use.public AllocationDefinition getAllocationDefinition()
AllocationDefinition that defines the rules for the
AllocationSolve.
AllocationDefinition for the
AllocationSolve.public void setSource(Measure input)
input - The Measure that is the source of the data
to allocate.public Measure getSource()
Measure that is the source of the data
to allocate.public void setBase(Measure input)
Measure that provides the data that determines
which values of the target receive allocated data and, in an even or
proportional operation, the amount of the source data that is allocated to
a target Measure.
When the OperatorType specified by an
AllocationOperator is a copy operator (COPY,
MAX, MIN, FIRST, or
LAST), the base Measure values determine which
target values the allocation updates.
When the OperatorType is EVEN, then
the operation derives the counts for the allocation from the base.
When the OperatorType is the PROPORTIONAL, then
the operation uses the base data to determine the amount to allocate to
each target value.
When the OperatorType is HCOPY,
HFIRST, HLAST, or HEVEN, then the
operation does not use the base measure.
Instead, it allocates the source data to all of the target values in the
dimension hierarchy that is specified by the
AllocationHierarchySpecification.
When the same Measure is both the base and the target, the
current values of the target determine the allocation.
If you do not specify a base, then the allocation operation command uses
the source Measure as the base.
input - The Measure that you want to use as the basis
of the allocation operation.public Measure getBase()
Measure on which the allocation is based.
Measure.public java.lang.String WriteToXML()
AllocationSolve.
WriteToXML in class SolveString that represents the
AllocationSolve.public java.lang.String Create(AWConnection connection)
AllocationSolve and adds it to the end of the list
of Solve objects of the SolveGroup that is owned
by the AW object that represents the current analytic
workspace of the specified database connection.
Create in class BaseObjectconnection - The AWConnection that represents the
database connection.
String that contains success if
the method successfully creates the AllocationSolve.public java.lang.String CreateFirst(AWConnection connection)
AllocationSolve and adds it at the beginning of the
list of Solve objects of the SolveGroup that is
owned by the AW object that represents the current analytic
workspace of the specified database connection.
CreateFirst in class BaseObjectconnection - The AWConnection that represents the
database connection.
String that contains success if
the method successfully creates the AllocationSolve.
public java.lang.String CreateAfter(AWConnection connection,
BaseObject referencedObj)
AllocationSolve and adds it after the referenced
AllocationSolve to the list of Solve objects of
the SolveGroup that is owned by the AW object
that represents the current analytic workspace of the specified database
connection.
CreateAfter in class BaseObjectconnection - The AWConnection that represents the
database connection.referencedObj - The AllocationSolve after which you want
to add the new AllocationSolve.
String that contains success if
the method successfully creates the AllocationSolve.
public java.lang.String CreateBefore(AWConnection connection,
BaseObject referencedObj)
AllocationSolve and adds it before the referenced
AllocationSolve to the list of Solve objects of
the SolveGroup that is owned by the AW object
that represents the current analytic workspace of the specified database
connection.
CreateBefore in class BaseObjectconnection - The AWConnection that represents the
database connection.referencedObj - The AllocationSolve before which you want
to add the new AllocationSolve.
String that contains success if
the method successfully creates the AllocationSolve.public java.lang.String Delete(AWConnection connection)
AllocationSolve from the list of Solve
objects of the SolveGroup that is owned by the
AW object that represents the current analytic workspace of
the specified database connection.
Delete in class Solveconnection - The AWConnection that specifies the
database connection.
String that contains success if this
method successfully deletes the AllocationSolve.public java.lang.String Alter(AWConnection connection)
AllocationSolve in an
analytic workspace.
Alter in class BaseObjectconnection - The AWConnection that represents the
database connection.
String that contains success if
the method successfully alters the AllocationSolve.
|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.4) B14351-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||