Referencia de ActionScript® 3.0 para la plataforma de Adobe® Flash®
Inicio  |  Ocultar lista de paquetes y clases |  Paquetes  |  Clases  |  Novedades  |  Índice  |  Apéndices  |  ¿Por qué hay texto en inglés?
Filtros: Recuperando datos del servidor...
Recuperando datos del servidor...
mx.olap 

OLAPCube  - AS3 Flex

Paquetemx.olap
Clasepublic class OLAPCube
HerenciaOLAPCube Inheritance Proxy
Implementa IOLAPCube, IEventDispatcher

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

The OLAPCube class represents an OLAP cube.

Sintaxis MXMLexpandedOcultar sintaxis MXML

The <mx:OLAPCube> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:OLAPCube
    Properties
    dataProvider=""
    dimensions=""
    elements=""
    measures=""
  />
 
  

Propiedad MXML predeterminadaelements

Más ejemplos

Elementos de API relacionados



Propiedades públicas
 PropiedadDefinido por
  dataProvider : ICollectionView
The flat data used to populate the OLAP cube.
OLAPCube
  dimensions : IList
All dimensions in the cube, as a list of IOLAPDimension instances.
OLAPCube
  elements : Array
[solo escritura] Processes the input Array and initializes the dimensions and measures properties based on the elements of the Array.
OLAPCube
  measures : IList
[solo escritura] Sets the measures of the OLAP cube, as a list of OLAPMeasure instances.
OLAPCube
  name : String
The name of the OLAP cube.
OLAPCube
Propiedades protegidas
 PropiedadDefinido por
  cubeBuildingTimeInterval : int = 5
The time interval, in milliseconds, used by the timer of the refresh() method to iteratively build the cube.
OLAPCube
  measureDimensionName : String = "Measures"
Sets the name of the dimension for the measures of the OLAP cube.
OLAPCube
  queryBuildingTimeInterval : int = 1
The time interval, in milliseconds, used by the timer of the execute() method to iteratively process queries.
OLAPCube
  resultClass : Class
The class used by an OLAPCube instance to return the result.
OLAPCube
  workDuration : int = 50
The time, in milliseconds, used by the refresh() method to iteratively build the cube.
OLAPCube
Métodos públicos
 MétodoDefinido por
  
OLAPCube(name:String = null)
Constructor.
OLAPCube
  
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.
OLAPCube
  
Aborts a query that has been submitted for execution.
OLAPCube
  
Aborts the current cube refresh, if one is executing.
OLAPCube
  
Dispatches an event into the event flow.
OLAPCube
  
Queues an OLAP query for execution.
OLAPCube
  
Returns the dimension with the given name within the OLAP cube.
OLAPCube
  
Checks whether the object has any listeners registered for a specific type of event.
OLAPCube
  
Refreshes the cube from the data provider.
OLAPCube
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener.
OLAPCube
  
Returns the name of the cube
OLAPCube
  
Checks whether an event listener is registered with this object or any of its ancestors for the specified event type.
OLAPCube
Eventos
 Evento Resumen Definido por
  Dispatched when a cube has been created and is ready to be queried.OLAPCube
  Dispatched continuously as a cube is being created by a call to the refresh() method.OLAPCube
  Dispatched continuously as a query result is being generated by a call to the execute() method.OLAPCube
Información sobre propiedades

cubeBuildingTimeInterval

propiedad
protected var cubeBuildingTimeInterval:int = 5

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

dataProvider

propiedad 
dataProvider:ICollectionView

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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



Implementación
    public function get dataProvider():ICollectionView
    public function set dataProvider(value:ICollectionView):void

dimensions

propiedad 
dimensions:IList

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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



Implementación
    public function get dimensions():IList
    public function set dimensions(value:IList):void

elements

propiedad 
elements:Array  [solo escritura]

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.



Implementación
    public function set elements(value:Array):void

measureDimensionName

propiedad 
protected var measureDimensionName:String = "Measures"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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

El valor predeterminado es "Measures".

measures

propiedad 
measures:IList  [solo escritura]

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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



Implementación
    public function set measures(value:IList):void

name

propiedad 
name:String

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

The name of the OLAP cube.



Implementación
    public function get name():String
    public function set name(value:String):void

queryBuildingTimeInterval

propiedad 
protected var queryBuildingTimeInterval:int = 1

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

resultClass

propiedad 
protected var resultClass:Class

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

El valor predeterminado es OLAPResult.

workDuration

propiedad 
protected var workDuration:int = 50

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

Información sobre constructores

OLAPCube

()Información sobre
public function OLAPCube(name:String = null)

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

Constructor.

Parámetros
name:String (default = null) — The name of the OLAP cube.
Información sobre métodos

addEventListener

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

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

Elementos de API relacionados

cancelQuery

()método 
public function cancelQuery(query:IOLAPQuery):void

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

Aborts a query that has been submitted for execution.

Parámetros

query:IOLAPQuery — The query to abort.

cancelRefresh

()método 
public function cancelRefresh():void

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

Aborts the current cube refresh, if one is executing.

dispatchEvent

()método 
public function dispatchEvent(event:Event):Boolean

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

Valor devuelto
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.

Elementos de API relacionados

execute

()método 
public function execute(query:IOLAPQuery):mx.rpc:AsyncToken

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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

Parámetros

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

Valor devuelto
mx.rpc:AsyncToken — An AsyncToken instance.

findDimension

()método 
public function findDimension(name:String):IOLAPDimension

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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

Parámetros

name:String — The name of the dimension.

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

hasEventListener

()método 
public function hasEventListener(type:String):Boolean

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

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

Elementos de API relacionados

refresh

()método 
public function refresh():void

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

removeEventListener

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

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

Elementos de API relacionados

toString

()método 
public function toString():String

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

Returns the name of the cube

Valor devuelto
String — The name of the cube.

willTrigger

()método 
public function willTrigger(type:String):Boolean

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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.

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

Elementos de API relacionados

Información sobre eventos

complete

Evento
Tipo de objeto de evento: mx.events.CubeEvent
propiedad CubeEvent.type = mx.events.CubeEvent.CUBE_COMPLETE

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
descriptionDescription of what is being processed.
progressThe number of elements in the cube that have been updated.
targetThe 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.
totalThe total number of elements in the cube that need to be udpated.
typeCubeEvent.CUBE_COMPLETE

progress

Evento  
Tipo de objeto de evento: mx.events.CubeEvent
propiedad CubeEvent.type = mx.events.CubeEvent.CUBE_PROGRESS

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
descriptionDescription of what is being processed.
progressThe number of elements in the cube that have been updated.
targetThe 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.
totalThe total number of elements in the cube that need to be udpated.
typeCubeEvent.CUBE_PROGRESS

queryProgress

Evento  
Tipo de objeto de evento: mx.events.CubeEvent
propiedad CubeEvent.type = mx.events.CubeEvent.QUERY_PROGRESS

Versión del lenguaje: ActionScript 3.0
Versión de producto: Flex 3
Versiones de motor de ejecución: Flash Player 9, AIR 1.1

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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
descriptionDescription of what is being processed.
progressThe number of elements in the cube that have been updated.
targetThe 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.
totalThe total number of elements in the cube that need to be udpated.
typeCubeEvent.QUERY_PROGRESS




[ X ]¿Por qué hay texto en inglés?
Cierto contenido de la Referencia de ActionScript 3.0 se muestra en inglés

No todo el contenido de la Referencia de ActionScript 3.0 se traduce a todos los idiomas. Si un elemento del lenguaje no se traduce, aparecerá en inglés. Por ejemplo, la clase ga.controls.HelpBox no está traducida en ningún idioma. Por lo tanto, en la versión en español de la referencia, la clase ga.controls.HelpBox aparecerá en inglés.