|
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.AggregationOperator
oracle.AWXML.BaseOperator
An object that contains an OperatorType for an aggregation
operation; the operator value of the OperatorType specifies the
method of aggregation of data over a hierarchy.
A BaseOperator is owned by an Aggregation object,
which is owned by an AggregationDefinition.
The default OperatorType operator value is SUM.
To use a weighted operator, such as HWFIRST or
WAVERAGE, you must specify a Parameter with a
keyword value of WEIGHTBY for the
AggregationArgument owned by the
Aggregation.
The following table lists the OperatorType operator values that
are valid for an aggregation and provides descriptions of them.
OperatorType Operator Values for Aggregation Methods
| Operator | Description |
|---|---|
|
|
Adds data values, then divides the sum by the number of data values that it added. |
|
|
Uses the first non- |
|
|
(Hierarchical Average) Adds data values, then divides the sum by the
number of the children in the dimension hierarchy.
Unlike |
|
|
(Hierarchical First) Uses the first data value that is specified by the
hierarchy, even when that value is |
|
|
(Hierarchical Last) Uses the last data value that is specified by the
hierarchy, even when that value is |
|
|
(Hierarchical Weighted Average) Multiplies non- |
|
|
(Hierarchical Weighted First) Multiplies by its corresponding weight value
the first data value that is specified by the hierarchy, even when that value
is |
|
|
(Hierarchical Weighted Last) Multiplies by its corresponding weight value
the last data value that is specified by the hierarchy, even when that value
is |
|
|
Uses the last non- |
|
|
Uses the largest data value among the children of any parent data value. |
|
|
Uses the smallest data value among the children of any parent data value. |
|
|
Specifies that the data values are not aggregated in the operation. |
|
|
(Scaled Sum) Adds the value of a weight object to each data value, then adds the data values. |
|
|
Adds data values. This is the default operator type. |
|
|
(Weighted Average) Multiplies each data value by a weight factor, adds the data values, and then divides that result by the sum of the weight factors. |
|
|
(Weighted First) The first non- |
|
|
(Weighted Last) The last non- |
|
|
(Weighted Maximum) The largest data value among the children of any parent data value multiplied by its corresponding weight value. |
|
|
(Weighted Minimum) The smallest data value among the children of any parent data value multiplied by its corresponding weight value. |
|
|
(Weighted Sum) Multiplies each data value by a weight factor, then adds the data values. |
Aggregation| Field Summary |
| Fields inherited from class oracle.AWXML.BaseObject |
DATABASENULL |
| Constructor Summary | |
BaseOperator(BaseObject input)
Creates a BaseOperator for the specified
Aggregation. |
|
| Method Summary | |
java.lang.String |
getOpcode()
Gets the operator value of the OperatorType of the
BaseOperator. |
OperatorType |
getOperatorType()
Gets the OperatorType of the BaseOperator. |
static boolean |
isBaseOperator(java.lang.String input)
Indicates whether the specified value is a valid operator value for the OperatorType of the BaseOperator. |
void |
setOpcode(java.lang.String input)
Specifies the operator value of the OperatorType of the
BaseOperator. |
void |
setOperatorType(OperatorType input)
Specifies an OperatorType for the BaseOperator. |
java.lang.String |
WriteToXML()
Gets an XML representation of the BaseOperator. |
| Methods inherited from class oracle.AWXML.BaseObject |
Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, 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 BaseOperator(BaseObject input)
BaseOperator for the specified
Aggregation.
The default operator value of the OperatorType for the
BaseOperator is SUM.
input - The Aggregation to own the
BaseOperator.| Method Detail |
public java.lang.String WriteToXML()
BaseOperator.
WriteToXML in class AggregationOperatorString that represents the
BaseOperator.public void setOperatorType(OperatorType input)
OperatorType for the BaseOperator.
The operator value of the OperatorType specifies the
method of aggregation.
input - An OperatorType that specifies the aggregation
method to use.public OperatorType getOperatorType()
OperatorType of the BaseOperator.
OperatorType of the BaseOperator.public java.lang.String getOpcode()
OperatorType of the
BaseOperator.
getOpcode in class AggregationOperatorString that contains the operator value of the
OperatorType of the BaseOperator.public void setOpcode(java.lang.String input)
OperatorType of the
BaseOperator.
The operator value specifies the method of aggregation.
input - A String that contains the operator value that
you want the OperatorType of the
BaseOperator to have.public static boolean isBaseOperator(java.lang.String input)
OperatorType of the BaseOperator.
input - A String that contains an operator value for
aggregation.
boolean that is true if the value is a
valid operator for aggregation, or false if it is not.
|
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 | |||||||||