Package | mx.olap |
Interface | public interface IOLAPCustomAggregator |
Implementors | AverageAggregator, CountAggregator, MaxAggregator, MinAggregator, SumAggregator |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
You use the methods of this interface in two groups. The first group consists of the
computeBegin()
, computeLoop()
, and computeEnd()
methods.
Use these methods to compute an aggregation of the values of a measure.
The second group consists of the
computeObjectBegin()
, computeObjectLoop()
,
and computeObjectEnd()
methods.
Use these methods to compute an aggregation of aggregated values.
Method | Defined By | ||
---|---|---|---|
Flex calls this method to start the computation of an aggregation value. | IOLAPCustomAggregator | ||
Flex calls this method to end the computation of the aggregation value. | IOLAPCustomAggregator | ||
Flex calls this method when a new value needs to be added to the aggregation. | IOLAPCustomAggregator | ||
Flex calls this method to start aggregation of aggregated values. | IOLAPCustomAggregator | ||
Flex calls this method to end the computation. | IOLAPCustomAggregator | ||
Flex calls this method when a new aggregated value needs to be added to the aggregation. | IOLAPCustomAggregator |
computeBegin | () | method |
public function computeBegin(dataField:String):Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls this method to start the computation of an aggregation value.
Parameters
dataField:String — The name of the OLAPMeasure.dataField property
for the measure to be aggregated.
|
Object — An Object initialized for the aggregation.
Use this Object to hold any information necessary to perform the aggregation.
You pass this Object to subsequent calls to the computeLoop()
and computeEnd() methods.
|
computeEnd | () | method |
public function computeEnd(data:Object, dataField:String):Number
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls this method to end the computation of the aggregation value.
Parameters
data:Object — The Object returned by the call to the computeLoop() method.
Use this Object to hold information necessary to perform the aggregation.
| |
dataField:String — The name of the OLAPMeasure.dataField property
for the measure to be aggregated.
|
Number — The aggregated value.
|
computeLoop | () | method |
public function computeLoop(data:Object, dataField:String, value:Object):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls this method when a new value needs to be added to the aggregation.
Parameters
data:Object — The Object returned by the call to the computeBegin() method,
or calculated by a previous call to the computeLoop() method.
Use this Object to hold information necessary to perform the aggregation.
This method modifies this Object; it does not return a value.
| |
dataField:String — The name of the OLAPMeasure.dataField property
for the measure to be aggregated.
| |
value:Object — The object representing the rows data that is being analyzed.
|
computeObjectBegin | () | method |
public function computeObjectBegin(value:Object):Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls this method to start aggregation of aggregated values. Calculating the average value of a group of averages is an example of an aggregation of aggregated values.
Parameters
value:Object — The Object returned by the call to the computeEnd() method
for a previous aggregation.
Use this Object to hold the information necessary to perform the aggregation.
|
Object — An Object initialized for the aggregation.
Use this Object to hold any information necessary to perform the aggregation.
You pass this Object to subsequent calls to the computeObjectLoop()
and computeObjectEnd() methods.
|
computeObjectEnd | () | method |
public function computeObjectEnd(value:Object, dataField:String):Number
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls this method to end the computation.
Parameters
value:Object — The Object returned by a call to the computeObjectLoop() method
that is used to store the aggregation results.
This method modifies this Object; it does not return a value.
| |
dataField:String — The name of the OLAPMeasure.dataField property
for the measure to be aggregated.
|
Number — The aggregated value.
|
computeObjectLoop | () | method |
public function computeObjectLoop(value:Object, newValue:Object):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls this method when a new aggregated value needs to be added to the aggregation.
Parameters
value:Object — The Object returned by a call the computeObjectBegin() method,
or calculated by a previous call to the computeObjectLoop() method.
This method modifies this Object; it does not return a value.
| |
newValue:Object — The Object returned by the call to the computeEnd() method
for a previous aggregation.
|
Thu Dec 6 2018, 01:12 PM -08:00