ページの先頭行へ戻る
Interstage List Creator V11.0.0 アプリケーション作成ガイド
FUJITSU Software
第2部 帳票出力インタフェース > 第5章 Javaインタフェース > 5.4 クラスインタフェース > 5.4.2 Formsクラス
前次

5.4.2 Formsクラス

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

      java.lang.Object
        ∟ com.fujitsu.systemwalker.outputassist.connector.Forms

public class Forms
extends java.lang.Object
implements FormBase

5.4.2.1 フィールドの概要

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

⇒“5.4.1.1 フィールドの概要”

5.4.2.2 コンストラクタの概要

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

表5.3 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：
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。

⇒“3.6 ユーザアプリケーションの開発・実行に関する留意事項”

5.4.2.3 メソッドの概要

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

表5.4 Formsクラスのメソッド

メソッドの分類

メソッドの概要
W64：アプリケーションサーバがWindows(x64)の場合に使用できるメソッドです。
S：アプリケーションサーバがSolarisの場合に使用できるメソッドです。
L64：アプリケーションサーバがLinux for Intel64の場合に使用できるメソッドです。
共：どの環境でも使用できるメソッドです。

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

共

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インタフェースが使用している資源を解放します。

5.4.2.4 コンストラクタの詳細

public
Forms(java.lang.String formname, java.lang.String assets)
throws ConnectorException
用途

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

パラメータ
formname：

帳票名を指定します。

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

assets：

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

例外

ConnectorException

注意

  • 帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。リモート帳票出力時またはコネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintPropertiesクラスのsetPropertyメソッドのID_REMOTEDIRECTORYキーで指定してください。

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

  • 帳票格納ディレクトリ名を指定する場合、以下の注意事項があります。

    ⇒“3.6 ユーザアプリケーションの開発・実行に関する留意事項”

備考

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

public
Forms(java.lang.String formname, java.lang.String assets, java.lang.String cbformname)
throws ConnectorException
用途

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

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

パラメータ
formname：

帳票名を指定します。

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

assets：

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

cbformname：

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

例外

ConnectorException

注意

  • 帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。リモート帳票出力時またはコネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintProperties クラスのsetProperty メソッドのID_REMOTEDIRECTORY キーで指定してください。

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

  • 帳票格納ディレクトリ名を指定する場合、以下の注意事項があります。

    ⇒“3.6 ユーザアプリケーションの開発・実行に関する留意事項”

備考

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

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

5.4.2.5 メソッドの詳細

5.4.2.5.1 レコード（行）出力に関するメソッド
public void
pushRecord(java.lang.String record)
throws ConnectorException
用途

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

パラメータ
record：

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

例外

ConnectorException

注意

  • 1レコード（行）ずつレコード（行）文字列をセットしてください。

  • レコード（行）文字列には改行コードを含めないでください。

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

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

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

  • 帳票出力時の文字コードを指定する場合、このメソッド指定前にsetDataCodeメソッドおよびsetFileTypeで文字コードを指定してください。

  • このメソッド指定後に文字コード変換指定をすることはできません。

  • リモート帳票出力型でOWFファイルを生成する場合、PrintPropertiesクラスのsetPropertyメソッドに指定するID_EXECBUFFERキーに、prprintコマンドの-gcmformオプション（マルチフォーム/組合せフォーム用帳票名）を必ず指定してください。

5.4.2.5.2 帳票切り替えに関するメソッド
public void
ChangeForm(java.lang.String formname)
throws ConnectorException
用途

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

パラメータ
formname：

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

例外

ConnectorException

注意

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

5.4.2.5.3 組合せフォーム出力に関するメソッド
public void
ChangeCbForm(String cbformname)
throws ConnectorException
用途

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

パラメータ
cbformname：

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

例外

ConnectorException

注意

  • 複数の組合せフォームを出力する場合は、使用する組合せフォーム名をこのメソッドで切り替えてください。

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

public void
setCbFile(String cbfilename)
throws ConnectorException
用途

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

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

このメソッドの呼び出しを省略すると、帳票格納ディレクトリ配下の組合せフォーム定義ファイル(Lccbform.ini）が有効になります。

パラメータ
cbfilename：

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

例外

ConnectorException

注意

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

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

    • リモート帳票出力時に組合せフォーム定義ファイルを転送した場合

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

  • ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。

    ⇒“3.6 ユーザアプリケーションの開発・実行に関する留意事項”

5.4.2.5.4 ユーザ資源情報に関するメソッド
public void
setFileType(int code)
throws ConnectorException
用途

実行環境の文字コード系を指定します。

詳細については、以下を参照してください。

⇒“5.4.1.3 メソッドの詳細”

例外

ConnectorException

注意

  • このメソッドは、pushRecord を指定する前に指定してください。pushRecord 指定後、このメソッドを指定することはできません。

public void
setDataCode(int encoding)
throws ConnectorException
用途

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

パラメータ
encoding：

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

CODE_SJIS：

Shift-JIS

CODE_UTF8：

UNICODE（UTF8）

CODE_EUC：

EUC

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

例外

ConnectorException

注意

  • このメソッドは、pushRecordメソッド を指定する前に指定してください。pushRecordメソッド 指定後、このメソッドを指定することはできません。

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

    • アプリケーションサーバがWindowsの場合

      ‐UNICODE（UTF8）

    • アプリケーションサーバがUNIX系OSの場合

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

      ‐環境変数（LANG）および環境変数（OA_EUCTYPE）で指定した文字コード系（setFileTypeメソッドで指定しなかった場合）

  • Unicodeの文字が定義されている帳票定義情報を使用する場合は、「CODE_UTF8」を指定してください。

  • 英語環境（英語ロケール）で帳票出力する場合は、「CODE_UTF8」を指定してください。

5.4.2.5.5 資源解放に関するメソッド
public void
cleanup()
throws ConnectorException
用途

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

例外

ConnectorException

注意

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

5.4.2.6 注意事項

前次
Copyright 2012-2022 FUJITSU LIMITED