org.opengion.hayabusa.report

## インタフェース DBTableReport

- 既知の実装クラスのリスト:
    AbstractDBTableReport, DBTableReport_Excel, DBTableReport_HTML

      public interface DBTableReport

       DBTableModel インターフェース のオブジェクトを雛型ファイルに適用して レポートを作成する為の，共通インターフェースです。

  機能分類
    帳票システム
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド abstractメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `setDBTableModel(DBTableModel table)` DBTableModel をセットします。
    `void` | `setFirstTemplateFile(File inFile)` 最初のページのみに使用する雛型ファイル名をセットします。
    `void` | `setFooterKeys(String[] footerKeys)` 繰り返し部の終了後に表示する key 部分を指定します。
    `void` | `setFooterVals(String[] footerVals)` 固定部のkey に対応する値を指定します。
    `void` | `setHeaderKeys(String[] headerKeys)` 固定部の key 部分を指定します。
    `void` | `setHeaderVals(String[] headerVals)` 固定部のkey に対応する値を指定します。
    `void` | `setListId(String listId)` 帳票ＩＤ をセットします。
    `void` | `setOutputDir(String outDir)` 変換後ファイルを出力するディレクトリ名をセットします。
    `void` | `setOutputFileKey(String outFile)` 変換後ファイルキーをセットします。
    `void` | `setPageEndCut(boolean pageEndCut)` ボディー部(繰り返し部)がなくなったときに、それ以降を表示するかどうかを指定します。
    `void` | `setResourceManager(ResourceManager resource)` リソースマネージャーをセットします。
    `void` | `setTemplateFile(File inFile)` 雛型ファイル名をセットします。
    `void` | `setYkno(String ykno)` 帳票起動された要求番号をセットします。
    `void` | `writeReport()` DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。

- - ### メソッドの詳細

    - #### writeReport

          void writeReport()

      DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。

    - #### setTemplateFile

          void setTemplateFile(File inFile)

      雛型ファイル名をセットします。
      パラメータ:
        `inFile` - 雛型ファイル名
      変更履歴:

        3.6.0.0 (2004/09/17) メソッド名の変更。setInputFile ⇒ setTemplateFile
        3.8.0.0 (2005/06/07) 引数を String ⇒ File に変更

    - #### setFirstTemplateFile

          void setFirstTemplateFile(File inFile)

      最初のページのみに使用する雛型ファイル名をセットします。
      パラメータ:
        `inFile` - 最初のページの雛型ファイル名
      変更履歴:

        3.6.0.0 (2004/09/17) 新規追加
        3.8.0.0 (2005/06/07) 引数を String ⇒ File に変更

    - #### setOutputDir

          void setOutputDir(String outDir)

      変換後ファイルを出力するディレクトリ名をセットします。
      パラメータ:
        `outDir` - 出力ディレクトリ名

    - #### setOutputFileKey

          void setOutputFileKey(String outFile)

      変換後ファイルキーをセットします。 キーとは、拡張子の無い状態までのファイル名です。 変換後ファイルは、複数発生します。 実際に出力されるファイル名は、outFile + "_連番.html" となります。
      パラメータ:
        `outFile` - 出力ファイル名の共通部

    - #### setYkno

          void setYkno(String ykno)

      帳票起動された要求番号をセットします。
      パラメータ:
        `ykno` - 要求番号
      変更履歴:

        3.8.5.1 (2006/04/28) 新規追加

    - #### setDBTableModel

          void setDBTableModel(DBTableModel table)

      DBTableModel をセットします。
      パラメータ:
        `table` - DBTableModelオブジェクト

    - #### setHeaderKeys

          void setHeaderKeys(String[] headerKeys)

      固定部の key 部分を指定します。 カンマで複数指定できます。
      パラメータ:
        `headerKeys` - 固定部のキー配列(可変長引数)

    - #### setHeaderVals

          void setHeaderVals(String[] headerVals)

      固定部のkey に対応する値を指定します。 カンマで複数指定で、リクエスト情報でも設定できます。
      パラメータ:
        `headerVals` - 固定部の値配列(可変長引数)

    - #### setFooterKeys

          void setFooterKeys(String[] footerKeys)

      繰り返し部の終了後に表示する key 部分を指定します。 カンマで複数指定できます。
      パラメータ:
        `footerKeys` - 繰り返し部の終了後に表示するキー配列(可変長引数)

    - #### setFooterVals

          void setFooterVals(String[] footerVals)

      固定部のkey に対応する値を指定します。 カンマで複数指定で、リクエスト情報でも設定できます。
      パラメータ:
        `footerVals` - 繰り返し部の終了後に表示する値配列(可変長引数)

    - #### setPageEndCut

          void setPageEndCut(boolean pageEndCut)

      ボディー部(繰り返し部)がなくなったときに、それ以降を表示するかどうかを指定します。 true では、それ以降を出力しません。 デフォルト "true" (なくなった時点で、出力しない。)です。
      パラメータ:
        `pageEndCut` - 繰り返し部の終了後に継続処理するかどうか (true:処理しない/false:処理する)

    - #### setResourceManager

          void setResourceManager(ResourceManager resource)

      リソースマネージャーをセットします。 これは、言語(ロケール)に応じた DBColumn をあらかじめ設定しておく為に 必要です。 リソースマネージャーが設定されていない、または、所定のキーの DBColumn が リソースに存在しない場合は、内部で DBColumn オブジェクトを作成します。
      パラメータ:
        `resource` - リソースマネージャー
      変更履歴:

        4.0.0.0 (2005/01/31) lang ⇒ ResourceManager へ変更

    - #### setListId

          void setListId(String listId)

      帳票ＩＤ をセットします。 この帳票ＩＤを利用して、画像ファイル等のセーブディレクトリを求めます。
      パラメータ:
        `listId` - 帳票ＩＤ
      変更履歴:

        3.6.1.0 (2005/01/05) 新規作成

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.