protected var cubeBuildingTimeInterval:int = 5

dataProvider:ICollectionView  [read-write]

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

Implementação
    public function get dataProvider():ICollectionView
    public function set dataProvider(value:ICollectionView):void

dimensions:IList  [read-write]

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

Implementação
    public function get dimensions():IList
    public function set dimensions(value:IList):void

elements:Array  [write-only]

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.

Implementação
    public function set elements(value:Array):void

protected var measureDimensionName:String = "Measures"

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

The default value is "Measures".

measures:IList  [write-only]

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

Implementação
    public function set measures(value:IList):void

name:String  [read-write]

The name of the OLAP cube.

Implementação
    public function get name():String
    public function set name(value:String):void

protected var queryBuildingTimeInterval:int = 1

protected var resultClass:Classe

public function OLAPCube(name:String = null)

Constructor.

Parâmetros

name:String (default = null) — The name of the OLAP cube.

public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

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

Parâmetros

	type:String — The type of event.
	listener:Function — The listener function that processes the event.
	useCapture:Boolean (default = false) — Determines whether the listener works in the capture phase or the target and bubbling phases.
	priority:int (default = 0) — The priority level of the event listener.
	useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

Veja também

public function cancelQuery(query:IOLAPQuery):void

Aborts a query that has been submitted for execution.

Parâmetros

query:IOLAPQuery — The query to abort.

public function cancelRefresh():void

Aborts the current cube refresh, if one is executing.

public function dispatchEvent(event:Event):Boolean

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

Parâmetros

event:Event — The Event object that is dispatched into the event flow.

Retorna

Boolean — A value of true if the event was successfully dispatched. A value of false indicates failure or that the preventDefault() method was called on the event.

Veja também

public function execute(query:IOLAPQuery):AsyncToken

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 exemplo, 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:Object, 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%" />
      

Parâmetros

query:IOLAPQuery — The query to execute, represented by an IOLAPQuery instance.

Retorna

AsyncToken — An AsyncToken instance.

public function findDimension(name:String):IOLAPDimension

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

Parâmetros

name:String — The name of the dimension.

Retorna

IOLAPDimension — An IOLAPDimension instance representing the dimension, or null if a dimension is not found.

public function hasEventListener(type:String):Boolean

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.

Parâmetros

type:String — The type of event.

Retorna

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

Veja também

public function refresh():void

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.

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

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

Parâmetros

	type:String — The type of event.
	listener:Function — The listener object to remove.
	useCapture:Boolean (default = false) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases.

Veja também

public function toString():String

Returns the name of the cube

Retorna

String — The name of the cube.

public function willTrigger(type:String):Boolean

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.

Parâmetros

type:String — The type of event.

Retorna

Boolean — A value of true if a listener of the specified type is triggered; false otherwise.

Veja também

Event Object Type: mx.events.CubeEvent
CubeEvent.type property = mx.events.CubeEvent.CUBE_COMPLETE

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

The CubeEvent.CUBE_COMPLETE constant defines the value of the type property of the event object for a complete event.

The properties of the event object have the following values:

Propriedade	Valor
bubbles	false
cancelable	true
currentTarget	The Object that defines the event listener that handles the event. For exemplo, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
description	Descrição of what is being processed.
progress	The number of elements in the cube that have been updated.
target	The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
total	The total number of elements in the cube that need to be udpated.
type	CubeEvent.CUBE_COMPLETE

Event Object Type: mx.events.CubeEvent
CubeEvent.type property = mx.events.CubeEvent.CUBE_PROGRESS

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

The CubeEvent.CUBE_PROGRESS constant defines the value of the type property of the event object for a progress event.

The properties of the event object have the following values:

Propriedade	Valor
bubbles	false
cancelable	true
currentTarget	The Object that defines the event listener that handles the event. For exemplo, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
description	Descrição of what is being processed.
progress	The number of elements in the cube that have been updated.
target	The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
total	The total number of elements in the cube that need to be udpated.
type	CubeEvent.CUBE_PROGRESS

Event Object Type: mx.events.CubeEvent
CubeEvent.type property = mx.events.CubeEvent.QUERY_PROGRESS

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

The CubeEvent.QUERY_PROGRESS constant defines the value of the type property of the event object for a queryProgress event.

The properties of the event object have the following values:

Propriedade	Valor
bubbles	false
cancelable	true
currentTarget	The Object that defines the event listener that handles the event. For exemplo, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
description	Descrição of what is being processed.
progress	The number of elements in the cube that have been updated.
target	The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
total	The total number of elements in the cube that need to be udpated.
type	CubeEvent.QUERY_PROGRESS