帳票の出力時に使用する帳票と入力データを保持します。
java.lang.Object
∟ com.fujitsu.systemwalker.outputassist.connector.Forms
public class Forms
extends java.lang.Object
implements FormBaseインタフェース com.fujitsu.systemwalker.outputassist.connector.FormBase から継承した文字コードを意味するフィールドについては、以下を参照してください。
Formsクラスのコンストラクタを以下に示します。
コンストラクタの概要 |
|---|
Forms(java.lang.String formname, java.lang.String assets)(*1) 帳票名と帳票格納ディレクトリを指定して、帳票と帳票データのセットを保持するFormsオブジェクトを生成します。 |
Forms(java.lang.String formname, java.lang.String assets, java.lang.String cbformname)(*1) 帳票名、帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と帳票データのセットを保持するFormsオブジェクトを生成します。 |
*1：
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。
Formsクラスのメソッドを以下に示します。
メソッドの分類 | メソッドの概要 | ||
|---|---|---|---|
共 | void | pushRecord(java.lang.String record) 帳票を出力するための入力データとなるレコード（行）文字列を追加します。 | |
共 | void | ChangeForm(java.lang.String formname) マルチフォーム出力、または組合せフォーム出力をする場合に、使用する帳票を切り替えます。 | |
共 | void | ChangeCbForm(String cbformname) 複数の組合せフォームを出力する場合に使用する組合せフォーム名を切り替えます。 | |
共 | void | 組合せフォーム定義ファイル名を指定します。 | |
W/S | void | setDataSource(java.lang.String dsinfo) XBRLデータ対応機能/Navigator連携機能を利用する場合に、帳票に配置する入力データの抽出条件となる固有情報を指定します。 | |
W/S | void | execDataSource(java.lang.String csv) 帳票定義情報およびsetDataSourceメソッドの定義にしたがって入力データを抽出します。 | |
W/S | void | execNavi (java.lang.String rne, java.lang.String dbtype, java.lang.String cuser, java.lang.String cupass, java.lang.String cserver, java.lang.String suser, java.lang.String supass, java.lang.String sserver) execNavi (java.lang.String rne, java.lang.String dbtype, java.lang.String cuser, java.lang.String cupass, java.lang.String cserver, java.lang.String suser, java.lang.String supass, java.lang.String sserver, java.lang.String condition) Navigatorクライアントで生成した問い合わせファイルを使用して、List Creatorの入力データをデータベースから抽出します。 | |
W | void | execQuery(java.lang.String query, java.lang.String user, java.lang.String password) execQuery(java.lang.String query, java.lang.String user, java.lang.String password, java.lang.String database) execQuery(java.lang.String query, java.lang.String user, java.lang.String password, java.lang.String database, java.lang.String repstring) クエリ定義よりデータベースに問い合わせ、帳票を出力するための入力データとなるデータを抽出します。 | |
共 | void | 実行環境の文字コード系を指定します。 | |
共 | void | 帳票を出力する際の文字コード系を指定します。 | |
共 | void | Javaインタフェースが使用している資源を解放します。 | |
|
帳票名と帳票格納ディレクトリを指定して、帳票と帳票データのセットを保持するFormsオブジェクトを生成します。
帳票名を指定します。
マルチフォーム出力する場合は、一番目に出力する帳票名を指定します。
帳票格納ディレクトリをフルパスで指定します。
ConnectorException
帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。リモート帳票出力時またはコネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintPropertiesクラスのsetPropertyメソッドのID_REMOTEDIRECTORYキーで指定してください。
組合せフォーム出力する場合は、Forms(String formname, String assets, String cbformname) コンストラクタを使用してください。
帳票格納ディレクトリ名を指定する場合、以下の注意事項があります。
マルチフォーム出力する場合、使用する帳票をChangeFormメソッドで切り替えてください。
|
組合せフォーム出力する場合に使用するコンストラクタです。
帳票名、帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と帳票データのセットを保持するFormsオブジェクトを生成します。
帳票名を指定します。
一番目に出力する帳票名を指定します。
帳票格納ディレクトリをフルパスで指定します。
組合せフォーム名を指定します。
ConnectorException
帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。リモート帳票出力時またはコネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintProperties クラスのsetProperty メソッドのID_REMOTEDIRECTORY キーで指定してください。
組合せフォーム出力しない場合は、Forms(String formname, String assets) コンストラクタを使用してください。
帳票格納ディレクトリ名を指定する場合、以下の注意事項があります。
組合せフォーム出力する場合、使用する帳票をChangeForm メソッドで切り替えてください。また、使用する組合せフォームを ChangeCbForm メソッドで切り替えてください。
マルチフォーム出力する場合、使用する帳票をChangeForm メソッドで切り替えてください。
|
帳票を出力するための入力データとなるレコード（行）文字列を追加します。
レコード（行）文字列を指定します。
ConnectorException
1レコード（行）ずつレコード（行）文字列をセットしてください。
レコード（行）文字列には改行コードを含めないでください。
マルチフォーム出力/組合せフォーム出力する場合は、使用する帳票をChangeFormメソッドで切り替えてから、このメソッドで帳票名を含めずにレコード（行）文字列を指定してください。
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をChangeCbFormメソッドで切り替えてから、このメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。
このメソッドを繰り返し呼び出した場合、データは追加されていきます。追加されたデータは、作業用ディレクトリ配下の一時作業用ファイルに保存されます。cleanupメソッド呼び出し時に削除されます。
帳票出力時の文字コードを指定する場合、このメソッド指定前にsetDataCodeメソッドおよびsetFileTypeで文字コードを指定してください。
このメソッド指定後に文字コード変換指定をすることはできません。
リモート帳票出力型でOWFファイルを生成する場合、PrintPropertiesクラスのsetPropertyメソッドに指定するID_EXECBUFFERキーに、prprintコマンドの-gcmformオプション（マルチフォーム/組合せフォーム用帳票名）を必ず指定してください。
|
マルチフォーム出力、または組合せフォーム出力をする場合に、使用する帳票を切り替えます。このメソッド呼び出し以降に指定した入力データは、この帳票の入力データとなります。
切り替える帳票名を指定します。
ConnectorException
マルチフォーム出力、または組合せフォーム出力をする場合、使用する帳票をこのメソッドで切り替えてから、pushRecordメソッドで帳票名を含めずにレコード（行）文字列を指定してください。
|
複数の組合せフォーム出力する場合に使用する組合せフォーム名を切り替えます。このメソッド呼び出し以降に指定した入力データは、この組合せフォームの入力データとなります。
切り替える組合せフォーム名を指定します。
ConnectorException
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をこのメソッドで切り替えてください。
また、ChangeFormメソッドで使用する帳票を切り替えてから、pushRecordメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。
|
組合せフォーム定義ファイル名を指定します。
組合せフォーム定義ファイルとは、組み合わせて出力する帳票定義情報と、帳票定義情報の重なり順などが定義されたファイルです。
このメソッドの呼び出しを省略すると、帳票格納ディレクトリ配下の組合せフォーム定義ファイル(Lccbform.ini）が有効になります。
組合せフォーム定義ファイル名をフルパスで指定します。
ConnectorException
組合せフォーム定義ファイルの文字コード系については、オンラインマニュアル“帳票設計編”を参照してください。
以下の場合、このメソッドにファイル名のみ指定してください。
リモート帳票出力時に組合せフォーム定義ファイルを転送した場合
コネクタ連携時に組合せフォーム定義ファイルを転送した場合
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。
|
XBRLデータ対応機能/Navigator連携機能を利用する場合に、帳票に配置する入力データの抽出条件となる固有情報を指定します。
XBRLデータ対応機能/Navigator連携機能を利用する場合に、帳票に配置する入力データの抽出条件となる固有情報を指定します。
固有情報は、「キー名=値」の形式を「\"」で囲んで指定します。複数指定する場合は、各固有情報を「セミコロン（;）」で区切って指定します。
このパラメータを指定する場合は、必ずパラメータ全体を「ダブルクォーテーション（"）」で囲んでください。
例）以下に、指定例を示します。
固有情報を1つ指定する場合
"\"キー名=値\""
固有情報を複数指定する場合
"\"キー名=値\";\"キー名=値\";\"キー名=値\""
キーとその指定値の詳細については、以下のマニュアルを参照してください。
オンラインマニュアル“XBRLデータ対応機能編”
オンラインマニュアル“Navigator連携機能編”
ConnectorException
マルチフォーム出力する場合、使用する帳票をChangeFormメソッドで切り替え、使用する帳票ごとに、このメソッドで固有情報を指定します。
|
|
帳票定義情報およびsetDataSourceメソッドの定義にしたがって入力データを抽出します。
帳票定義情報およびsetDataSourceメソッドの定義にしたがって入力データを抽出し、CSV形式のテキストファイルとして出力する場合に、出力するファイルのファイル名をフルパスで指定してください。
なお、出力されるテキストファイルは、項目名ラベル付きデータとなります。
ConnectorException
このメソッドでは、CSV形式のマルチフォーム出力用の入力データファイル（項目名ラベル付きデータ）が出力されます。
FormsFileクラスでこのメソッドで出力したファイルを入力データファイルとして利用できます。その場合は、以下のようにマルチフォーム出力で項目名ラベル付きデータとして扱うように指定してください。
PrintPropertiesクラスのsetPropertyメソッドで、ID_LABELDATAキーに「true」を指定してください。
FormsFileクラスのsetGrpOutメソッドで、「GRPOUT_GRP」を指定してください。
FormsFileクラスのsetGrpDelimitModeメソッドで、「DELIMIT_ANY」を指定してください。
FormsFileクラスのsetGrpDelimitメソッドで、「カンマ（,）」を指定してください。
FormsFileクラスのsetDataFileメソッドで、データファイル名と入力データの文字コード系を指定してください。
FormsFileクラスのsetFileTypeメソッドで、本クラスのsetFileTypeメソッドで指定したコード系と同じコード系を指定してください。
Navigator連携機能を利用する場合、setDataCodeメソッドでデータファイルの文字コード系にShift-JISを指定してください。
帳票名および帳票格納ディレクトリについては、Formsクラスのコンストラクタ、およびChangeFormメソッドで指定してください。
アプリケーションサーバがWindowsの場合、出力されるCSV形式のテキストファイルの文字コード系については、FormsクラスのsetDataCodeメソッドで指定してください。指定しなかった場合は、UNICODE（UTF8）になります。
アプリケーションサーバがUNIX系OSの場合、出力されるCSV形式のテキストファイルの文字コード系の指定については、未サポートです。
出力されるCSV形式のテキストファイルの文字コード系には、以下の文字コード系が使用されます。
本クラスのsetFileTypeメソッドで指定した文字コード系
環境変数（LANG）および環境変数（OA_EUCTYPE）で指定した文字コード系（setFileTypeメソッドで指定しなかった場合）
Database Direct連携に関するメソッドの詳細については、オンラインマニュアル“旧機能編”を参照してください。
クエリに関するメソッドの詳細については、オンラインマニュアル“旧機能編”を参照してください。
|
実行環境の文字コード系を指定します。
詳細については、以下を参照してください。
ConnectorException
このメソッドは、pushRecord を指定する前に指定してください。pushRecord 指定後、このメソッドを指定することはできません。
|
帳票を出力する際の文字コード系を指定します。
データファイルの文字コード系を指定します。
Shift-JIS
UNICODE（UTF8）
EUC
U90/S90の指定はsetFileTypeメソッドにしたがいます。
ConnectorException
このメソッドは、pushRecordメソッド を指定する前に指定してください。pushRecordメソッド 指定後、このメソッドを指定することはできません。
このメソッドの呼び出しを省略すると、以下の文字コード系が使用されます。
アプリケーションサーバがWindowsの場合
‐UNICODE（UTF8）
アプリケーションサーバがUNIX系OSの場合
‐setFileTypeメソッドで指定した文字コード系
‐環境変数（LANG）および環境変数（OA_EUCTYPE）で指定した文字コード系（setFileTypeメソッドで指定しなかった場合）
Unicodeの文字が定義されている帳票定義情報を使用する場合は、「CODE_UTF8」を指定してください。
英語環境（英語ロケール）で帳票出力する場合は、「CODE_UTF8」を指定してください。
|
Javaインタフェースが使用している資源を解放します。
ConnectorException
オブジェクトが不要になったら、このメソッドを必ず呼び出してください。
帳票の入力データ形式が「XML形式」の場合は、このクラスを使用して帳票出力できません。FormsFileクラスまたはFormsStreamクラスを使用してください。
サポートしている文字コード系に関しては、以下を参照してください。
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。