Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
mx.olap 

OLAPCube  - AS3 Flex

Пакетmx.olap
Классpublic class OLAPCube
НаследованиеOLAPCube Inheritance Proxy
Реализует IOLAPCube, IEventDispatcher

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Класс OLAPCube представляет куб OLAP.

Синтаксис MXMLexpandedСкрыть синтаксис 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=""
  />
 
  

Свойство MXML по умолчаниюelements

Связанные элементы API



Общедоступные свойства
 СвойствоОпределено
  dataProvider : ICollectionView
Плоские данные, используемые для заполнения куба OLAP.
OLAPCube
  dimensions : IList
Все размеры куба в виде списка экземпляров IOLAPDimension.
OLAPCube
  elements : Array
[только для записи] Обрабатывает входной массив и инициализирует свойства dimensions и measures, основанные на элементах массива.
OLAPCube
  measures : IList
[только для записи] Устанавливает размерности куба OLAP как список экземпляров OLAPMeasure.
OLAPCube
  name : String
Имя куба OLAP.
OLAPCube
Защищенные свойства
 СвойствоОпределено
  cubeBuildingTimeInterval : int = 5
Интервал времени в миллисекундах, используемый таймером метода refresh() для многократного построения куба.
OLAPCube
  measureDimensionName : String = "Measures"
Устанавливает имя измерения для размеров куба OLAP.
OLAPCube
  queryBuildingTimeInterval : int = 1
Интервал времени в миллисекундах, используемый таймером метода execute() для многократной обработки запросов.
OLAPCube
  resultClass : Class
Класс, используемый экземпляром OLAPCube для возврата результата.
OLAPCube
  workDuration : int = 50
Время в миллисекундах, используемое методом refresh() для многократного построения куба.
OLAPCube
Общедоступные методы
 МетодОпределено
  
OLAPCube(name:String = null)
Конструктор.
OLAPCube
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.
OLAPCube
  
Прерывает запрос, переданный для выполнения.
OLAPCube
  
Прерывает текущее обновление куба, если оно выполняется.
OLAPCube
  
Посылает событие в поток событий.
OLAPCube
  
Ставит запрос OLAP в очередь для выполнения.
OLAPCube
  
Возвращает измерение с данным именем внутри куба OLAP.
OLAPCube
  
Проверяет, имеет ли объект прослушиватели, зарегистрированные для конкретного типа события.
OLAPCube
  
Обновляет куб от поставщика данных.
OLAPCube
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Удаляет прослушиватель.
OLAPCube
  
Возвращает имя куба
OLAPCube
  
Проверяет, зарегистрирован ли прослушиватель события на этом объекте или на любом из его предшественников для указанного типа события.
OLAPCube
События
 Событие Сводка Определено
  Инициируется, когда куб создан и готов к выполнению запроса.OLAPCube
  Передается непрерывно при создании куба путем вызова метода refresh().OLAPCube
  Передается непрерывно при создании результата запроса путем вызова метода execute().OLAPCube
Сведения о свойстве

cubeBuildingTimeInterval

свойство
protected var cubeBuildingTimeInterval:int = 5

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Интервал времени в миллисекундах, используемый таймером метода refresh() для многократного построения куба. Если имеется возможность более длительного ожидания построения куба, то можно установить для него более высокое значение. Можно установить для него более низкое значение, но это может отрицательно сказаться на активности приложения.

dataProvider

свойство 
dataProvider:ICollectionView

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Плоские данные, используемые для заполнения куба OLAP. Для инициализации куба после установки этого свойства следует вызвать метод refresh().



Реализация
    public function get dataProvider():ICollectionView
    public function set dataProvider(value:ICollectionView):void

dimensions

свойство 
dimensions:IList

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Все размеры куба в виде списка экземпляров IOLAPDimension.



Реализация
    public function get dimensions():IList
    public function set dimensions(value:IList):void

elements

свойство 
elements:Array  [только для записи]

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Обрабатывает входной массив и инициализирует свойства dimensions и measures, основанные на элементах массива. Измерения представлены в массиве экземплярами класса OLAPDimension, а размерности представлены экземплярами класса OLAPMeasure.

Это свойство используется для определения измерений и размерностей куба в одиночном массиве.



Реализация
    public function set elements(value:Array):void

measureDimensionName

свойство 
protected var measureDimensionName:String = "Measures"

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Устанавливает имя измерения для размеров куба OLAP.

Значением по умолчанию является "Measures".

measures

свойство 
measures:IList  [только для записи]

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Устанавливает размерности куба OLAP как список экземпляров OLAPMeasure.



Реализация
    public function set measures(value:IList):void

name

свойство 
name:String

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Имя куба OLAP.



Реализация
    public function get name():String
    public function set name(value:String):void

queryBuildingTimeInterval

свойство 
protected var queryBuildingTimeInterval:int = 1

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Интервал времени в миллисекундах, используемый таймером метода execute() для многократной обработки запросов. Если имеется возможность более длительного ожидания создания кубом результата запроса, то можно установить для него более высокое значение. Можно установить для него более низкое значение для более быстрого получения результатов запроса, но это может отрицательно сказаться на активности приложения.

resultClass

свойство 
protected var resultClass:Class

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Класс, используемый экземпляром OLAPCube для возврата результата. Для настройки результата можно заменить класс по умолчанию, OLAPResult, собственной реализацией интерфейса IOLAPResult.

Значением по умолчанию является OLAPResult.

workDuration

свойство 
protected var workDuration:int = 50

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Время в миллисекундах, используемое методом refresh() для многократного построения куба. Более высокое значение означает, что в каждом событии таймера будет обработано больше строк. Если требуется более быстрое построение куба, то можно установить для него более высокое значение, но это может отрицательно сказаться на активности приложения.

Сведения о конструкторе

OLAPCube

()Конструктор
public function OLAPCube(name:String = null)

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Конструктор.

Параметры
name:String (default = null) — Имя куба OLAP.
Сведения о методе

addEventListener

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

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.

Параметры

type:String — Тип события.
 
listener:Function — Функция прослушивателя, обрабатывающая событие.
 
useCapture:Boolean (default = false) — Определяет, работает ли прослушиватель в фазе захвата или в целевой фазе и в фазе восходящей цепочки.
 
priority:int (default = 0) — Уровень приоритета прослушивателя события.
 
useWeakReference:Boolean (default = false) — Определяет, является ли ссылка на прослушиватель «сильной» или «слабой». «Сильная» ссылка (по умолчанию) предотвращает удаление прослушивателя сборщиком мусора. «Слабая» ссылка не выполняет эту функцию.

Связанные элементы API

cancelQuery

()метод 
public function cancelQuery(query:IOLAPQuery):void

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Прерывает запрос, переданный для выполнения.

Параметры

query:IOLAPQuery — Прерываемый запрос.

cancelRefresh

()метод 
public function cancelRefresh():void

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Прерывает текущее обновление куба, если оно выполняется.

dispatchEvent

()метод 
public function dispatchEvent(event:Event):Boolean

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Посылает событие в поток событий. Целью события является объект, для которого был вызван метод dispatchEvent().

Параметры

event:Event — Объект Event, передаваемый в поток событий.

Возвращает
Boolean — Значение true в случае успешной передачи события. Значение false указывает на ошибку или на то, что для события был вызван методpreventDefault().

Связанные элементы API

execute

()метод 
public function execute(query:IOLAPQuery):mx.rpc:AsyncToken

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Ставит запрос OLAP в очередь для выполнения. После вызова метода refresh() для обновления куба следует подождать событие complete перед вызовом метода execute().

Кубы OLAP могут быть сложными, и при этом нежелательно, чтобы приложение приостанавливалось во время вычисления Flex результатов запроса OLAP. Метод execute() возвращает экземпляр класса AsyncToken, что позволяет настраивать обработчики асинхронных операций таким образом, чтобы приложение могло продолжить выполнение в процессе обработки запроса.

При использовании класса AsyncToken настраиваются две функции обработки результатов запроса. В этом примере функция showResult() обрабатывает результаты запроса в случае успешного запроса, а функция showFault() обрабатывает все ошибки, обнаруженные в процессе выполнения запроса:

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

Параметры

query:IOLAPQuery — Выполняемый запрос, представленный экземпляром IOLAPQuery.

Возвращает
mx.rpc:AsyncToken — Экземпляр AsyncToken.

findDimension

()метод 
public function findDimension(name:String):IOLAPDimension

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Возвращает измерение с данным именем внутри куба OLAP.

Параметры

name:String — Имя измерения.

Возвращает
IOLAPDimension — Экземпляр IOLAPDimension, представляющий измерение, или значение null, если измерение не найдено.

hasEventListener

()метод 
public function hasEventListener(type:String):Boolean

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Проверяет, имеет ли объект прослушиватели, зарегистрированные для конкретного типа события. Это позволяет определить, в каком месте объект изменил обработку типа события в иерархии потока событий.

Параметры

type:String — Тип события.

Возвращает
Boolean — Значение true, если прослушиватель указанного типа зарегистрирован; в противном случае – false.

Связанные элементы API

refresh

()метод 
public function refresh():void

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Обновляет куб от поставщика данных. После установки схемы куба следует вызвать этот метод для построения куба.

Этот метод передает событие progress для отображения выполнения и событие complete, когда куб завершен и готов к выполнению запросов. Перед вызовом метода execute() для выполнения запроса следует подождать событие complete.

removeEventListener

()метод 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Удаляет прослушиватель. Если не зарегистрировано ни одного соответствующего прослушивателя, вызов этого метода не оказывает какого-либо эффекта.

Параметры

type:String — Тип события.
 
listener:Function — Удаляемый объект прослушивателя.
 
useCapture:Boolean (default = false) — Указывает, был ли прослушиватель зарегистрирован для фазы захвата или целевой фазы и фазы восходящей цепочки.

Связанные элементы API

toString

()метод 
public function toString():String

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Возвращает имя куба

Возвращает
String — Имя куба.

willTrigger

()метод 
public function willTrigger(type:String):Boolean

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Проверяет, зарегистрирован ли прослушиватель события на этом объекте или на любом из его предшественников для указанного типа события. Этот метод возвращает true, если прослушиватель события запускается во время какой-либо фазы потока событий, когда событие указанного типа передается в этот объект или один из его нижестоящих элементов.

Параметры

type:String — Тип события.

Возвращает
Boolean — Значение true, если запускается прослушиватель указанного типа; и false, если нет.

Связанные элементы API

Сведения о событии

complete

Событие
Тип объекта события: mx.events.CubeEvent
свойство CubeEvent.type = mx.events.CubeEvent.CUBE_COMPLETE

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Инициируется, когда куб создан и готов к выполнению запроса.

Константа CubeEvent.CUBE_COMPLETE определяет значение свойства type объекта события complete.

Свойства объекта события имеют следующие значения:

СвойствоЗначение
bubblesfalse
cancelabletrue
currentTargetОбъект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton.
descriptionОписание обрабатываемого в данный момент элемента.
progressКоличество обновленных элементов куба.
targetОбъект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие.
totalОбщее количество элементов куба, которые должны быть обновлены.
typeCubeEvent.CUBE_COMPLETE

progress

Событие  
Тип объекта события: mx.events.CubeEvent
свойство CubeEvent.type = mx.events.CubeEvent.CUBE_PROGRESS

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Передается непрерывно при создании куба путем вызова метода refresh().

Константа CubeEvent.CUBE_PROGRESS определяет значение свойства type объекта события progress.

Свойства объекта события имеют следующие значения:

СвойствоЗначение
bubblesfalse
cancelabletrue
currentTargetОбъект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton.
descriptionОписание обрабатываемого в данный момент элемента.
progressКоличество обновленных элементов куба.
targetОбъект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие.
totalОбщее количество элементов куба, которые должны быть обновлены.
typeCubeEvent.CUBE_PROGRESS

queryProgress

Событие  
Тип объекта события: mx.events.CubeEvent
свойство CubeEvent.type = mx.events.CubeEvent.QUERY_PROGRESS

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Передается непрерывно при создании результата запроса путем вызова метода execute().

Константа CubeEvent.CUBE_COMPLETE определяет значение свойства type объекта события queryProgress.

Свойства объекта события имеют следующие значения:

СвойствоЗначение
bubblesfalse
cancelabletrue
currentTargetОбъект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton.
descriptionОписание обрабатываемого в данный момент элемента.
progressКоличество обновленных элементов куба.
targetОбъект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие.
totalОбщее количество элементов куба, которые должны быть обновлены.
typeCubeEvent.QUERY_PROGRESS




[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.