4.7.2 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) 帳票名、帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と帳票データセットを保持するFormオブジェクトを生成します。

Formsクラスのメソッドを以下に示します。

Formsクラスのメソッド

分類	メソッドの一覧
レコード（行）出力に関するメソッド	○	void	pushRecord(java.lang.String record) 帳票を出力するための入力データとなるレコード（行）文字列を追加します。
帳票切り替えに関するメソッド	○	void	ChangeForm(java.lang.String formname) マルチフォーム出力、または組合せフォーム出力する場合に、使用する帳票を切り替えます。
組合せフォーム出力に関するメソッド	○	void	ChangeCbForm(String cbformname) 複数の組合せフォームを出力する場合に使用する組合せフォーム名を切り替えます。
組合せフォーム出力に関するメソッド	○	void	setCbFile(String cbfilename) 組合せフォーム定義ファイル名を指定します。
ユーザ資源情報に関するメソッド	○	void	setFileType(int code) 帳票資源の文字コード系を指定します。
ユーザ資源情報に関するメソッド	○	void	setDataCode(int encoding) 帳票を出力する際の文字コード系を指定します。
資源解放に関するメソッド	○	void	cleanup() Javaインタフェースが使用している資源を解放します。

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

4.7.2.4 コンストラクタの詳細

public

Forms(java.lang.String formname, java.lang.String assets)

throws ConnectorException

用途

帳票名と帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsオブジェクトを生成します。

パラメータ

formname：

帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票名を指定します。

マルチフォーム出力する場合は、1番目に出力する帳票名を指定します。

assets：

帳票管理サーバでユーザアプリケーションを実行する場合は、帳票管理サーバの帳票格納ディレクトリをフルパスで指定します。省略すると、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効になります。

List Creatorコネクタ連携時は、アプリケーションサーバの帳票格納ディレクトリをフルパスで指定します。省略した場合、List Creator Connectorの環境設定で指定した帳票格納ディレクトリが有効となります。List Creator Connectorの環境設定については、List Creator Connectorに添付のオンラインマニュアルを参照してください。

例外

ConnectorException

注意

帳票定義情報の配置場所と指定方法については、以下を参照してください。
⇒“付録A 帳票資源の指定方法”
帳票格納ディレクトリ名の末尾には、以下を指定しないでください。
- 帳票管理サーバ、またはアプリケーションサーバがWindowsの場合
```
    「円マーク（\）」
```
- 帳票管理サーバがSolaris/Linuxの場合、またはアプリケーションサーバがSolaris/Linuxの場合
```
    「スラッシュ（/）」
```
帳票名または帳票格納ディレクトリに、全角文字および半角カナ文字は指定できません。
指定できる文字については、以下を参照してください。
⇒“第8章 List Manager帳票出力インタフェースで指定できる文字”
また、List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なパス長については、以下を参照してください。
⇒“4.10 Javaインタフェース使用時の注意事項”

帳票管理サーバがWindowsの場合、帳票格納ディレクトリとして、ネットワークドライブ（UNC 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、またはリムーバブルディスクを指定しないでください。

組合せフォーム出力する場合は、Forms(String formname, String assets, String cbformname) コンストラクタを使用してください。

備考

帳票出力サーバに帳票定義情報を配置した場合、このコンストラクタで帳票格納ディレクトリを指定しないでください。指定しない場合、帳票出力サーバの環境設定ファイルのLmlcFormDir キーで指定した帳票格納ディレクトリの指定が有効になります。
List Creatorコネクタ連携時、帳票管理サーバに帳票定義情報を配置する場合は、帳票管理サーバの帳票格納ディレクトリをPrintPropertiesクラスのsetPropertyメソッドのID_REMOTEDIRECTORYキーで指定してください。
ID_REMOTEDIRECTORYキーを指定しない場合は、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効となります。
マルチフォーム出力する場合、使用する帳票をChangeFormメソッドで切り替えてください。
マルチフォーム出力する場合、このコンストラクタで指定した帳票名の以下の情報がすべての帳票に対して有効となります。
- 帳票属性の編集コマンド（lmedtformatrコマンド）で指定する帳票属性に関する情報
- プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定するプリンタ構成に関する情報
- List Creatorデザイナで指定した帳票出力に関する情報
- ただし、メソッドの指定方法によっては、帳票ごとに切り替えることが可能な情報があります。マルチフォーム出力時の留意事項については、以下を参照してください。
  ⇒List Creatorに添付のオンラインマニュアル“ 帳票設計編”

public

Forms(java.lang.String formname, java.lang.String assets, java.lang.String cbformname)

throws ConnectorException

用途

組合せフォーム出力する場合に使用するコンストラクタです。

帳票名、帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と格納データのセットを保持するFormオブジェクトを生成します。

パラメータ

formname：: 帳票名を指定します。一番目に出力する帳票名を指定します。

assets：: 帳票格納ディレクトリをフルパスで指定します。

cbformname：: 組合せフォーム名を指定します。

例外

ConnectorException

注意

帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。
コネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintPropertiesクラスのsetPropertyメソッドのID_REMOTEDIRECTORYキーで指定してください。
組合せフォーム出力しない場合は、Forms(String formname, String assets) コンストラクタを使用してください。

備考

帳組合せフォーム出力する場合、使用する帳票をChangeFormメソッドで切り替えてください。
また、使用する組合せフォームをChangeCbFormメソッドで切り替えてください。
マルチフォーム出力する場合、使用する帳票をChangeForm メソッドで切り替えてください。

4.7.2.5 メソッドの詳細

●レコード（行）出力に関するメソッド

public void

pushRecord(java.lang.String record)

throws ConnectorException

用途

帳票を出力するための入力データとなるレコード（行）文字列を追加します。

パラメータ

record：: レコード（行）文字列を指定します。

例外

ConnectorException

注意

1レコード（行）ずつレコード（行）文字列をセットしてください。
レコード（行）文字列には改行コードを含めないでください。
このメソッド指定後に文字コード変換指定をすることはできません。
帳票出力時の文字コードを指定する場合、このメソッド指定前にsetDataCodeメソッドおよびsetFileTypeメソッドで文字コードを指定してください。
文字コード系については、以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”
List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
⇒“付録D 文字コード系に関する注意事項（List Creatorコネクタ連携時）”
マルチフォーム出力/組合せフォーム出力する場合は、使用する帳票をChangeFormメソッドで切り替えてから、このメソッドで帳票名を含めずにレコード（行）文字列を指定してください。
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をChangeCbFormメソッドで切り替えてから、このメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。

備考

このメソッドを繰り返し呼び出した場合、データは追加されていきます。追加されたデータは、作業用ディレクトリ下の一時作業用ファイルに保存されます。cleanupメソッド呼び出し時に削除されます。

●帳票切り替えに関するメソッド

public void

ChangeForm(java.lang.String formname)

throws ConnectorException

用途

マルチフォーム出力、または組合せフォーム出力する場合に、使用する帳票を切り替えます。このメソッド呼び出し以降に指定した入力データは、この帳票の入力データになります。

パラメータ

formname：: 切り替える帳票名を指定します。

例外

ConnectorException

注意

マルチフォーム出力、または組合せフォーム出力する場合は、使用する帳票をこのメソッドで切り替えてから、
pushRecordメソッドで帳票名を含めずにレコード（行）文字列を指定してください。

●組合せフォーム出力に関するメソッド

public void

ChangeCbForm(String cbformname)

throws ConnectorException

用途

複数の組合せフォーム出力する場合に使用する組合せフォーム名を切り替えます。

このメソッド呼び出し以降に指定した入力データは、この組合せフォームの入力データとなります。

パラメータ

cbformname：: 切り替える組合せフォーム名を指定します。

例外

ConnectorException

注意

複数の組合せフォームを出力する場合は、使用する組合せフォーム名をこのメソッドで切り替えてください。
また、ChangeFormメソッドで使用する帳票を切り替えてから、pushRecordメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。

public void

setCbFile(String cbfilename)

throws ConnectorException

用途

組合せフォーム定義ファイル名を指定します。

組合せフォーム定義ファイルとは、組み合せて出力する帳票定義情報と、帳票定義情報の重なり順などが定義されたファイルです。

組合せフォーム出力する場合は、このメソッドで組合せフォーム定義ファイル名を必ず指定してください。

パラメータ

cbfilename：: 組合せフォーム定義ファイル名をフルパスで指定します。

例外

ConnectorException

注意

組合せフォーム定義ファイルの文字コード系については、List Creatorのオンラインマニュアル“帳票設計編”を参照してください。
以下の場合、このメソッドにファイル名のみ指定してください。
- コネクタ連携時に組合せフォーム定義ファイルを転送した場合

●ユーザ資源情報に関するメソッド

public void

setFileType(int code)

throws ConnectorException

用途

帳票資源の文字コード系を指定します。

パラメータ

詳細については、以下を参照してください。
⇒“4.7.1.3 メソッドの詳細”

例外

ConnectorException

注意

このメソッドは、pushRecord メソッドを指定する前に指定してください。pushRecordメソッド指定後、このメソッドを指定することはできません。
文字コード系については以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”
List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
⇒“付録D 文字コード系に関する注意事項（List Creatorコネクタ連携時）”
List Creatorコネクタ連携時に帳票定義情報を転送する場合の文字コード系については、以下を参照してください。
⇒“D.2.2 アプリケーションサーバがSolaris/Linuxの場合”

public void

setDataCode(int encoding)

throws ConnectorException

用途

帳票を出力する際の文字コード系を指定します。

このメソッドの呼び出しを省略すると、以下の文字コード系が使用されます。

帳票管理サーバがWindowsの場合
UNICODE（UTF8）コード系が使用されます。
帳票管理サーバがSolaris/Linuxの場合
以下の優先順序で有効になります。
- setFileTypeメソッドで指定した文字コード系
- 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系

パラメータ

encoding：

入力データの文字コード系を指定します。

CODE_SJIS：: Shift-JIS

CODE_UTF8：: UNICODE（UTF8）

CODE_EUC：: EUC
U90/S90の指定はsetFileTypeメソッドにしたがいます。

例外

ConnectorException

注意

このメソッドは、pushRecordメソッドを指定する前に指定してください。pushRecordメソッド指定後、このメソッドを指定することはできません。
文字コード系については以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”
List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
⇒“付録D 文字コード系に関する注意事項（List Creatorコネクタ連携時）”
List Creatorコネクタ連携時に帳票定義情報を転送する場合の文字コード系については、以下を参照してください。
⇒“D.2.2 アプリケーションサーバがSolaris/Linuxの場合”

●資源解放に関するメソッド

public void

cleanup()

throws ConnectorException

用途

Javaインタフェースが使用している資源を解放します。

例外

ConnectorException

注意

オブジェクトが不要になったら、このメソッドを必ず呼び出してください。