DeepSeeResultSet
このオブジェクトを使用できる場所
このオブジェクトは、クライアント側の JavaScript コード内で使用できます (そのコードで DeepSee.js がインクルードされている場合)。“DeepSee JavaScript API の概要” を参照してください。
このオブジェクトの作成
結果セットを作成するには、データ・コントローラ・オブジェクトの getCurrentData() メソッドを呼び出します。
または、次のようなコードを使用します。
var resultset = new DeepSeeResultSet(connection,widget,wait,timeout);
以下はその説明です。
-
connection — DeepSee データ・コネクタ・オブジェクト。
-
widget — データ・コントローラを使用するページ上の HTML 要素の ID を指定します。
-
wait — ブーリアン値。このパラメータの値が false の場合は、サーバは直ちに応答します。このパラメータの値が true の場合は、クエリが完了するかタイムアウトになるまで、サーバは応答しません。
-
timeout — 最終の未完了クエリ結果を返すまでサーバが待機する時間を指定します (秒単位)。
このオブジェクトのプロパティ
DeepSee の結果セット・オブジェクトには、以下のプロパティがあります。
-
connection — DeepSee データ・コネクタ・オブジェクト。
-
widget — データ・コントローラを使用するページ上の HTML 要素の ID を指定します。
-
wait — ブーリアン値。このプロパティの値が false の場合は、サーバは直ちに応答します。このプロパティの値が true の場合は、クエリが完了するかタイムアウトになるまで、サーバは応答しません。
-
timeout — 最終の未完了クエリ結果を返すまでサーバが待機する時間を指定します (秒単位)。
-
data — クエリ結果が含まれています。
-
pollInterval — 保留中の結果の更新をサーバに要求するまでの待機時間を指定します (ミリ秒単位)。既定は 1000 です。
このオブジェクトのメソッド
DeepSee 結果セット・オブジェクトには、以下の JavaScript メソッドがあります。
getColumnCount()
結果セット内の列数を返します。
getCubeName()
現在使用されているキューブの名前を返します。
getErrorMessage()
このメソッドは、応答オブジェクトに含まれているエラー・メッセージ (ある場合) のテキストを返します。
getOrdinalLabel(axis, position)
以下はその説明です。
-
axis は、ラベルを取得する軸の番号です。列の場合は 1 を指定し、行の場合は 2 を指定します。
-
position は、ラベルを取得する当該軸上の位置です。軸上の先頭位置の場合は 1 を指定します。
指定された軸上の指定された位置のラベルに対応する、文字列の配列を返します。
getOrdinalValue(rowNo,colNo,formatted)
以下はその説明です。
-
rowNo は行番号です (先頭は 1)。
-
colNo は列番号です (先頭は 1)。
指定されたセルの値を返します。
getQueryStatus()
クエリが完了したかどうかを示す数値を返します。クエリが完了している場合は、この値は 100 です。そうでない場合、この値は 100 未満になります。
getRowCount()
結果セット内の行数を返します。
isError()
エラーが発生したことが応答オブジェクトによって示されている場合は、このメソッドは true を返します。そうでない場合は、false を返します。
runMDXQuery(mdx,finalCallback,pendingCallback,filters)
以下はその説明です。
-
mdx は MDX SELECT クエリです。
-
finalCallback は、このページ上のコールバック関数の名前です。
-
pendingCallback (オプション) は、このページ上のもう 1 つのコールバック関数の名前です。
-
filters は、クエリに適用する追加のフィルタを指定します。
このメソッドは、指定された MDX クエリを実行します。クエリが保留中のときや完了したときは、DeepSee は指定されたコールバック関数を呼び出します。
このメソッドには戻り値はありません。
runMDXDrillQuery(mdx,finalCallback,pendingCallback,listing,fieldList,filters)
以下はその説明です。
-
mdx は MDX SELECT クエリです。
-
finalCallback は、このページ上のコールバック関数の名前です。
-
pendingCallback (オプション) は、このページ上のもう 1 つのコールバック関数の名前です。
-
listing は詳細リストの名前です。
-
fieldList は、リスト・フィールドのリストを指定します。listing または fieldList を指定します。
-
filters は、クエリに適用する追加のフィルタを指定します。
このメソッドは、指定されたドリルスルー・クエリを実行します。クエリが保留中のときや完了したときは、DeepSee は指定されたコールバック関数を呼び出します。
このメソッドには戻り値はありません。
runPivot(pivot,finalCallback,pendingCallback,filters)
以下はその説明です。
-
pivot は、ピボット・テーブルの論理名です。
-
finalCallback は、このページ上のコールバック関数の名前です。
-
pendingCallback (オプション) は、このページ上のもう 1 つのコールバック関数の名前です。
-
filters は、クエリに適用する追加のフィルタを指定します。
このメソッドは、指定されたピボット・テーブルで定義されている MDX クエリを実行します。クエリが保留中のときや完了したときは、DeepSee は指定されたコールバック関数を呼び出します。
このメソッドには戻り値はありません。
