| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="SumAggregator,mx.olap.aggregators.SumAggregator,computeBegin,computeBegin,computeBegin,computeBegin,computeBegin,computeEnd,computeEnd,computeEnd,computeEnd,computeEnd,computeLoop,computeLoop,computeLoop,computeLoop,computeLoop,computeObjectBegin,computeObjectBegin,computeObjectBegin,computeObjectBegin,computeObjectBegin,computeObjectEnd,computeObjectEnd,computeObjectEnd,computeObjectEnd,computeObjectEnd,computeObjectLoop,computeObjectLoop,computeObjectLoop,computeObjectLoop,computeObjectLoop"><title>mx.olap.aggregators.SumAggregator</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'SumAggregator - ApacheFlex API Reference'; |
| var baseRef = '../../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a> | <a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a> | <a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a> | <a id="framesLink1" href="../../../index.html?mx/olap/aggregators/SumAggregator.html&mx/olap/aggregators/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">SumAggregator</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("SumAggregator"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.olap.aggregators</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SumAggregator</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">SumAggregator <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../mx/olap/IOLAPCustomAggregator.html">IOLAPCustomAggregator</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The SumAggregator class implements the sum aggregator. |
| The sum aggregator returns the sum of all measures. |
| Flex uses this aggregator when you set the <code>OLAPMeasure.aggregator</code> property |
| to <code>"SUM"</code>. |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../mx/olap/OLAPMeasure.html" target="">mx.olap.OLAPMeasure</a></div><br/><hr></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#computeBegin()" class="signatureLink">computeBegin</a>(dataField:String):Object</div><div class="summaryTableDescription"> |
| |
| Flex calls this method to start the computation of an aggregation value.</div></td><td class="summaryTableOwnerCol">SumAggregator</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#computeEnd()" class="signatureLink">computeEnd</a>(data:Object, dataField:String):Number</div><div class="summaryTableDescription"> |
| |
| Flex calls this method to end the computation of the aggregation value.</div></td><td class="summaryTableOwnerCol">SumAggregator</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#computeLoop()" class="signatureLink">computeLoop</a>(data:Object, dataField:String, rowData:Object):void</div><div class="summaryTableDescription"> |
| |
| Flex calls this method when a new value needs to be added to the aggregation.</div></td><td class="summaryTableOwnerCol">SumAggregator</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#computeObjectBegin()" class="signatureLink">computeObjectBegin</a>(value:Object):Object</div><div class="summaryTableDescription"> |
| |
| Flex calls this method to start aggregation of aggregated values.</div></td><td class="summaryTableOwnerCol">SumAggregator</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#computeObjectEnd()" class="signatureLink">computeObjectEnd</a>(oldValue:Object, dataField:String):Number</div><div class="summaryTableDescription"> |
| |
| Flex calls this method to end the computation.</div></td><td class="summaryTableOwnerCol">SumAggregator</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#computeObjectLoop()" class="signatureLink">computeObjectLoop</a>(oldValue:Object, newValue:Object):void</div><div class="summaryTableDescription"> |
| |
| Flex calls this method when a new aggregated value needs to be added to the aggregation.</div></td><td class="summaryTableOwnerCol">SumAggregator</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="computeBegin()"></a><a name="computeBegin(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computeBegin</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function computeBegin(dataField:String):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Flex calls this method to start the computation of an aggregation value. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">dataField</span>:String</code> — The name of the <code>OLAPMeasure.dataField</code> property |
| for the measure to be aggregated. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — 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 <code>computeLoop()</code> |
| and <code>computeEnd()</code> methods. |
| |
| </td></tr></table></div><a name="computeEnd()"></a><a name="computeEnd(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computeEnd</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function computeEnd(data:Object, dataField:String):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Flex calls this method to end the computation of the aggregation value. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:Object</code> — The Object returned by the call to the <code>computeLoop()</code> method. |
| Use this Object to hold information necessary to perform the aggregation. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">dataField</span>:String</code> — The name of the <code>OLAPMeasure.dataField</code> property |
| for the measure to be aggregated. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The aggregated value. |
| |
| </td></tr></table></div><a name="computeLoop()"></a><a name="computeLoop(Object,String,Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computeLoop</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function computeLoop(data:Object, dataField:String, rowData:Object):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Flex calls this method when a new value needs to be added to the aggregation. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:Object</code> — The Object returned by the call to the <code>computeBegin()</code> method, |
| or calculated by a previous call to the <code>computeLoop()</code> method. |
| Use this Object to hold information necessary to perform the aggregation. |
| This method modifies this Object; it does not return a value. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">dataField</span>:String</code> — The name of the <code>OLAPMeasure.dataField</code> property |
| for the measure to be aggregated. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">rowData</span>:Object</code> — The object representing the rows data that is being analyzed. |
| |
| </td></tr></table></p></div><a name="computeObjectBegin()"></a><a name="computeObjectBegin(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computeObjectBegin</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function computeObjectBegin(value:Object):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| 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. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">value</span>:Object</code> — The Object returned by the call to the <code>computeEnd()</code> method |
| for a previous aggregation. |
| Use this Object to hold the information necessary to perform the aggregation. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — 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 <code>computeObjectLoop()</code> |
| and <code>computeObjectEnd()</code> methods. |
| |
| </td></tr></table></div><a name="computeObjectEnd()"></a><a name="computeObjectEnd(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computeObjectEnd</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function computeObjectEnd(oldValue:Object, dataField:String):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Flex calls this method to end the computation. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">oldValue</span>:Object</code> — The Object returned by a call to the <code>computeObjectLoop()</code> method |
| that is used to store the aggregation results. |
| This method modifies this Object; it does not return a value. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">dataField</span>:String</code> — The name of the <code>OLAPMeasure.dataField</code> property |
| for the measure to be aggregated. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The aggregated value. |
| |
| </td></tr></table></div><a name="computeObjectLoop()"></a><a name="computeObjectLoop(Object,Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computeObjectLoop</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function computeObjectLoop(oldValue:Object, newValue:Object):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Flex calls this method when a new aggregated value needs to be added to the aggregation. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">oldValue</span>:Object</code> — The Object returned by a call the <code>computeObjectBegin()</code> method, |
| or calculated by a previous call to the <code>computeObjectLoop()</code> method. |
| This method modifies this Object; it does not return a value. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newValue</span>:Object</code> — The Object returned by the call to the <code>computeEnd()</code> method |
| for a previous aggregation. |
| |
| </td></tr></table></p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
