表7-3 JAVA APIリスト
API | 説明 |
---|---|
BigDecimal getPOVLocation(BigDecimal pLoadId) | LOADIDに基づいてパーティション・キーを返します。 |
BigDecimal getPOVCategory(BigDecimal pLoadId) | LOADIDに基づいてカテゴリ・キーを返します。 |
Date getPOVStartPeriod(BigDecimal pLoadId) | LOADIDに基づいて開始期間の期間キーを返します。 |
Date getPOVEndPeriod(BigDecimal pLoadId) | 1つの期間をロードするとき、LOADIDに基づいて終了期間の期間キーを返します(開始期間と終了期間は同じです)。 |
executePLSQL | Procedural Language/Structured Query Language (PL/SQL)コードのブロックを実行します。このAPIは次の3つのパラメータを取ります:
PL/SQLの実行例: fdmAPI.executePLSQL("BEGIN dbms_stats.gather_table_stats(user,?,estimate_percent=>dbms_stats.auto_sample_size,force=>TRUE); END;", ["tDataSeg_T"], True); |
getBatchJobDetails | getBatchJobDetailsは、バッチによって送信されたジョブごとに次の列を戻します。
|
int executeDML(String query,Object[] parameters) | 任意のDML文を実行します。問合せおよびパラメータを指定します。パラメータはリストとして指定します。 |
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage) | データベース表AIF_PROCESS_LOGSにメッセージを記録します。 |
logFatal(String pLogMessage) | 致命的なエラーが発生した場合にメッセージをログに記録します。このメッセージはすべてのログ・レベルで表示されます。 |
logError(String pLogMessage) | エラーが発生した場合にメッセージをログに記録します。このメッセージは2以上のログ・レベルで表示されます。 |
logWarn(String pLogMessage) | 警告条件エラーが発生した場合にメッセージをログに記録します。このメッセージは3以上のログ・レベルで表示されます。 |
logInfo(String pLogMessage) | 情報メッセージをログに記録します。このメッセージは4以上のログ・レベルで表示されます。 |
logDebug(String pLogMessage) | デバッグ・メッセージをログに記録します。このメッセージはログ・レベル5で表示されます。 |
Map getProcessStates(BigDecimal pLoadId) | ワークフロー・プロセスのステータスを返します。 使用可能なステータス:
|
Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //returns PERIODTARGET and YEARTARGET | 特定の期間キーに対するターゲット期間マッピングを返します。 |
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName) | 指定のカスタム・スクリプト・パラメータ名とloadIDに対する値を返します。 |
Object getCustomScriptParameterValue(String pParameterName) | 指定のカスタム・スクリプト・パラメータ名と初期化ロードされたコンテキストの値を返します。 |
ResultSet getBatchDetails() | AIF_BATCHES表からバッチ定義情報を返します。 getBatchDetails()から返されるフィールド:
|
ResultSet getBatchJobDetails(BigDecimal pLoadId) | 指定のloadidについてデータベース表AIF_PROCESS_LOGSに記録されたエラー・メッセージを取得します。 |
ResultSet getCategoryList() | 結果セット内のカテゴリのリストを返します。 getCategoryList()から返されるフィールド:
|
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId) | 結果セット内の確認グループのリストを返します。 |
ResultSet getCheckEntityForGroup(String pValGroupKey) | 結果セット内の確認グループのエンティティ・リストを返します。 |
ResultSe tgetCheckEntityGroupList(BigDecimal pApplicationId) | 結果セット内の確認ルール・グループのリストを返します。 |
ResultSet getCheckEntityForGroup | 結果セット内の確認ルール・グループのルールのリストを返します。 |
ResultSet getCustomDBLog() | 現在のプロセスについてデータベース表AIF_PROCESS_LOGSに記録されたエラー・メッセージを取得します。 getCustomDBLog()から返されるフィールド:
|
ResultSet getCustomDBLog(BigDecimal pLoadId) | 指定のloadIDについてDBからログ文を返します。 |
ResultSet getCustomScriptParameters() | コンテキストの初期化済loadIDに対する結果セットのカスタム・スクリプト・パラメータ・リストを返します。 |
ResultSet getCustomScriptParameters(BigDecimal pLoadId) | 指定のloadIDに対する結果セットのカスタム・スクリプト・パラメータ・リストを返します。 |
ResultSet getPeriodList() | 結果セット内の期間のリストを返します。 getPeriodList()から返されるフィールド:
|
ResultSet executeQuery(String query, Object[] parameters) | 任意のSQL問合せ文を実行します。問合せの結果が結果セットとして返されます。問合せおよびパラメータを指定します。パラメータはリストとして指定します。 |
ResultSet getImportFormatDetails(String pImpGroupKey) | インポート・フォーマット・キーに基づく結果セットとしてインポート・フォーマットの詳細を返します。 getImportFormatDetails(String pImpGroupKey)から返されるフィールド:
|
ResultSet getImportFormatMapDetails(String pImpGroupKey) | 指定のインポート・フォーマット・キーに対する結果セットとしてインポート・フォーマット・マッピングの詳細を返します。現在、ファイル・ベースのインポート・フォーマットしかサポートされません。 getImportFormatMapDetails(String pImpGroupKey)から返されるフィールド:
|
ResultSet getLocationDetails(BigDecimal pPartitionKey) | 指定のロケーション・キーに対するレコード・セットとしてロケーションの詳細を返します。 getLocationDetailsから返されるフィールド:
たとえば、getLocationDetails APIから返されるフィールドを確認する場合は、次のスクリプトを実行します: rs = fdmAPI.getLocationDetails(fdmContext["LOCKEY"]) i = 1 metaData = rs.getMetaData() while i <= metaData.getColumnCount(): fdmAPI.logDebug(metaData.getColumnLabel(i)) i +=1 |
ResultSet getRuleDetails(BigDecimal pRuleId) | 指定のデータ・ルールIDに対するレコード・セットとしてデータ・ルールの詳細を返します。 getRuleDetails(BigDecimal pRuleId)から返されるフィールド:
|
showCustomDBLog() | プロセス完了後にユーザー・インタフェースにカスタム・メッセージ・リストを示します。メッセージは、データ・ロード・ワークフロー・ステップ(インポート、検証、エクスポート、確認など)の終了時、またはカスタム・スクリプト実行の終了時に表示できます。プロセスがオンライン・モードで実行される場合のみメッセージが表示されることに注意してください。 |
showCustomFile(String filePath) | プロセス完了後にユーザー・インタフェースにカスタム・ファイル(ログ・ファイル、レポート・ファイル)を表示します。メッセージは、データ・ロード・ワークフロー・ステップ(インポート、検証、エクスポート、確認など)の終了時、またはカスタム・スクリプト実行の終了時に表示できます。プロセスがオンライン・モードで実行される場合のみメッセージが表示されることに注意してください。 |
showCustomMessage(String message) | プロセス完了後にユーザー・インタフェースにカスタム・メッセージを示します。メッセージは、データ・ロード・ワークフロー・ステップ(インポート、検証、エクスポート、確認など)の終了時、またはカスタム・スクリプト実行の終了時に表示できます。プロセスがオンライン・モードで実行される場合のみメッセージが表示されることに注意してください。 |
String getCategoryMap(BigDecimal pCatKey,String pApplicationName) | 指定のカテゴリおよびアプリケーション名のシナリオを返します。 |
String getCustomMessage() | 現在のプロセスについて発行された最後のカスタム・メッセージを取得します。 |
String getCustomMessage(BigDecimal pLoadId) | 指定のloadidについて発行された最後のカスタム・メッセージを取得します。 |
String getCustomFile() | 現在のプロセスについて作成されたカスタム・ファイルを取得します。 |
String getCustomFile(BigDecimal pLoadId) | 指定のloadidについて作成されたカスタム・ファイルを取得します。 |
String getPOVDataValue(BigDecimal pPartitionKey) | ロケーションのデータ値を返します。 |
String getDirTopLevel(BigDecimal pApplicationId) | アプリケーションに基づいて上位レベル・ディレクトリを返します。 |
String getDirInbox(BigDecimal pApplicationId) | アプリケーションに基づいてInbox ディレクトリを返します。 |
String getDirOutbox(BigDecimal pApplicationId) | アプリケーションに基づいてOutbox ディレクトリを返します。 |
String getDirScripts(BigDecimal pApplicationId) | アプリケーションに基づいてScripts ディレクトリを返します。 |
String getProcessLogFile(BigDecimal pLoadId) | 指定のloadIDのログ・ファイル名を返します。 |
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName) | オプションの値セットを返します。オプションは、「システム設定」、「アプリケーション設定」および「ユーザー設定」で設定できます。優先順位は、ユーザー、アプリケーション、システムです。APIによって、適切な適用可能値が判別され、値が返されます。 |
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage) | ログ情報をAIF_PROCESS_LOGS表に書き込みます。エンティティ・タイプとエンティティ名を使用して、記録されたメッセージをグループ分けします。データ・ロード・ワークフロー・プロセスからのみログを作成できます。 |
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage) | ログ情報をデータ・ロード・プロセスのログ・ファイルに書き込みます。ログはプロセス・ログ・レベルに基づいて書き込まれます。データ・ロード・ワークフロー・プロセスからのみログを作成できます。 注意: writeToProcessLogsFile APIではなくロギングAPI (たとえば、logDebugまたはlogInfo API)を使用することをお薦めします。 |
void closeConnection() | データベース接続を閉じるために使用します。 |
void closeResultSet(ResultSet resultSet) | 結果オブジェクトを閉じるために使用します。 |
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId) | 現在の実行のインポート・フォーマットを更新します。これはファイルベースのインポート・フォーマットのみに適用できます。 |