XMLViewServiceサービス

XMLViewServiceサービスを使用して、Oracle Analyticsプレゼンテーション・サービスから結果をXML形式で取得します。

列挙およびメソッドの名前	説明
XMLQueryOutputFormat列挙	有効な値のリストを指定します。
cancelQuery()メソッド	現在の問合せを取り消します。
executeSQLQuery()メソッド	SQL問合せを実行します。
executeXMLQuery()メソッド	XML問合せを実行します。
fetchNext()メソッド	データ行の次のページを戻します。
getPromptedFilters()メソッド	プロンプト・フィルタのある分析の列のみを含むフィルタXML構造体を戻します。

XMLQueryOutputFormat列挙

XMLQueryOutputFormat列挙では、executeSQLQuery()メソッドおよびexecuteXMLQuery()メソッドの値のリストを指定します。

この列挙では、executeSQLQuery()メソッドおよびexecuteXMLQuery()メソッドの有効な値のリストを指定します。たとえば、データ行とメタデータ、あるいはデータ行のみを戻すことができます。

ノート:

XMLQueryOutputFormatの1つの値のみを選択できます。

値	説明
String SAWRowsetData	問合せでデータ行のみを戻すことを指定します。
String SAWRowsetSchema	問合せでメタデータのみを戻すことを指定します。
String SAWRowsetSchemaAndData	問合せでメタデータとデータ行の両方を戻すことを指定します。

cancelQuery()メソッド

cancelQuery()メソッドを使用して、問合せを取り消し、その問合せに関連付けられたリソースをクリーン・アップします。

このメソッドは、問合せの行セットが、戻されたデータセットの最後の行までスクロールされない場合にのみ使用されます。

ノート:

戻されたデータセットで、問合せ行セットが最後の行までスクロールされるときに、このメソッドを使用すると、問合せデータは、最後のfetchNextメソッドが起動される際にクリーンアップされます。

シグネチャ

void cancelQuery(String queryID, String sessionID);

引数	説明
String queryID	問合せの一意のIDを指定します。
String sessionID	セッションの一意のIDを指定します。

executeSQLQuery()メソッド

executeSQLQuery()メソッドを使用して、SQL問合せを実行し、その問合せの結果を戻します。

戻される結果が1ページを超える場合、fetchNext()メソッドを使用して、行の次のページを戻す必要があります。

シグネチャ

QueryResults executeSQLQuery(String sql, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, String sessionID);

引数	説明
String sql	実行するSQLコードの文字列を指定します。
XMLQueryOutputFormat outputFormat	出力形式を指定します(詳細は、「XMLQueryExecutionOptions構造体」を参照してください)。
XMLQueryExecutionOptions executionOptions	問合せ実行オプションを指定します(詳細は、「XMLQueryExecutionOptions構造体」を参照してください)。
String sessionID	セッションの一意のIDを指定します。

戻り値

QueryResults構造体の1行以上のデータとして、問合せの結果を戻します。

「QueryResults構造体」を参照してください。

executeXMLQuery()メソッド

executeXMLQuery()メソッドを使用して、XML問合せを実行し、その問合せの結果を戻します。

戻される結果が1ページを超える場合、fetchNext()メソッドを使用して、行の次のページを戻す必要があります。

シグネチャ

QueryResults executeXMLQuery(ReportRef report, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, ReportParams reportParams, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される分析定義を指定します。
XMLQueryOutputFormat outputFormat	出力形式を指定します(詳細は、「XMLQueryExecutionOptions構造体」を参照してください)。
XMLQueryExecutionOptions executionOptions	問合せ実行オプションを指定します(詳細は、「XMLQueryExecutionOptions構造体」を参照してください)。
ReportParams reportParams	オプション。実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。ReportParams構造体の詳細は、「ReportParams構造体」を参照してください。
String sessionID	セッションの一意のIDを指定します。

戻り値

QueryResults構造体の1行以上のデータとして、問合せの結果を戻します。

「QueryResults構造体」を参照してください。

fetchNext()メソッド

fetchNext()メソッドを使用して、問合せで取得した行の次のページを戻します。

戻されたページには、行が含まれていない場合があります。完了フラグが設定されていない場合、残りの行は即座に使用できない場合があります。

シグネチャ

QueryResults fetchNext(String queryID, String sessionID);

引数	説明
String queryID	一意の問合せIDを指定します。これはQueryResultsオブジェクトで戻されます。
String sessionID	セッションの一意のIDを指定します。

戻り値

QueryResults構造体の1行以上のデータとして、問合せの結果の次のページを戻します。

「QueryResults構造体」を参照してください。

getPromptedFilters()メソッド

getPromptedFilters()メソッドを使用して、保存された分析のプロンプト列または、分析のXML定義からのプロンプト列を取得します。

プロンプト列を含む分析を作成するには、これにisPrompted演算子を割り当てる必要があります。

シグネチャ

List[] getPromptedFilters(ReportRef report, String sessionID);

引数	説明
ReportRef report	分析のreportPathまたはreportXml (レポート定義)を指定します。
String sessionID	セッションの一意のIDを指定します。