| <!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="IOLAPCube,mx.olap.IOLAPCube,COLUMN_AXIS,COLUMN_AXIS,ROW_AXIS,ROW_AXIS,SLICER_AXIS,SLICER_AXIS,TRACE_LEVEL_1,TRACE_LEVEL_2,TRACE_LEVEL_3,aggregator,allMemberName,allMemberName,attribute,attributeName,attributes,attributes,axes,axes,axes,axisOrdinal,cellData,child,child,children,children,children,children,cube,cube,cubeArray,cubeBuildingTimeInterval,cubes,cubes,dataCompareFunction,dataField,dataField,dataField,dataFunction,dataProvider,defaultMember,defaultMember,defaultMember,defaultMember,depth,depth,dimension,dimension,dimension,dimensions,dimensions,displayName,displayName,displayNameFunction,elements,elements,elements,explicitMembers,explicitMembers,formattedValue,formattedValue,hasAll,hasAll,hasAll,hierarchies,hierarchies,hierarchy,hierarchy,hierarchy,hierarchy,isAll,isAll,isMeasure,isMeasure,isMeasure,isMeasure,level,level,levels,levels,measureDimensionName,measures,members,members,members,members,members,members,members,members,members,name,name,name,name,name,name,parent,parent,parent,parent,positions,positions,query,query,queryBuildingTimeInterval,resultClass,sets,sets,traceLevel,traceOn,tuples,tuples,tuples,uniqueName,uniqueName,uniqueName,uniqueName,value,value,workDuration,addElement,addElement,addElements,addElements,addEventListener,addMember,addMember,addMember,addMember,addMembers,addMembers,addPosition,addSet,addSet,addTuple,addTuple,addTuple,addTuple,cancelQuery,cancelQuery,cancelRefresh,cancelRefresh,clear,compareMembers,computeBegin,computeEnd,computeLoop,computeObjectBegin,computeObjectEnd,computeObjectLoop,createCube,createCube,crossJoin,crossJoin,dispatchEvent,execute,execute,findAttribute,findAttribute,findChildMember,findChildMember,findCommonHierarchy,findDimension,findDimension,findHierarchy,findHierarchy,findLevel,findLevel,findMember,findMember,findMember,findMember,findMember,findMember,getAxis,getAxis,getAxis,getAxis,getCell,getCell,getCube,getCube,hasEventListener,hasRowData,hierarchize,hierarchize,refresh,refresh,removeEventListener,removePosition,setAxis,setAxis,sortTuple,toString,toString,traceMsg,union,union,willTrigger"><title>mx.olap.IOLAPCube</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 = 'IOLAPCube - 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/IOLAPCube.html&mx/olap/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">IOLAPCube</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <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("IOLAPCube"); titleBar_setSubNav(false,true,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</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IOLAPCube</td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../mx/olap/OLAPCube.html">OLAPCube</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 IOLAPCube interface represents an OLAP cube that holds |
| an N-dimensional representation of a flat data set. |
| You use an OLAP schema to define how the cube represents the |
| input flat data set. |
| <p>An OLAP cube is analogous to a table in a relational database. |
| Where a table in a relational database has two dimensions, |
| an OLAP cube can have any number of dimensions. |
| In its simplest form, the dimensions of an OLAP cube correspond |
| to a field of the flat data set.</p> |
| <p>After setting the schema of the OLAP cube, you must call |
| the <code>IOLAPCube.refresh()</code> method to build the cube. |
| Upon completion of cube initialization, the OLAP cube dispatches |
| the <code>complete</code> event to signal that the cube is ready to query.</p> |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="OLAPCube.html" target="">mx.olap.OLAPCube</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#dimensions" class="signatureLink">dimensions</a> : <a href="../../mx/collections/IList.html">IList</a><div class="summaryTableDescription">[read-only] |
| All dimensions in the cube, as a list of IOLAPDimension instances.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#name" class="signatureLink">name</a> : String<div class="summaryTableDescription">[read-only] |
| The name of the OLAP cube.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr></table></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="#cancelQuery()" class="signatureLink">cancelQuery</a>(query:<a href="../../mx/olap/IOLAPQuery.html">IOLAPQuery</a>):void</div><div class="summaryTableDescription"> |
| Aborts a query that has been submitted for execution.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#cancelRefresh()" class="signatureLink">cancelRefresh</a>():void</div><div class="summaryTableDescription"> |
| Aborts the current cube refresh, if one is executing.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#execute()" class="signatureLink">execute</a>(query:<a href="../../mx/olap/IOLAPQuery.html">IOLAPQuery</a>):<a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></div><div class="summaryTableDescription"> |
| Queues an OLAP query for execution.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#findDimension()" class="signatureLink">findDimension</a>(name:String):<a href="../../mx/olap/IOLAPDimension.html">IOLAPDimension</a></div><div class="summaryTableDescription"> |
| Returns the dimension with the given name within the OLAP cube.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#refresh()" class="signatureLink">refresh</a>():void</div><div class="summaryTableDescription"> |
| Refreshes the cube from the data provider.</div></td><td class="summaryTableOwnerCol">IOLAPCube</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="dimensions"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dimensions</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>dimensions:<a href="../../mx/collections/IList.html">IList</a></code> [read-only] <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> |
| All dimensions in the cube, as a list of IOLAPDimension instances. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get dimensions():<a href="../../mx/collections/IList.html">IList</a></code><br/></div><a name="propertyDetail"></a><a name="name"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">name</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>name:String</code> [read-only] <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> |
| The name of the OLAP cube. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get name():String</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="cancelQuery()"></a><a name="cancelQuery(mx.olap.IOLAPQuery)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cancelQuery</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function cancelQuery(query:<a href="../../mx/olap/IOLAPQuery.html">IOLAPQuery</a>):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> |
| Aborts a query that has been submitted for execution. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">query</span>:<a href="../../mx/olap/IOLAPQuery.html">IOLAPQuery</a></code> — The query to abort. |
| |
| </td></tr></table></p></div><a name="cancelRefresh()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cancelRefresh</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function cancelRefresh():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> |
| Aborts the current cube refresh, if one is executing. |
| |
| </p></div><a name="execute()"></a><a name="execute(mx.olap.IOLAPQuery)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">execute</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function execute(query:<a href="../../mx/olap/IOLAPQuery.html">IOLAPQuery</a>):<a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></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> |
| Queues an OLAP query for execution. |
| After you call the <code>refresh()</code> method to update the cube, |
| you must wait for a <code>complete</code> event |
| before you call the <code>execute()</code> method. |
| <p>OLAP cubes can be complex, so you do not want your application |
| to pause while Flex calculates the results of your OLAP query. |
| The <code>execute()</code> method returns an instance of the AsyncToken class, |
| which lets you set up handlers for asynchronous operations so that |
| your application can continue to execute during query processing.</p> |
| <p>When using the AsyncToken class, you set up two functions to handle the query results. |
| In this example, the showResult() function handles the query results when the query succeeds, |
| and the showFault() function handles any errors detected during query execution: </p> |
| <pre> |
| <mx:Script> |
| |
| // Function to execute a query. |
| private function runQuery(cube:IOLAPCube):void { |
| // Create a query instance. |
| var query:IOLAPQuery = getQuery(cube); |
| // Execute the query. |
| var token:AsyncToken = cube.execute(query); |
| // Set up handlers for the query results. |
| token.addResponder(new AsyncResponder(showResult, showFault)); |
| } |
| |
| // Handle a query fault. |
| private function showFault(result:FaultEvent, token:Object):void { |
| Alert.show("Error in query."); |
| } |
| |
| // Handle a query success. |
| private function showResult(result:Object, token:Object):void { |
| if (!result) { |
| Alert.show("No results from query."); |
| return; |
| } |
| |
| myOLAPDG.dataProvider= result as OLAPResult; |
| } |
| </mx:Script> |
| |
| <mx:OLAPDataGrid id="myOLAPDG" width="100%" height="100%" /> |
| </pre> |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">query</span>:<a href="../../mx/olap/IOLAPQuery.html">IOLAPQuery</a></code> — The query to execute, represented by an IOLAPQuery instance. |
| </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><a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></code> — An AsyncToken instance. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/rpc/AsyncToken.html" target="">mx.rpc.AsyncToken</a><br/><a href="../../mx/rpc/AsyncResponder.html" target="">mx.rpc.AsyncResponder</a></div></div><a name="findDimension()"></a><a name="findDimension(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">findDimension</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function findDimension(name:String):<a href="../../mx/olap/IOLAPDimension.html">IOLAPDimension</a></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> |
| Returns the dimension with the given name within the OLAP cube. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">name</span>:String</code> — The name of the dimension. |
| </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><a href="../../mx/olap/IOLAPDimension.html">IOLAPDimension</a></code> — An IOLAPDimension instance representing the dimension, |
| or null if a dimension is not found. |
| |
| </td></tr></table></div><a name="refresh()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">refresh</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function refresh():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> |
| Refreshes the cube from the data provider. |
| After setting the cube's schema, you must call this method to build the cube. |
| <p>This method dispatches a <code>progress</code> event to indicate progress, |
| and dispatches a <code>complete</code> event when the cube is complete |
| and ready to execute queries. |
| You must wait for a <code>complete</code> event |
| before you call the <code>execute()</code> method to run a query.</p> |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/events/CubeEvent.html" target="">mx.events.CubeEvent</a></div></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 --> |
