|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.3) B14351-03 Beta Draft |
OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values
The OLAP operator value of an OlapMeasure specifies the operation
by which an analytic workspace calculates the values of the OlapMeasure.
All of the operations reference a Measure that supplies the values upon
which the calculation is based and a time Dimension that dimensions the
Measure.
Some of the operations also reference a Hierarchy or Level of
the Dimension, or a scalar or other value that affects the calculation.
Each of these referenced objects or values is represented by a separate
OlapMeasureInput that is owned by the OlapMeasure.
An OlapMeasureInput has a keyword that identifies the referenced object
or value.
You specify the keyword with the setKeyWord method.
You specify a referenced Measure, Dimension,
Hierarchy, or Level with the setReferencedObj
method.
You specify a scalar or other value with the setScalarValue method.
In the following table, the left column lists the valid values for the OLAP operator of an OlapMeasure.
The middle columns have the OlapMeasureInput keyword and
referenced object or scalar value pairs that the OlapMeasure requires for
the operation specified by the OLAP operator value.
The right column contains brief descriptions of the operations.
| OLAP Operator Value | OlapMeasureInput Keyword |
OlapMeasureInput Referenced Object or Value | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CUMULATIVE_TOTAL_PARENT
CUMULATIVE_TOTAL_TOTAL
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Hierarchy, calculates the total
of the values of the Measure that are specified by the
selected members.
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
LAG
LEAD
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Dimension, selects the value of the
Measure that is specified by the dimension member that is
at the same level and that is at the OFFSET number of
positions away from the current member.
A LAG operation selects the value for a member
that has an end date that is less than that of the current member.
A LEAD operation selects the value for a member
that has an end date that is greater than that of the current member.
For example, if the operator is |
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
OFFSET
|
A scalar value that specifies the number of time members that is the offset for the lag or lead operation. | ||||||||||||||||||||||||||
MOVINGAVERAGE
MOVINGMAX
MOVINGMIN
MOVINGTOTAL
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Dimension, performs a calculation
on the range of Measure values that are specified by the
selected Dimension members.
The
The |
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
START
|
A scalar value that specifies an offset from the position of the current
time Dimension member.
|
||||||||||||||||||||||||||
STOP
|
A scalar value that specifies an offset from the position of the current
time Dimension member.
|
||||||||||||||||||||||||||
STEP
|
A scalar value that specifies which values in the range to include in the calculation. | ||||||||||||||||||||||||||
PERIOD_TO_DATE
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Level, performs a calculation
on the Measure values that are specified by the members
that are in a period that includes the current Level member
and all of the Level members that have same parent and that
have an end date that is less than that of the current member.
The
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
LEVEL
|
A Level that is owned by the Hierarchy.
|
||||||||||||||||||||||||||
OPERATION
|
A String that specifies the operation.
Valid values are the following:AVERAGELARGESTSMALLESTTOTAL
|
||||||||||||||||||||||||||
FUTURE_PERIODPRIOR_PERIODPRIOR_PERIOD_VARIANCEPRIOR_PERIOD_VARIANCE_PERCENTAGE
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Hierarchy, selects the value of the
Measure that is specified by the member of the hierarchy
that is at the same level, that is at the OFFSET number of
positions away from the current member, and that has an end date that
is less than that of the current member, for prior periods, or that
is greater than that of the current member for a future period.
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
OFFSET
|
A scalar value that specifies a period before or after the current period. | ||||||||||||||||||||||||||
RANK_LEVEL
RANK_PARENT
RANK_TOTAL
|
MEASURE
|
The Measure that is the base of the operation.
|
Ranks the values of the Measure specified by the selected
members of the Hierarchy.
These operations produce an OlapMeasure that has, for each
selected member, the rank of the value of the base Measure for
that member.
A
A
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
DIRECTION
|
A String that specifies the direction of the ranking, either
highest to lowest or lowest to highest.
The values for this keyword are HL or LH.
|
||||||||||||||||||||||||||
SAME_PERIOD_ANCESTORS_AGOSAME_PERIOD_ANCESTORS_AGO_VARIANCESAME_PERIOD_ANCESTORS_AGO_VARIANCESAME_PERIOD_ANCESTORS_AGO_FVD
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Hierarchy, selects the value of the
Measure that is specified by the member of the hierarchy
that is in the same level as the current member, and that is in the
position relative to the ancestor that is the OFFSET number
of positions away from the ancestor of the current member.
The ancestor is determined by the referenced Level.
If the current member is a member of the referenced
If the current member is a member of a
To illustrate the various members that an operation selects depending on the
referenced
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
OFFSET
|
A scalar value that specifies the number of time members that is the offset for the prior period operation. | ||||||||||||||||||||||||||
SHARE_TO_LEVEL
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Level, calculates the percentage
that the value for the member represents of the total value of the
base Measure for the members of the Level.
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
LEVEL
|
A Level that is owned by the Hierarchy.
|
||||||||||||||||||||||||||
SHARE_TO_PARENT
SHARE_TO_TOTAL
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Hierarchy, calculates the percentage
that the value for the member represents of the total value of the
base Measure for the selected members.
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|
||||||||||||||||||||||||||
HIERARCHY
|
A Hierarchy that is owned by the time Dimension.
|
||||||||||||||||||||||||||
YEAR_TO_DATE
|
MEASURE
|
The Measure that is the base of the operation.
|
For each member of the Dimension, calculates the total of the
values of the Measure that are specified by the current member
and all of the members that are at the same Level as the
current member, that have the same year as an ancestor, and that have an
end date less than that of the current member.
|
||||||||||||||||||||||||
DIMENSION
|
A time Dimension that dimensions the Measure.
|