Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
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 キューブを表します。

MXML シンタックスexpandedMXML シンタックスを隠す

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
[書き込み専用] 入力配列を処理し、配列のエレメントに基づく次元プロパティと測定プロパティを初期化します。
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 — イベントフローに送出されるイベントオブジェクトです。

戻り値
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() メソッドを呼び出してキューブを更新したら、execute() メソッドを呼び出す前に complete イベントを待機する必要があります。

OLAP キューブは複雑なので、Flex が OLAP クエリの結果を計算しているときにアプリケーションを一時停止しないでください。 execute() メソッドは、非同期操作のハンドラーの設定を可能にする AsyncToken クラスのインスタンスを返すので、クエリ処理中にアプリケーションを実行し続けることができます。

AsyncToken クラスを使用するときは、2 つの関数を設定してクエリ結果を処理します。 この例では、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() を使用すると、myButton の値は currentTarget となります。
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() を使用すると、myButton の値は currentTarget となります。
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.QUERY_PROGRESS 定数により、イベントオブジェクトの type プロパティ値が queryProgress イベント用に定義されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ
bubblesfalse
cancelabletrue
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。
description処理対象についての説明です。
progressキューブ内の更新済みエレメントの数です。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
totalキューブ内の、更新が必要なエレメントの総数です。
typeCubeEvent.QUERY_PROGRESS




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。