Interstage List Works for Modernization V11.0.0 帳票印刷配信機能アプリケーション作成ガイド 帳票出力編

4.7.3 FormsFileクラス

帳票の出力時に使用する帳票と入力データを保持します。

入力データをファイルで扱う場合に使用します。

java.lang.Object
      └com.fujitsu.systemwalker.outputassist.connector.FormsFile


public class FormsFile
extends java.lang.Object
implements FormBase

4.7.3.1 フィールドの一覧

FormsFileクラスのsetGrpOutメソッドで指定するフィールドを以下に示します。

FormsFileクラスのsetGrpOutメソッドで指定するフィールド

定数	説明
GRPOUT_NOGRP	マルチフォーム出力しません。
GRPOUT_GRP	マルチフォーム出力します。

FormsFileクラスのsetGrpDelimitModeメソッドで指定するフィールドを以下に示します。

FormsFileクラスのsetGrpDelimitModeメソッドで指定するフィールド

定数	説明
DELIMIT_ANY	以下の場合に指定します。 入力データ形式が「可変長」、区切り文字が「バーティカルバー（|）」「シャープ（#）」「アスタリスク（*）」「任意」のいずれかの場合 入力データ形式が「CSV 形式」、区切り文字が「カンマ（,）」の場合
DELIMIT_SPACE	入力データ形式が「可変長」、区切り文字が「1個以上の空白」の場合に指定します。
DELIMIT_TAB	以下の場合に指定します。 入力データ形式が「可変長」、区切り文字が「タブ」の場合 入力データ形式が「CSV 形式」、区切り文字が「タブ」の場合
DELIMIT_FIXED	入力データ形式が「固定長」、区切り文字が「区切り文字なし」の場合に指定します。
DELIMIT_FIXEDDELIMIT	入力データ形式が「固定長」、区切り文字が「区切り文字あり」の場合に指定します。
DELIMIT_XML	入力データ形式が「XML形式」の場合に指定します。

インタフェース com.fujitsu.systemwalker.outputassist.connector.FormBase から継承した文字コードを意味するフィールドについては、以下を参照してください。
⇒“4.7.1.1 フィールド一覧”

4.7.3.2 コンストラクタの概要

FormsFileクラスのコンストラクタを以下に示します。

FormsFileクラスのコンストラクタ

コンストラクタの概要

FormsFile(java.lang.String assets)

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

4.7.3.3 メソッド一覧

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

FormsFileクラスのメソッド

分類	メソッド一覧
ユーザ資源情報に関するメソッド	○	void	setScriptFile (java.lang.String name)  (*1)
				1つの帳票出力時の帳票名を指定します。
	○	void	setDataFile(java.lang.String pathname)  (*1)
				入力データのデータファイル名を指定します。
	○	void	setDataFile(java.lang.String pathname, int encoding)  (*1)
				入力データのデータファイル名と文字コード系を指定します。
	○	void	setFileType(int code)
				帳票資源の文字コード系を指定します。
	○	void	setXmlDataRoot(java.lang.String xmlroot)
				入力データ形式が「XML形式」で、XMLルートとデータルートが異なる場合に、XMLデータ中のデータルートの親要素のパスを指定します。
マルチフォーム出力/組合せフォーム出力用ユーザ資源情報に関するメソッド	○	void	setGrpOut(int group)  (*1)
				マルチフォーム出力するときに指定します。
	○	void	setLcForm(java.lang.String names)  (*1)
				マルチフォーム出力/組合せフォーム出力時の帳票名を指定します。
	○	void	setGrpDelimitMode(int mode)  (*1)
				マルチフォーム/組合せフォーム用帳票名データ区切り文字種別を指定します。
	○	void	setGrpDelimit(java.lang.String delimit)
				マルチフォーム/組合せフォーム用帳票名データ区切り文字を指定します。
	○	void	setGrpBytes(int length)
				マルチフォーム用帳票名データフィールド長を指定します。
	○	void	setCbForm(boolean cbform) (*1)
				組合せフォームを出力するときに指定します。
	○	void	setCbFile(String cbfilename)
				組合せフォーム定義ファイル名を指定します。
資源解放に関するメソッド	○	void	cleanup()
				Javaインタフェースが使用している資源を解放します。

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

*1：以下のように、1つの帳票を出力する場合とマルチフォーム出力する場合で、指定が必須なメソッドが異なります。

－1つの帳票を出力する場合

      setScriptFileメソッド
      setDataFileメソッド

－マルチフォーム出力する場合

      setDataFileメソッド
      setGrpOutメソッド
      setGrpDelimitModeメソッド
      setLcFormメソッド

－組合せフォーム出力する場合

      setDataFileメソッド
      setCbFormメソッド
      setLcFormメソッド
      setGrpDelimitModeメソッド
      setCbFileメソッド

4.7.3.4 コンストラクタの詳細

public

FormsFile(java.lang.String assets)

throws ConnectorException

用途

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

パラメータ

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 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、またはリムーバブルディスクを指定しないでください。

備考

• 帳票出力サーバに帳票定義情報を配置した場合、このコンストラクタで帳票格納ディレクトリを指定しないでください。指定しない場合、帳票出力サーバの環境設定ファイルのLmlcFormDir キーで指定した帳票格納ディレクトリの指定が有効になります。

• List Creatorコネクタ連携時、帳票管理サーバに帳票定義情報を配置する場合は、帳票管理サーバの帳票格納ディレクトリをPrintPropertiesクラスのsetPropertyメソッドのID_REMOTEDIRECTORYキーで指定してください。
  ID_REMOTEDIRECTORYキーを指定しない場合は、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効となります。

4.7.3.5 メソッドの詳細

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

public void

setScriptFile(java.lang.String name)

throws ConnectorException

用途

1つの帳票を出力する場合の帳票名を指定します。

パラメータ

name：

1つの帳票を出力するときに使用する帳票名を指定します。
帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票名を指定します。

例外

ConnectorException

注意

• 1つの帳票を出力する場合（マルチフォーム出力、または組合せフォーム出力をしない場合）は、このメソッドを必ず指定してください。

  

  

public void

setDataFile(java.lang.String pathname)

throws ConnectorException

用途

入力データとなるデータファイル名を指定します。

パラメータ

pathname：

入力データのデータファイル名を指定します。

• 帳票管理サーバがWindowsの場合

  250バイト以内のフルパスで指定します。

• 帳票管理サーバがSolaris/Linuxの場合

  1023バイト以内のフルパスで指定します。

例外

ConnectorException

注意

• List Creatorコネクタ連携時、データファイルはアプリケーションサーバに配置します。
  したがって、指定するデータファイル名は、アプリケーションサーバ側のフルパスを指定してください。
  List Creatorコネクタ連携時に指定可能なデータファイル名のパス長については、以下を参照してください。
  ⇒“4.10.3 List Creatorコネクタ連携時の注意事項”

• FormsFileクラスを使用して、List Managerで帳票配信・出力する場合、入力データファイル名を必ず指定してください。

備考

• List Creatorコネクタ連携時、帳票管理サーバに転送された入力データは、帳票出力後に削除されます。帳票資源の扱いについては、オンラインマニュアル“帳票印刷配信機能 運用ガイド”を参照してください。

• このメソッドで指定する入力データ中のデータは、以下の文字コード系で記述してください。

  • 帳票管理サーバ、またはアプリケーションサーバがWindowsの場合
    Shift-JISコード系で記述してください。

  • 帳票管理サーバがSolaris/Linuxの場合、またはアプリケーションサーバがSolaris/Linuxの場合
    以下のいずれかの文字コード系で記述してください。

    • setFileTypeメソッドで指定した文字コード系

    • 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系

    なお、文字コード系の指定は、以下の優先順序で有効になります。

    1. setFileTypeメソッド

    2. 環境変数LANGおよび環境変数OA_EUCTYPE

• 文字コード系については以下を参照してください。
  ⇒“C.1 List Managerで扱える文字コード系”
  List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
  ⇒“付録D 文字 コード系に関する注意事項（List Creatorコネクタ連携時）”

• データファイルを使用する場合、帳票定義情報の設計時に、List Creatorデザイナのデータ定義画面の［DB連携］タブのDBタイプに「データファイル」を指定しておく必要があります。

• 入力データ形式が「XML形式」の場合には、別途必要となる製品があります。詳細については、オンラインマニュアル“帳票印刷配信機能 スタートガイド”の“5.3  ソフトウェア環境”を参照してください。

  

  

public void

setDataFile(java.lang.String pathname, int encoding)

throws ConnectorException

用途

入力データのデータファイル名と文字コード系を指定します。

パラメータ

pathname：

入力データのデータファイル名を指定します。

• 帳票管理サーバがWindowsの場合

  250バイト以内のフルパスで指定します。

• 帳票管理サーバがSolaris/Linuxの場合

  1023バイト以内のフルパスで指定します。

encoding：

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

CODE_SJIS：

Shift-JIS

CODE_UCS2LE：

UNICODE（UCS2リトルエンディアン）

CODE_UCS2BE：

UNICODE（UCS2ビッグエンディアン）

CODE_UTF8：

UNICODE（UTF8）

CODE_EUC：

EUC

例外

ConnectorException

注意

• List Creatorコネクタ連携時、データファイルはアプリケーションサーバに配置します。
  したがって、指定するデータファイル名は、アプリケーションサーバ側のフルパスを指定してください。
  List Creatorコネクタ連携時に指定可能なデータファイル名のパス長については、以下を参照してください。
  ⇒“4.10.3 List Creatorコネクタ連携時の注意事項”

• FormsFileクラスを使用して、List Managerで帳票配信・出力する場合、入力データファイル名を必ず指定してください。

• 帳票管理サーバがSolaris/Linuxの場合で、encordingパラメタに「CODE_EUC」 を指定するとき、setFileTypeメソッドで「 CODE_EUC_U90 」または「CODE_EUC_S90」 を指定してください。

• 帳票管理サーバがLinuxの場合は、文字コードにShift-JISを使用できないため、encordingパラメタに「CODE_SJIS」を指定しないでください。

• 「CODE_UTF8」 を指定する場合、setFileTypeメソッドで「CODE_UTF8」を指定してください。

備考

• List Creatorコネクタ連携時、帳票管理サーバに転送された入力データは、帳票出力後に削除されます。帳票資源の扱いについては、オンラインマニュアル“帳票印刷配信機能 運用ガイド”を参照してください。

• このメソッドで指定する入力データ中のデータは、パラメータで指定した文字コード系で記述してください。
  入力データ形式が「XML形式」の入力データを使用してOWFファイル生成を行う場合、文字コードは、CODE_SJISを指定してください。

• 文字コード系については以下を参照してください。
  ⇒“C.1 List Managerで扱える文字コード系”
  List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
  ⇒“付録D 文字 コード系に関する注意事項（List Creatorコネクタ連携時）”

• List Creatorコネクタ連携時に帳票定義情報を転送する場合の文字コード系については、以下を参照してください。
  ⇒“D.2.2 アプリケーションサーバがSolaris/Linuxの場合”

• 入力データ形式が「XML形式」の場合には、別途必要となる製品があります。詳細については、オンラインマニュアル“帳票印刷配信機能 スタートガイド”の“5.3  ソフトウェア環境”を参照してください。

  

  

public void

setFileType(int code)

throws ConnectorException

用途

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

パラメータ

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

例外

ConnectorException

注意

• 文字コード系については以下を参照してください。
  ⇒“付録C 文字コード系に関する注意事項（帳票配信・出力時）”
  List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
  ⇒“付録D 文字 コード系に関する注意事項（List Creatorコネクタ連携時）”

• List Creatorコネクタ連携時に帳票定義情報を転送する場合の文字コード系については、以下を参照してください。
  ⇒“D.2.2 アプリケーションサーバがSolaris/Linuxの場合”

  

  

public void

setXmlDataRoot(java.lang.String xmlroot)

throws ConnectorException

用途

入力データ形式が「XML形式」で、XMLルートとデータルートが異なる場合に、XMLデータ中のデータルートの親要素のパスを指定します。

XMLデータ中のこのメソッドで指定したパス直下にデータルートが複数存在する場合は、すべてのデータルートを検索します。

このメソッドの呼び出しを省略すると、以下のようにXMLデータからデータルートを検索します。

• XMLルートとデータルートが同じ名前の場合
  XMLルートをデータルートとみなします。

• XMLルートとデータルートが異なる場合
  XMLルート直下の子要素の中からデータルートを検索します。

パラメータ

xmlroot：

XMLデータ中のデータルートの親要素のパスを指定します。
データルートの親要素のパスは、「スラッシュ(/)」を始点にデータルートの親要素までの要素名を「スラッシュ(/)」で区切って指定します。それ以外の形式は指定できません。

例外

ConnectorException

●マルチフォーム出力/組合せフォーム出力用ユーザ資源情報に関するメソッド

public void

setGrpOut(int group)

throws ConnectorException

用途

マルチフォーム出力するときに指定します。

パラメータ

group：

マルチフォーム出力するかどうかを指定します。

GRPOUT_NOGRP：

マルチフォーム出力しません。

GRPOUT_GRP：

マルチフォーム出力します。

例外

ConnectorException

注意

• マルチフォーム出力する場合（setGrpOutメソッドに「GRPOUT_GRP」を指定した場合）、setLcFormメソッド で帳票名を必ず指定してください。

  

  

public void

setLcForm(java.lang.String names)

throws ConnectorException

用途

マルチフォーム出力/組合せフォーム出力時の帳票名を指定します。

パラメータ

names：

マルチフォーム出力する場合（setGrpOutメソッドに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（setCbFormメソッドに「true」を指定した場合）に、使用する帳票名を指定します。

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

複数の帳票名を「セミコロン（;）」で区切って、帳票を出力する順に指定します。

例外

ConnectorException

注意

• マルチフォーム出力する場合（setGrpOutメソッドに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（setCbFormメソッドに「true」を指定した場合）、このメソッドで帳票名を必ず指定してください。

備考

• マルチフォーム出力する場合、このメソッドで指定した帳票名のうち、先頭に指定した帳票名の以下の情報がすべての帳票に対して有効となります。

  • 帳票属性の編集コマンド（lmedtformatrコマンド）で指定する帳票属性に関する情報

  • プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定するプリンタ構成に関する情報

  • List Creatorデザイナで指定した帳票出力に関する情報

ただし、メソッドの指定方法によっては、帳票ごとに切り替えることが可能な情報があります。マルチフォーム出力時の留意事項については、以下を参照してください。
⇒List Creatorに添付のオンラインマニュアル“ 帳票設計編”

• 入力データ形式が「XML形式」でマルチフォーム出力時、帳票に置換フォントが設定されている場合、指定する先頭の帳票の置換フォントの設定が有効になります。

  

  

public void

setGrpDelimitMode(int mode)

throws ConnectorException

用途

マルチフォーム/組合せフォーム用帳票名データ区切り文字種別を指定します。

パラメータ

mode：

マルチフォーム/組合せフォーム用帳票名データ区切り文字種別を指定します。

DELIMIT_ANY：

以下の場合に指定します。

• 入力データ形式が「可変長」、区切り文字が「バーティカルバー（|）」「シャープ（#）」「アスタリスク（*）」「任意」のいずれかの場合

• 入力データ形式が「CSV 形式」、区切り文字が「カンマ（,）」の場合

DELIMIT_SPACE：

入力データ形式が「可変長」、区切り文字が「1 個以上の空白」の場合に指定します。

DELIMIT_TAB：

以下の場合に指定します。

• 入力データ形式が「可変長」、区切り文字が「タブ」の場合

• 入力データ形式が「CSV 形式」、区切り文字が「タブ」の場合

DELIMIT_FIXED：

入力データ形式が「固定長」、区切り文字が「区切り文字なし」の場合に指定します。

DELIMIT_FIXEDDELIMIT：

入力データ形式が「固定長」、区切り文字が「区切り文字あり」の場合に指定します。

DELIMIT_XML：

入力データ形式が「XML形式」の場合に指定します。

例外

ConnectorException

注意

• マルチフォーム出力/組合せフォーム出力する場合は、このメソッドを必ず指定してください。
  入力データ形式が「固定長」の場合（このメソッドで「DELIMIT_FIXED」または「DELIMIT_FIXEDDELIMIT」を指定した場合）は、帳票名データのフィールド長をsetGrpBytesメソッドで必ず指定してください。

  

  

public void

setGrpDelimit(java.lang.String delimit)

throws ConnectorException

用途

マルチフォーム出力する場合（setGrpOutメソッドに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（setCbFormメソッドに「true」を指定した場合）で、任意の区切り文字を使用する場合（setGrpDelimitModeメソッドに「DELIMIT_ANY」を指定した場合）に、実際に使用する区切り文字を指定します。

区切り文字は、List Creatorデザイナのデータ定義画面の［環境定義］タブで指定した入力データ形式と区切り文字にしたがって指定します。

パラメータ

delimit：

マルチフォーム/組合せフォーム用帳票名データ区切り文字を1 バイトの文字列で指定します。

例外

ConnectorException

注意

• 表にある条件でマルチフォーム/組合せフォーム用帳票名データ区切り文字に「任意の1バイト文字」または「区切り文字あり」を指定する場合の、区切り文字の文字コードについて以下に示します。

帳票管理サーバ	入力データの文字コード系	入力データ形式	マルチフォーム/組合せフォーム用帳票名データ区切り文字の文字コード
Windows	UNICODE（UCS2/UTF8）	可変長	0x007F/0x7F以下の文字
		固定長
Solaris Linux	EUC（U90/S90）またはUNICODE（UTF8）	可変長	0x7F以下の文字
		固定長

• 組合せフォーム出力する場合、「コロン（:）」は指定しないでください。

  

  

public void

setGrpBytes(int length)

throws ConnectorException

用途

マルチフォーム出力する場合（setGrpOutメソッドに「GRPOUT_GRP」を指定した場合）に、入力データ中の帳票名データのフィールド長を指定します。

入力データ形式が「固定長」の場合（setGrpDelimitModeメソッドに「DELIMIT_FIXED」または「DELIMIT_FIXEDDELIMIT」を指定する場合）は、このメソッドを必ず指定してください。「区切り文字あり」の場合は、区切り文字を含まない長さを指定してください。

パラメータ

length：

マルチフォーム用帳票名データフィールド長を指定します。

例外

ConnectorException

public void

setCbForm(boolean cbform)

throws ConnectorException

用途

組合せフォーム出力するときに指定します。

このメソッドの呼び出しを省略すると、組合せフォーム出力は行われません。

パラメータ

cbform：

組合せフォーム出力するかどうかを指定します。

false：組合せフォーム出力しません。

true ：組合せフォーム出力します。

例外

ConnectorException

注意

• 組合せフォーム出力する場合は、setGrpDelimitMode メソッド、およびsetGrpDelimit メソッドで帳票名データ区切り文字を指定してください。

• 組合せフォーム出力する場合は、setLcForm メソッドで帳票名を必ず指定してください。

  

  

public void

setCbFile(String cbfilename)

throws ConnectorException

用途

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

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

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

パラメータ

cbfilename：

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

例外

ConnectorException

注意

• 組合せフォーム定義ファイルの文字コード系については、List Creatorのオンラインマニュアル“ 帳票設計編” を参照してください。

• 以下の場合、このメソッドにファイル名のみ指定してください。

  • コネクタ連携時に組合せフォーム定義ファイルを転送した場合

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

public void

cleanup()

throws ConnectorException

用途

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

例外

ConnectorException

注意

• オブジェクトを破棄する前に、このメソッドを必ず呼び出してください。

4.7.3.6 注意事項

• 文字コード系については以下を参照してください。
  ⇒“C.1 List Managerで扱える文字コード系”
  List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
  ⇒“付録D 文字 コード系に関する注意事項（List Creatorコネクタ連携時）”