DatabaseImportオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.19 |
since | 7.1 |
エクスポートで出力したファイルをデータベースにインポートします。
各メソッドから返却される処理結果には、「処理結果オブジェクト」と「インポート処理結果オブジェクト」の2つがあります。
[インポート処理結果オブジェクト]
基本的な使い方は以下の通りです。
1. DatabaseImportインスタンスを生成 ... new DatabaseImport();
2. インポート対象ファイルを追加 ... add();
3. インポートの実行 ... execute();
以上の順で実行することでファイルをデータベースにインポートできます。
またインポート時の設定は、XMLファイルで一括管理できます。
実装サンプル jssp/platform/src/tablemaintenance/ajax/import_run.js
各メソッドから返却される処理結果には、「処理結果オブジェクト」と「インポート処理結果オブジェクト」の2つがあります。
[インポート処理結果オブジェクト]
インポート処理結果 オブジェクト (Object) |
||||||||||||||||||||||||||
error 処理全体のエラーの有無(Boolean) | ||||||||||||||||||||||||||
errorMessage エラーメッセージ(String)※処理全体にエラーがある場合のみ | ||||||||||||||||||||||||||
stackTrace スタックトレース(String)※処理全体にエラーがある場合のみ | ||||||||||||||||||||||||||
tables[テーブル名] インポートを行った テーブルの配列 (Object) |
|
基本的な使い方は以下の通りです。
1. DatabaseImportインスタンスを生成 ... new DatabaseImport();
2. インポート対象ファイルを追加 ... add();
3. インポートの実行 ... execute();
以上の順で実行することでファイルをデータベースにインポートできます。
またインポート時の設定は、XMLファイルで一括管理できます。
実装サンプル jssp/platform/src/tablemaintenance/ajax/import_run.js
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | addString (String src , String jsfileName ) 非推奨文字列のインポートデータを追加します。 |
ResultObject | add (File file ) インポートデータを追加します。 |
ResultObject | add (String src , String jsfileName ) インポートデータを追加します。 |
ResultObject | add (String storagePath ) 非推奨インポートデータを追加します。 |
Object | execute (String jsconnectId , Boolean arrayFlg ) インポートを実行します。 |
String | getImportOptionsXmlString () インポートオプションをXML形式の文字列で取得します。 |
Array | getListenerNames () 非推奨 登録済みリスナの名称一覧を取得します。 |
Object | getMonitor (String jsuniqueKey ) static非推奨インポートの実行状況を取得します。 |
Array | listenerDelete () static非推奨 リスナで該当行の削除を通知するオブジェクトを生成します。 |
Array | listenerError (String msg ) static非推奨リスナで該当行の処理エラーを通知するオブジェクトを生成します。 |
Array | listenerSkip () static非推奨 リスナで該当行の処理をスキップするための通知オブジェクトを生成します。 |
Array | listenerTerminate (String msg ) static非推奨リスナで現在のテーブルへのインポート中止を通知するオブジェクトを生成します。 |
void | setExplicitFile (Boolean jsexplicitFile ) インポートオプションで明示的に指定されたファイル以外のインポートを行うかどうかを設定します。 |
void | setImportConfig (String jsconfig ) インポート設定をセットします。 |
ResultObject | setImportOptionsXmlString (String jsxml ) インポートオプションをXML 形式の文字列で設定します。 |
void | setListener (String jspagePath , String jslistenerName ) 非推奨インポートリスナのページパスを設定します。 |
void | setListener (String pagePath ) 非推奨インポートリスナのページパスを設定します。 |
void | setMonitor (String jsuniqueKey ) 非推奨実行状況をモニタリングするためのキーをセットします。 |
メソッドの詳細
ResultObject addString (String src , String jsfileName )
非推奨
文字列のインポートデータを追加します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject add (File file )
インポートデータを追加します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject add (String src , String jsfileName )
インポートデータを追加します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject add (String storagePath )
非推奨
インポートデータを追加します。
パラメータ
返却値
|
|||||||||||||||||||
Object execute (String jsconnectId , Boolean arrayFlg )
インポートを実行します。
パラメータ
返却値
|
|||||||||||||||||||
String getImportOptionsXmlString ()
インポートオプションをXML形式の文字列で取得します。
取得に失敗した場合は、 null を返却します。
返却値
|
|||||||||||||||||||
Array getListenerNames ()
非推奨
登録済みリスナの名称一覧を取得します。
返却値
|
|||||||||||||||||||
Object getMonitor (String jsuniqueKey )
static
非推奨
インポートの実行状況を取得します。
インポートの実行とは別のスレッドからこのメソッドを使用することで 進捗状況を取得できます。
パラメータ
返却値
|
|||||||||||||||||||
Array listenerDelete ()
static
非推奨
リスナで該当行の削除を通知するオブジェクトを生成します。
リスナ内のbeforeRegistファンクションで、return値として このファンクションが生成したオブジェクトを返すと該当行の削除要求が通知されます。
返却値
|
|||||||||||||||||||
Array listenerError (String msg )
static
非推奨
リスナで該当行の処理エラーを通知するオブジェクトを生成します。
リスナ内のbeforeRegistファンクションで、return値として このファンクションが生成したオブジェクトを返すとデータの処理がエラーとして通知されます。
パラメータ
返却値
|
|||||||||||||||||||
Array listenerSkip ()
static
非推奨
リスナで該当行の処理をスキップするための通知オブジェクトを生成します。
リスナ内のbeforeRegistファンクションで、return値として このファンクションが生成したオブジェクトを返すとデータの処理がスキップされます。
返却値
|
|||||||||||||||||||
Array listenerTerminate (String msg )
static
非推奨
リスナで現在のテーブルへのインポート中止を通知するオブジェクトを生成します。
リスナ内のbeforeRegistファンクションで、return値として このファンクションが生成したオブジェクトを返すと、同テーブルに対して以降の処理が行われません。 複数テーブルへのインポートが行われている場合は、次のテーブルへ処理が移行します。
パラメータ
返却値
|
|||||||||||||||||||
void setExplicitFile (Boolean jsexplicitFile )
インポートオプションで明示的に指定されたファイル以外のインポートを行うかどうかを設定します。
true が設定されている場合は、インポートオプションのfileタグで指定されたファイル以外のインポートは行いませんfalse の場合は、ファイル名(拡張子抜きの名前)とテーブル名がマッピングされます。
パラメータ
返却値
|
|||||||||||||||||||
void setImportConfig (String jsconfig )
インポート設定をセットします。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject setImportOptionsXmlString (String jsxml )
インポートオプションをXML 形式の文字列で設定します。
XMLの構成については 「テーブルメンテナンス管理者ガイド」 - 「エクスポート・インポートの設定をファイルで管理する」を参照してください。
パラメータ
返却値
|
|||||||||||||||||||
void setListener (String jspagePath , String jslistenerName )
非推奨
インポートリスナのページパスを設定します。
パラメータ
返却値
|
|||||||||||||||||||
void setListener (String pagePath )
非推奨
インポートリスナのページパスを設定します。
リスナ名は、 "scriptlistener" となります。
パラメータ
返却値
|
|||||||||||||||||||
void setMonitor (String jsuniqueKey )
非推奨
実行状況をモニタリングするためのキーをセットします。
パラメータ
返却値
|