Module.formatfileオブジェクト非推奨

代替えオブジェクトはありません。

コンポーネント情報

コンポーネント概要

データをフォーマットされた形式のファイルとして出力するオブジェクト。

詳細

フォーマットされたデータファイルの出力先は PublicStorage になります。このため、分散システムを構築している場合においても、データファイルの共有が可能であり、また環境に依存する事なくデータファイルを操作する事が可能となります。
このＡＰＩでは、テキスト形式を前提としているため、バイナリやサポート対象外の文字コード体系データを出力した場合、データが破壊される可能性があります。
また、分散システムを構築している場合、PublicStorage へデータを転送するため、処理に時間がかかる場合があります。

メソッドの概要

返却値の型	メソッド名
Boolean	append (String `style`, String `file`, Object `data`) static非推奨フォーマットされたデータをファイルに追記します。代替えメソッドはありません。
Boolean	write (String `style`, String `file`, Object `data`) static非推奨フォーマットされたデータをファイルに出力します。代替えメソッドはありません。

メソッドの詳細

Boolean append (String style, String file, Object data) static 非推奨

代替えメソッドはありません。

フォーマットされたデータをファイルに追記します。

指定フォーマットで指定ファイルへデータを書き出します。ファイルは、PublicStorage に出力されます。
指定されたファイルが存在しない場合はファイルが新規作成され、存在する場合は既存ファイルに追記されます。
(指定されたファイルを格納するディレクトリはあらかじめ作成しておく必要があります)
出力ファイルパスは、PublicStorage のインストールディレクトリ直下 storage/ ディレクトリからの相対になります。

このAPIは、引数 data に指定された値を「"WEB-INF/jssp/compatible/src/template/" ＋引数 style」に該当するプログラムに渡し、
その実行結果を PublicStorage に出力しています。

フォーマットを表すキーワードは、標準で「style/csv」に対応しています。
この場合、引数 data は二次元配列で指定してください。

Module.formatfile.write() に本関数を利用した場合とほぼ同様のサンプルプログラムが記載されています。(違いは追記するか、上書きするかです。)
あわせてご参照ください。

パラメータ

style : String: フォーマットを表すキーワード

file : String: 出力ファイルパス

data : Object: 出力データ

返却値

Boolean: Boolean 真値：ファイルの追記に成功 / 偽値：ファイルの追記に失敗

Boolean write (String style, String file, Object data) static 非推奨

代替えメソッドはありません。

フォーマットされたデータをファイルに出力します。

指定フォーマットで指定ファイルへデータを書き出します。ファイルは、PublicStorage に出力されます。
指定されたファイルが存在しない場合はファイルが新規作成され、存在する場合は既存ファイルに上書きされます。
(指定されたファイルを格納するディレクトリはあらかじめ作成しておく必要があります)
出力ファイルパスは、PublicStorage のインストールディレクトリ直下 storage/ ディレクトリからの相対になります。

このAPIは、引数 data に指定された値を「"WEB-INF/jssp/compatible/src/template/" ＋引数 style」に該当するプログラムに渡し、
その実行結果を PublicStorage に出力しています。

フォーマットを表すキーワードは、標準で「style/csv」に対応しています。
この場合、引数 data は二次元配列で指定してください。以下に、サンプルプログラムを示します。

サンプルプログラム

 var style = "style/csv";
 var file = "temp/out.csv";
 var data = new Array();

 data[0] = new Array();
 data[0][0] = "0-0";
 data[0][1] = "0-1";
 data[0][2] = "0-2";

 data[1] = new Array();
 data[1][0] = "1-0";
 data[1][1] = "1-1";
 data[1][2] = "1-2";

 data[2] = new Array();
 data[2][0] = "2-0";
 data[2][1] = "2-1";
 data[2][2] = "2-2";

 var result = Module.formatfile.write(style, file, data);

出力結果

 0-0,0-1,0-2
 1-0,1-1,1-2
 2-0,2-1,2-2

パラメータ

style : String: フォーマットを表すキーワード

file : String: 出力ファイルパス

data : Object: 出力データ

返却値

Boolean: Boolean 真値：ファイルの出力に成功 / 偽値：ファイルの出力に失敗