MetadataServiceサービス
MetadataService()サービスを使用して、Oracle Analyticsプレゼンテーション・サービスのスキーマ・オブジェクト(列、表、サブジェクト領域など)の説明を取得します。
| メソッド名 | 説明 |
|---|---|
|
問合せキャッシュをクリアします。 |
|
|
指定したサブジェクト・エリアおよび表内の指定した列の列情報を取得します。 |
|
|
指定したサブジェクト・エリアのサブジェクト・エリア情報を取得します。 |
|
|
指定したサブジェクト・エリアのサブジェクト・エリア情報を指定のソート順で取得します。 |
|
|
指定したサブジェクト・エリア内の指定した表の表情報を取得します。 |
|
|
指定したサブジェクト・エリア内の指定した表の表情報を指定の(名前の)ソート順で取得します。 |
|
|
使用可能なサブジェクト・エリアのリストを取得します。 |
|
|
使用可能なサブジェクト・エリアのリストを指定のソート順で取得します。 |
|
|
Oracle Analyticsプレゼンテーション・サービスを手動で再起動せずに、ロギング構成に対する変更を強制的に有効にします。 |
|
|
XMLメッセージ・ファイルを再ロードし、サーバー・メタデータをリフレッシュし、キャッシュをクリアします。 |
describeColumn()メソッド
describeColumn()メソッドを使用して、指定したサブジェクト領域および表内の指定した列の列情報を取得します。
シグネチャ
SAColumn describeColumn(String subjectAreaName, String tableName, String columnName, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
String tableName |
問い合せる表を指定します。 |
|
String columnName |
問い合せる列の名前を指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
describeSubjectArea()メソッド
describeSubjectArea()メソッドを使用して、指定したサブジェクト領域のサブジェクト領域情報を取得します。
シグネチャ
SASubjectArea describeSubjectArea(String subjectAreaName, SASubjectAreaDetails detailsLevel, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
SASubjectAreaDetails detailsLevel |
取得するサブジェクト・エリアについての情報を指定します。SASubjectAreaDetails構造体の詳細は、「SASubjectAreaDetailsの値」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
SASubjectAreaDetailsの値
SASubjectAreaDetailsの値を使用して、サブジェクト領域についてどのような情報を取得するのかを指定します。
| 値 | 説明 |
|---|---|
|
IncludeTables |
各表についての最小限の情報を記載した表リストを含めます。 |
|
IncludeTablesAndColumns |
表および列の全情報を含めます。 |
|
Minimum |
表および列の情報を含めません。 |
使用方法
describeSubjectArea()メソッドのdetailsLevelパラメータ値。
detailsLevelパラメータの値に応じて、戻されるオブジェクトには、この表に示される情報が含まれます。
| detailsLevelの値 | 説明 |
|---|---|
|
IncludeTables |
表フィールドがnullではなく、このサブジェクト・エリアの表のコレクションを含むことを指定します。各表オブジェクトはnullに設定された列フィールドを含みます。 |
|
InludeTablesAndColumns |
表フィールドがnullではなく、このサブジェクト・エリアの表のコレクションを含むことを指定します。各表オブジェクトに対し、列フィールドには対応する列のコレクションが含まれます。 |
|
Minimum |
表リストが使用できないことを指定します。結果のサブジェクト・エリア・オブジェクトの表フィールドはnullです。 |
describeSubjectAreaWithSort()メソッド
describeSubjectAreaWithSort()メソッドを使用して、指定したサブジェクト領域のサブジェクト領域情報を指定のソート順で取得します。
シグネチャ
SASubjectArea describeSubjectAreaWithSort(String subjectAreaName, SASubjectAreaDetails detailsLevel, String sortOrder, String sortOrderCaseSensitive, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
SASubjectAreaDetails detailsLevel |
取得するサブジェクト・エリアについての情報を指定します。SASubjectAreaDetails構造体の詳細は、「SASubjectAreaDetailsの値」を参照してください。 |
|
String sortOrder |
どのソート順で結果を戻すかを指定します。指定可能な値は'asc'または'desc'です。'asc'はユーザーの現在の言語の昇順(たとえば、英語の場合はAからZ)で値を戻し、反対に'desc'は逆の順序(たとえば、英語の場合はZからA)で戻します。 |
|
String sortOrderCaseSensitive |
値の大/小文字をソート時に考慮に入れる必要があるかどうかを指定します。指定可能な値は'caseSensitive'または'caseInsensitive'です。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
describeTable()メソッド
describeTable()メソッドを使用して、指定したサブジェクト領域の指定した表の表情報を取得します。
シグネチャ
SATable describeTable(String subjectAreaName, String tableName, SATableDetails detailsLevel, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
String tableName |
問い合せる表を指定します。 |
|
SATableDetails detailsLevel |
取得する表の情報を指定します。SATableDetails構造体の詳細は、「SATablesDetailsの値」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
SATablesDetailsの値
SATablesDetailsの値は、取得するサブジェクト領域表に関する情報を指定します。
| 値 | 説明 |
|---|---|
|
IncludeColumns |
SATableオブジェクトの列フィールドにデータを移入します。 |
|
Minimum |
列情報は含まれません。SATableオブジェクトの列フィールドはnullに設定されます。 |
describeTableWithSort()メソッド
describeTableWithSort()メソッドを使用して、指定した表の表情報を指定の(名前の)ソート順で取得します。
シグネチャ
SATable describeTable(String subjectAreaName, String tableName, SATableDetails detailsLevel, String sortOrder, String sortOrderCaseSensitive, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
String tableName |
問い合せる表を指定します。 |
|
SATableDetails detailsLevel |
取得する表の情報を指定します。SATableDetails構造体の詳細は、「SATablesDetailsの値」を参照してください。 |
|
String sortOrder |
どのソート順で結果を戻すかを指定します。指定可能な値は'asc'または'desc'です。'asc'はユーザーの現在の言語の昇順(たとえば、英語の場合はAからZ)で値を戻し、反対に'desc'は逆の順序(たとえば、英語の場合はZからA)で戻します。 |
|
String sortOrderCaseSensitive |
値の大/小文字をソート時に考慮に入れる必要があるかどうかを指定します。指定可能な値は'caseSensitive'または'caseInsensitive'です。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
戻り値
列が指定のソート順のSATableオブジェクトを戻します。SATable構造体の詳細は、
「SATable構造体」を参照してください。
列タイプに対して固定の順序があります。この固定ソート順は次のとおりです。
-
ネストされたフォルダ
-
メジャー
-
属性
-
階層
getSubjectAreas()メソッド
getSubjectAreas()メソッドを使用して、使用可能なサブジェクト領域のリストを取得します。
シグネチャ
List[] getSubjectAreas(String sessionID);
| 引数 | 説明 |
|---|---|
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
getSubjectAreasWithSort()メソッド
getSubjectAreasWithSort()メソッドを使用して、使用可能なサブジェクト領域のリストを指定のソート順で取得します。
シグネチャ
List[] getSubjectAreasWithSort(String sortOrder, String sortOrderCaseSensitive, String sessionID);
| 引数 | 説明 |
|---|---|
|
String sortOrder |
どのソート順で結果を戻すかを指定します。指定可能な値は'asc'または'desc'です。'asc'はユーザーの現在の言語の昇順(たとえば、英語の場合はAからZ)で値を戻し、反対に'desc'は逆の順序(たとえば、英語の場合はZからA)で戻します。 |
|
String sortOrderCaseSensitive |
値の大/小文字をソート時に考慮に入れる必要があるかどうかを指定します。指定可能な値は'caseSensitive'または'caseInsensitive'です。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
reloadLogConfiguration()メソッド
reloadLogConfiguration()メソッドを使用して、Oracle Analyticsプレゼンテーション・サービスを手動で再起動せずに、ロギング構成に対する変更を強制的に有効にします。