ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.olap.aggregators 

MaxAggregator  - AS3 Flex

Packagemx.olap.aggregators
Classpublic class MaxAggregator
InheritanceMaxAggregator Inheritance Object
Implements IOLAPCustomAggregator

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The MaxAggregator class implements the maximum aggregator. The maximum aggregator returns the maximum value of all measures. Flex uses this aggregator when you set the OLAPMeasure.aggregator property to "MAX".

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
Flex calls this method to start the computation of an aggregation value.
MaxAggregator
  
computeEnd(data:Object, dataField:String):Number
Flex calls this method to end the computation of the aggregation value.
MaxAggregator
  
computeLoop(data:Object, dataField:String, rowData:Object):void
Flex calls this method when a new value needs to be added to the aggregation.
MaxAggregator
  
Flex calls this method to start aggregation of aggregated values.
MaxAggregator
  
computeObjectEnd(oldValue:Object, dataField:String):Number
Flex calls this method to end the computation.
MaxAggregator
  
computeObjectLoop(oldValue:Object, newValue:Object):void
Flex calls this method when a new aggregated value needs to be added to the aggregation.
MaxAggregator
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Method Detail

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.

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

Returns
Number — The aggregated value.

computeLoop

()method 
public function computeLoop(data:Object, dataField:String, rowData: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.
 
rowData: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.

Returns
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(oldValue: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

oldValue: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.

Returns
Number — The aggregated value.

computeObjectLoop

()method 
public function computeObjectLoop(oldValue: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

oldValue: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.