OLAPCube  - AS3 Flex

The time interval, in milliseconds, used by the timer of the refresh() method to iteratively build the cube. You can set it to a higher value if you can wait longer before the cube is built. You can set it to a lower value, but it might negatively impact responsiveness of your application.

The flat data used to populate the OLAP cube. You must call the refresh() method to initialize the cube after setting this property.

All dimensions in the cube, as a list of IOLAPDimension instances.

Processes the input Array and initializes the dimensions and measures properties based on the elements of the Array. Dimensions are represented in the Array by instances of the OLAPDimension class, and measures are represented by instances of the OLAPMeasure class.

Use this property to define the dimensions and measures of a cube in a single Array.

Sets the name of the dimension for the measures of the OLAP cube.

The default value is "Measures".

Sets the measures of the OLAP cube, as a list of OLAPMeasure instances.

The name of the OLAP cube.

The time interval, in milliseconds, used by the timer of the execute() method to iteratively process queries. You can set it to a higher value if you can wait for longer before the cube generates the query result. You can set it to a lower value to obtain query results faster, but it might negatively impact the responsiveness of your application.

The class used by an OLAPCube instance to return the result. You can replace the default class, OLAPResult, with your own implementation of the IOLAPResult interface to customize the result.

The default value is OLAPResult.

The time, in milliseconds, used by the refresh() method to iteratively build the cube. A higher value would mean more rows would get processed at each timer event. You can set it to a higher value if you want the cube to be built faster, but it might negatively impact responsiveness of your application.

Constructor.

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.

Parameters

Related API Elements

Aborts a query that has been submitted for execution.

Parameters

Aborts the current cube refresh, if one is executing.

Dispatches an event into the event flow. The event target is the object upon which the dispatchEvent() method is called.

Parameters

Related API Elements

Queues an OLAP query for execution. After you call the refresh() method to update the cube, you must wait for a complete event before you call the execute() method.

OLAP cubes can be complex, so you do not want your application to pause while Flex calculates the results of your OLAP query. The execute() 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.

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:

      <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%" />
      

Parameters

Returns the dimension with the given name within the OLAP cube.

Parameters

Checks whether the object has any listeners registered for a specific type of event. This lets you determine where an object has altered handling of an event type in the event flow hierarchy.

Parameters

Related API Elements

Refreshes the cube from the data provider. After setting the cube's schema, you must call this method to build the cube.

This method dispatches a progress event to indicate progress, and dispatches a complete event when the cube is complete and ready to execute queries. You must wait for a complete event before you call the execute() method to run a query.

Removes a listener. If there no matching listener is registered, a call to this method has no effect.

Parameters

Related API Elements

Returns the name of the cube

Checks whether an event listener is registered with this object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this object or to any of its descendants.

Parameters

Related API Elements

Dispatched when a cube has been created and is ready to be queried.

The properties of the event object have the following values:

Dispatched continuously as a cube is being created by a call to the refresh() method.

The properties of the event object have the following values:

Dispatched continuously as a query result is being generated by a call to the execute() method.

The properties of the event object have the following values: