org.opengion.hayabusa.io

## インタフェース TableWriter

- 既知の実装クラスのリスト:
    AbstractTableWriter, TableWriter_Calc, TableWriter_CalcDef, TableWriter_CalcDefAno, TableWriter_CSV, TableWriter_CSV2, TableWriter_CSV3, TableWriter_Data, TableWriter_Data2, TableWriter_Default, TableWriter_Excel, TableWriter_Fixed, TableWriter_JSON, TableWriter_Properties, TableWriter_T, TableWriter_XML

      public interface TableWriter

  DBTableModel インターフェース のオブジェクトをPrintWriter を用いて出力する為の，共通インターフェースです。
  機能分類
    ファイル出力
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static String` | `CSV_SEPARATOR` カンマ項目区切り文字
    `static String` | `TAB_SEPARATOR` タブ項目区切り文字

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `DBTableModel` | `getDBTableModel()` 内部の DBTableModel を返します。
    `String` | `getHeaderSequence()` DBTableModelの出力順を返します。
    `boolean` | `isAppend()` DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを取得します。
    `boolean` | `isExcel()` このクラスが、EXCEL対応機能を持っているかどうかを返します。
    `void` | `setAppend(boolean flag)` DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうか[true/false]を設定します。
    `void` | `setColumns(String clms)` 出力先ファイルのカラム列を、外部(タグ)より指定します。
    `void` | `setDBTableModel(DBTableModel table, String lang)` DBTableModel をセットします。
    `void` | `setEncode(String enc)` 読み取り元ファイルのエンコード文字列を指定します。
    `void` | `setFilename(String filename)` 出力先ファイル名をセットします。
    `void` | `setFontName(String fontName)` EXCEL出力時のデフォルトフォント名を設定します。
    `void` | `setFontPoint(short point)` EXCEL出力時のデフォルトフォントポイント数を設定します。
    `void` | `setHeaderSequence(String headerSequence)` DBTableModelの出力順をセットします。
    `void` | `setParam(List<HybsEntry> listParam)` パラメーターリストをセットします。
    `void` | `setRecalcSheetName(String sheet)` EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をカンマ区切りで指定します。
    `void` | `setRefFilename(String filename)` EXCEL雛型参考ファイル名をセットします。
    `void` | `setRefSheetName(String sheetName)` EXCEL雛型参考ファイルのシート名を設定します。
    `void` | `setSeparator(String separator)` データを書き込む場合の,区切り文字をセットします。
    `void` | `setSheetName(String sheetName)` DBTableModelのデータとして書き込むときのシート名を設定します。
    `void` | `setSheetOverwrite(boolean flag)` Excelで指定したシートが存在した場合に上書きするかどうか。
    `void` | `setSkipRowCount(int skipRowCount)` データの書き込み開始位置を設定します(初期値:0)。
    `void` | `setUseNumber(boolean useNumber)` 行番号情報を、出力する(true)/しない(false)を指定します。
    `void` | `setUseRenderer(boolean useRenderer)` 書込処理でコードリソースのラベル変換を行うかどうかを指定します。
    `void` | `writeDBTable()` DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。
    `void` | `writeDBTable(PrintWriter writer)` DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。

- - ### フィールドの詳細

    - #### TAB_SEPARATOR

          static final String TAB_SEPARATOR

      タブ項目区切り文字
      関連項目:
        定数フィールド値

    - #### CSV_SEPARATOR

          static final String CSV_SEPARATOR

      カンマ項目区切り文字
      関連項目:
        定数フィールド値

  - ### メソッドの詳細

    - #### writeDBTable

          void writeDBTable()

      DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。 このメソッドは、EXCEL 書き出し時に使用します。
      関連項目:
        `isExcel()`
      変更履歴:

        4.0.0.0 (2006/09/31) 新規追加

    - #### writeDBTable

          void writeDBTable(PrintWriter writer)

      DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。
      パラメータ:
        `writer` - PrintWriterオブジェクト
      変更履歴:

        3.5.4.3 (2004/01/05) 引数に PrintWriter を受け取るように変更します。

    - #### setDBTableModel

          void setDBTableModel(DBTableModel table,
                             String lang)

      DBTableModel をセットします。
      パラメータ:
        `table` - DBTableModelオブジェクト
        `lang` - 言語
      変更履歴:

        3.5.4.2 (2003/12/15) lang 引数も同時に設定します。

    - #### getDBTableModel

          DBTableModel getDBTableModel()

      内部の DBTableModel を返します。
      戻り値:
        DBTableModelオブジェクト

    - #### setHeaderSequence

          void setHeaderSequence(String headerSequence)

      DBTableModelの出力順をセットします。 Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで 出力順を設定します。
      パラメータ:
        `headerSequence` - 出力順 (LNSCD など)

    - #### getHeaderSequence

          String getHeaderSequence()

      DBTableModelの出力順を返します。 Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで 出力順を設定します。
      戻り値:
        出力順 (LNSCD など)

    - #### setSeparator

          void setSeparator(String separator)

      データを書き込む場合の,区切り文字をセットします。 なお，このメソッドは,サブクラスによっては,使用しない場合があります。 もし，使用しないサブクラスを作成する場合は, UnsupportedOperationException を throw するように,サブクラスで実装して下さい。
      パラメータ:
        `separator` - 区切り文字

    - #### setAppend

          void setAppend(boolean flag)

      DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうか[true/false]を設定します。
      パラメータ:
        `flag` - 追加モードで書き込むかどうか[true:追加モード/false:通常モード]
      変更履歴:

        3.5.4.2 (2003/12/15) 新規追加

    - #### isAppend

          boolean isAppend()

      DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを取得します。
      戻り値:
        追加モードで書き込むかどうか[true:追加モード/false:通常モード]
      変更履歴:

        3.5.4.2 (2003/12/15) 新規追加

    - #### setSheetName

          void setSheetName(String sheetName)

      DBTableModelのデータとして書き込むときのシート名を設定します。 これは、EXCEL追加機能として実装されています。
      パラメータ:
        `sheetName` - シート名
      変更履歴:

        3.5.4.2 (2003/12/15) 新規追加

    - #### setRefSheetName

          void setRefSheetName(String sheetName)

      EXCEL雛型参考ファイルのシート名を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、雛型として参照するシート名を指定します。 これにより、複数の形式の異なるデータを順次書き出したり(appendモードを併用)する ことや、シートを指定して新規にEXCELを作成する場合にフォームを設定する事が可能になります。 初期値は、null(第一シート) です。
      パラメータ:
        `sheetName` - シート名
      変更履歴:

        3.5.4.3 (2004/01/05) 新規追加

    - #### isExcel

          boolean isExcel()

      このクラスが、EXCEL対応機能を持っているかどうかを返します。 EXCEL対応機能とは、シート名のセット、雛型参照ファイル名のセット、 書き込み元ファイルのFileオブジェクト取得などの、特殊機能です。 本来は、インターフェースを分けるべきと考えますが、taglib クラス等の 関係があり、問い合わせによる条件分岐で対応します。
      戻り値:
        EXCEL対応機能を持っているかどうか
      変更履歴:

        3.5.4.3 (2004/01/05) 新規追加

    - #### setFilename

          void setFilename(String filename)

      出力先ファイル名をセットします。(DIR + Filename) これは、EXCEL追加機能として実装されています。
      パラメータ:
        `filename` - 出力先ファイル名
      変更履歴:

        3.5.4.3 (2004/01/05) 新規作成

    - #### setRefFilename

          void setRefFilename(String filename)

      EXCEL雛型参考ファイル名をセットします。(DIR + Filename) これは、EXCEL追加機能として実装されています。
      パラメータ:
        `filename` - EXCEL雛型参考ファイル名
      変更履歴:

        3.5.4.3 (2004/01/05) 新規作成

    - #### setSheetOverwrite

          void setSheetOverwrite(boolean flag)

      Excelで指定したシートが存在した場合に上書きするかどうか。
      パラメータ:
        `flag` - シートを上書きするかどうか[true:上書き/false:別名]
      変更履歴:

        5.9.12.1 (2016/09/09) 新規追加

    - #### setRecalcSheetName

          void setRecalcSheetName(String sheet)

      EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をカンマ区切りで指定します。
      パラメータ:
        `sheet` - 対象シート名
      変更履歴:

        5.9.12.1 (2016/09/09) 新規追加

    - #### setEncode

          void setEncode(String enc)

      読み取り元ファイルのエンコード文字列を指定します。 ファイルは、BufferedReader で受け取る為、本来は、エンコードは不要ですが、 固定長ファイルの読み取り時のバイトコード分割時に、指定のエンコードで 分割する必要があります。(例えば、半角文字は、Shift_JIS では、１バイト)
      パラメータ:
        `enc` - ファイルのエンコード文字列
      変更履歴:

        3.5.4.5 (2004/01/23) 新規作成

    - #### setUseNumber

          void setUseNumber(boolean useNumber)

      行番号情報を、出力する(true)/しない(false)を指定します。 通常のフォーマットでは、各行の先頭に行番号を出力します。 これは、#NAME 属性を使用する場合には、必ず出力する必要があります。 (#NAME 属性は、読み取り時には、必須です。) この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力、 このシステムでは、#NAME 属性が出力されないため、読み込みできません。) この行番号を出力しないようにできます。 初期値は、true(出力する) です。
      パラメータ:
        `useNumber` - 行番号情報 [true:出力する/false:しない]
      変更履歴:

        3.7.0.2 (2005/02/14) 新規追加

    - #### setParam

          void setParam(List<HybsEntry> listParam)

      パラメーターリストをセットします。 内部は、HybsEntry クラスを持っています。 引数が、null の場合は、何もしません。
      パラメータ:
        `listParam` - パラメーターリスト
      変更履歴:

        4.0.0.0 (2005/01/31) 新規追加

    - #### setColumns

          void setColumns(String clms)

      出力先ファイルのカラム列を、外部(タグ)より指定します。 ただし、指定のカラム名は、DBTableModel上に存在している必要があります。
      パラメータ:
        `clms` - 出力先ファイルのカラム列(カンマ区切り文字)
      変更履歴:

        4.0.0.0 (2005/11/30) 新規追加

    - #### setFontName

          void setFontName(String fontName)

      EXCEL出力時のデフォルトフォント名を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトフォント名を指定します。 フォント名は、EXCELのフォント名をそのまま使用してください。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontName( String ) に設定されます。 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_NAME です。
      パラメータ:
        `fontName` - デフォルトフォント名
      変更履歴:

        3.8.5.3 (2006/08/07) 新規追加

    - #### setFontPoint

          void setFontPoint(short point)

      EXCEL出力時のデフォルトフォントポイント数を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトポイント数を指定します。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontHeightInPoints( short ) に設定されます。 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_POINTS です。
      パラメータ:
        `point` - フォントポイント数
      変更履歴:

        3.8.5.3 (2006/08/07) 新規追加

    - #### setSkipRowCount

          void setSkipRowCount(int skipRowCount)

      データの書き込み開始位置を設定します(初期値:0)。 TAB区切りテキストやEXCEL等のデータの書き込みの開始位置を指定します。 属性名は、行を飛ばす処理ということで、readTable タグと同じ名称です。 ファイルの先頭行が、０行としてカウントしますので、設定値は、読み飛ばす 件数になります。(１と指定すると、１件読み飛ばし、２行目から読み込みます。) 行の読み飛ばしと、カラムの読み飛ばし(columns)、refFileURL、refFilename、 refSheetName とともに使用すれば、ある程度のレイアウト設定が可能です。 なお、この機能は、TableWriter_Excel のみに実装します。
      パラメータ:
        `skipRowCount` - 書き込み開始位置
      変更履歴:

        5.7.9.0 (2014/08/08) 新規作成

    - #### setUseRenderer

          void setUseRenderer(boolean useRenderer)

      書込処理でコードリソースのラベル変換を行うかどうかを指定します。 コードリソースをそのままの値で出力すると、数字や記号になり何が書かれているのか 不明になります。 これは、コードリソースをラベルに変換して出力するかどうかを指定します。 当然、コードはユニークですが、ラベルはユニークになるかどうか保障はされていませんので TableReader 系で読み込む場合には、リスクが発生します。 また、TableReader 系で読み込む場合にも、ラベルからコードを求める逆変換を行うように、 setUseRenderer メソッドで指定する必要があります。 従来は、TableWriter 系に、TableWriter_Renderer 系のクラスを作って対応していましたが、 このメソッドの属性値のフラグで、制御します。
      パラメータ:
        `useRenderer` - コードリソースのラベル変換を行うかどうかを指定
      変更履歴:

        5.2.1.0 (2010/10/01) 新規作成

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