IOLAPCustomAggregator - BETA ActionScript® 3 (AS3 Flex) Reference for the Adobe® Flash® Platform API Reference

(Preview)

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

The IOLAPCustomAggregator interface defines the interface implemented by custom aggregator classes. An instance of a class that implements this interface can be passed to an OLAPMeasure object to define the aggregation type of the measure.

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.

Public Methods

	Method		Defined By
		computeBegin(dataField:String):Object Flex calls this method to start the computation of an aggregation value.	IOLAPCustomAggregator
		computeEnd(data:Object, dataField:String):Number Flex calls this method to end the computation of the aggregation value.	IOLAPCustomAggregator
		computeLoop(data:Object, dataField:String, value:Object):void Flex calls this method when a new value needs to be added to the aggregation.	IOLAPCustomAggregator
		computeObjectBegin(value:Object):Object Flex calls this method to start aggregation of aggregated values.	IOLAPCustomAggregator
		computeObjectEnd(value:Object, dataField:String):Number Flex calls this method to end the computation.	IOLAPCustomAggregator
		computeObjectLoop(value:Object, newValue:Object):void Flex calls this method when a new aggregated value needs to be added to the aggregation.	IOLAPCustomAggregator

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

IOLAPCustomAggregator - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.olap

computeBegin

computeEnd

computeLoop

computeObjectBegin

computeObjectEnd

computeObjectLoop

	`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.

	`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.

	`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.

	`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.