パッケージ org.opengion.hayabusa.io

クラス AbstractTableWriter

  • すべての実装されたインタフェース:
    TableWriter
    直系の既知のサブクラス:
    TableWriter_Default

    public abstract class AbstractTableWriter
    extends Object
    implements TableWriter
    区切り文字指定(初期値:タブ)ゼロカンマファイルの書き出しクラスです。 ラベル,名前,データの出力部のみオーバーライドすれば,各種出力フォーマットに合わせた サブクラスを実現する事が可能です。 ゼロカンマファイルとは、EXCELのゼロサプレス対策として、頭ゼロの文字型データを出力する 時に、先頭にカンマ(')を付けて、ゼロが削除(見えなくなる)現象を抑止しているファイルです。 このクラスは,可変長タブ区切り文字ファイルの出力機能を実現しています。
    機能分類
    ファイル出力
    バージョン
    4.0
    作成者
    Kazuhiko Hasegawa
    導入されたバージョン:
    JDK5.0,
    • フィールドの概要

      フィールド 
      修飾子とタイプ フィールド 説明
      protected static int BUFFER_MIDDLE
      StringBilderなどの初期値を設定します。
      protected int[] clmNo
      カラム数
      protected static String CR
      システムの改行コードを設定します。
      protected DBColumn[] dbColumn
      DBカラム
      protected int[] dbType
      DBタイプ
      protected boolean[] isKeyLbl
      KeyLabel出力
      static int NUMBER
      dbType の簡易的な設定 2
      protected int numberOfColumns
      出力対象のカラム数
      static int NVAR
      dbType の簡易的な設定 1
      static int STRING
      dbType の簡易的な設定 0
      protected DBTableModel table
      テーブルモデル
    • コンストラクタの概要

      コンストラクタ 
      修飾子 コンストラクタ 説明
      protected AbstractTableWriter()
      デフォルトコンストラクター
    • メソッドの概要

      すべてのメソッド インスタンス・メソッド abstractメソッド concreteメソッド 
      修飾子とタイプ メソッド 説明
      protected void checkParam​(String key, Map<String,​String> keysMap)
      keys の整合性チェックを行います。
      protected boolean createDBColumn()
      numberOfColumns と DBColumn を初期化します。
      DBTableModel getDBTableModel()
      内部の DBTableModel を返します。
      protected String getEncode()
      読み取り元ファイルのエンコード文字列を取得します。
      String getHeaderSequence()
      DBTableModelの出力順を返します。
      String getSeparator()
      データを書き込む場合の,区切り文字を返します。
      boolean isAppend()
      DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを取得します。
      protected boolean isDebug()
      デバッグ情報を出力するかどうか[true:する/false:しない]を取得します。
      boolean isExcel()
      このクラスが、EXCEL対応機能を持っているかどうかを返します。
      protected boolean isUseNumber()
      行番号情報を、出力する(true)/しない(false)を返します。
      protected boolean isUseRenderer()
      書き出し処理でコードリソースのラベル変換を行うかどうかを返します。
      protected String quotation​(String data)
      データを ダブルコーテーション(")で囲みます。
      protected String quotation2​(String data)
      データに対して 改行、ダブルクオート等の処理を行います。
      void setAddTitleSheet​(String sheetName)
      EXCEL出力時に、Sheet一覧を先頭Sheetに作成する場合のSheet名を指定します。
      void setAppend​(boolean flag)
      DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを設定します。
      void setColumns​(String clms)
      出力先ファイルのカラム列を、外部(タグ)よりCSV形式の文字列で指定します。
      void setDBTableModel​(DBTableModel table, String lang)
      DBTableModel をセットします。
      void setDebug​(boolean useDebug)
      デバッグ情報を出力するかどうか[true:する/false:しない]を指定します。
      void setEncode​(String enc)
      読み取り元ファイルのエンコード文字列を指定します。
      void setFileBreakColumn​(String fileBreakColumn)
      EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)。
      void setFilename​(String directory, String filename)
      出力先ディレクトリとファイル名をセットします。
      void setFontName​(String fontName)
      EXCEL出力時のデフォルトフォント名を設定します。
      void setFontPoint​(short point)
      EXCEL出力時のデフォルトフォントポイント数を設定します。
      void setHeaderSequence​(String hs)
      DBTableModelの出力順をセットします。
      void setHyperLinkColumn​(String hyperLinkColumn)
      EXCEL出力時に、Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定します。
      void setOmitNames​(String clms)
      書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します。
      void setPageBreakColumn​(String pageBreakColumn)
      EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)。
      void setParam​(List<HybsEntry> listParam)
      パラメーターリストをセットします。
      void setRecalcSheetName​(String sheet)
      EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をCSV形式で指定します。
      void setRefFilename​(String filename)
      EXCEL雛型参考ファイル名をセットします。
      void setRefSheetName​(String sheetName)
      EXCEL雛型参考ファイルのシート名を設定します。
      void setSeparator​(String sep)
      データを書き込む場合の,区切り文字をセットします。
      void setSheetName​(String sheetName)
      DBTableModelのデータとして読み込むときのシート名を設定します。
      void setSheetOverwrite​(boolean flag)
      雛形のシート名を、そのまま使用する(true)か、新規、または、外部指定のシート名を使用する(false)を指定します。
      void setSkipRowCount​(int skipRowCount)
      データの書き込み開始行番号を設定します(初期値:0)。
      void setUseActiveWorkbook​(boolean useActiveWorkbook)
      EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します。
      void setUseAutoCellSize​(boolean useAutoCellSize)
      EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します。
      void setUseCellStyle​(boolean useCellStyle)
      EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します。
      void setUseNumber​(boolean useNumber)
      行番号情報を、出力する(true)/しない(false)を指定します。
      void setUseRenderer​(boolean useRenderer)
      書込処理でコードリソースのラベル変換を行うかどうか[true/false]を指定します。
      protected void writeClass​(DBTableModel table, PrintWriter writer)
      PrintWriter に DBTableModelのクラス名情報を書き込みます。
      protected abstract void writeData​(DBTableModel table, PrintWriter writer)
      PrintWriter に DBTableModelのテーブル情報を書き込みます。
      abstract void writeDBTable()
      DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。
      abstract void writeDBTable​(PrintWriter writer)
      DBTableModel から データを作成して,PrintWriter に書き出します。
      protected void writeHeader​(PrintWriter writer)
      PrintWriter に DBTableModelのヘッダー情報を書き込みます。
      protected void writeLabel​(DBTableModel table, PrintWriter writer)
      PrintWriter に DBTableModelのラベル情報を書き込みます。
      protected void writeLabel2​(DBTableModel table, PrintWriter writer)
      PrintWriter に DBTableModelのヘッダー情報を書き込みます。
      protected void writeName​(DBTableModel table, PrintWriter writer)
      PrintWriter に DBTableModelの項目名情報を書き込みます。
      protected void writeSeparator​(DBTableModel table, PrintWriter writer)
      PrintWriter に セパレーターを書き込みます。
      protected void writeSize​(DBTableModel table, PrintWriter writer)
      PrintWriter に DBTableModelのサイズ情報を書き込みます。
    • フィールドの詳細

      • CR

        protected static final String CR
        システムの改行コードを設定します。
      • BUFFER_MIDDLE

        protected static final int BUFFER_MIDDLE
        StringBilderなどの初期値を設定します。 200
        関連項目:
        定数フィールド値
      • numberOfColumns

        protected int numberOfColumns
        出力対象のカラム数
      • table

        protected DBTableModel table
        テーブルモデル
      • dbColumn

        protected DBColumn[] dbColumn
        DBカラム
      • clmNo

        protected int[] clmNo
        カラム数
      • dbType

        protected int[] dbType
        DBタイプ
      • isKeyLbl

        protected boolean[] isKeyLbl
        KeyLabel出力
    • コンストラクタの詳細

      • AbstractTableWriter

        protected AbstractTableWriter()
        デフォルトコンストラクター
        変更履歴:
        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    • メソッドの詳細

      • writeDBTable

        public abstract void writeDBTable()
        DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。 このメソッドは、EXCEL 書き出し時に使用します。
        定義:
        writeDBTable インタフェース内 TableWriter
        関連項目:
        isExcel()
      • writeDBTable

        public abstract void writeDBTable​(PrintWriter writer)
        DBTableModel から データを作成して,PrintWriter に書き出します。
        定義:
        writeDBTable インタフェース内 TableWriter
        パラメータ:
        writer - PrintWriterオブジェクト
      • createDBColumn

        protected boolean createDBColumn()
        numberOfColumns と DBColumn を初期化します。 内部的に、DBTableModel、lang , columns を使用して、 numberOfColumns 、dbColumn、clmNo、dbType の値を初期化します。 カラムが1項目もない場合、言語(lnag)が未指定、DBTableModelが未指定(null) の場合は、false を返します。その場合は、以下の処理は正常に行えません。 データが0件の場合は、処理を行います。通常、ヘッダーのみのファイルを 作成することになります。(これを雛形として、取込データを登録する事が可能) 6.0.1.2 (2014/08/08) clmNo 配列に、-1 がセットされた場合、DBTableModel に存在しないカラムとして そのカラム列は、書き込みしません。,,,, などを指定する事で、カラムを 飛ばして書き込むことが可能です。 refFileURL、refFilename、refSheetName とともに使用すれば、ある程度の レイアウト設定が可能です。
        戻り値:
        初期化成功:true / 失敗:false
        変更履歴:
        4.0.0.0 (2005/12/31) 外部指定のカラム名を使用, 5.1.6.0 (2010/05/01) DbType の初期値を設定, 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加, 6.0.2.0 (2014/09/19) EXCEL新機能対応(2回呼ばれない様にする), 6.1.0.0 (2014/12/26) omitNames 属性を追加, 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
      • writeHeader

        protected void writeHeader​(PrintWriter writer)
        PrintWriter に DBTableModelのヘッダー情報を書き込みます。
        パラメータ:
        writer - PrintWriterオブジェクト
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
      • writeLabel2

        protected void writeLabel2​(DBTableModel table,
                                   PrintWriter writer)
        PrintWriter に DBTableModelのヘッダー情報を書き込みます。 ここでは、ラベル情報と同じデータを出力しますが、# を外します。 また、ラベルを文字列としてダブルコーテーションでくくります。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        7.2.6.1 (2020/07/17) H:Header(ヘッダー)属性追加。
      • writeLabel

        protected void writeLabel​(DBTableModel table,
                                  PrintWriter writer)
        PrintWriter に DBTableModelのラベル情報を書き込みます。 第一カラム目は、ラベル情報を示す "#Label" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定, 4.0.0.0 (2005/12/31) 外部指定のカラム名を使用, 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加, 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加, 6.2.4.2 (2015/05/29) StringUtil#tagCut(String) をラベルに適用します。
      • writeName

        protected void writeName​(DBTableModel table,
                                 PrintWriter writer)
        PrintWriter に DBTableModelの項目名情報を書き込みます。 第一カラム目は、項目名情報を示す "#Name" を書き込みます。 useNumber=fale の場合は、最初のカラム名の先頭に、# が書き込まれます。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定, 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加, 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
      • writeSize

        protected void writeSize​(DBTableModel table,
                                 PrintWriter writer)
        PrintWriter に DBTableModelのサイズ情報を書き込みます。 第一カラム目は、サイズ情報を示す "#Size" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 3.5.5.5 (2004/04/23) DBColumn の size と maxlength の 意味を変更, 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定, 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加, 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
      • writeClass

        protected void writeClass​(DBTableModel table,
                                  PrintWriter writer)
        PrintWriter に DBTableModelのクラス名情報を書き込みます。 第一カラム目は、サイズ情報を示す "#Class" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加, 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
      • writeSeparator

        protected void writeSeparator​(DBTableModel table,
                                      PrintWriter writer)
        PrintWriter に セパレーターを書き込みます。 第一カラム目は、サイズ情報を示す "#----" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定, 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
      • writeData

        protected abstract void writeData​(DBTableModel table,
                                          PrintWriter writer)
        PrintWriter に DBTableModelのテーブル情報を書き込みます。 このクラスでは,データを ダブルコーテーション(")で囲みます。 PrintWriter に DBTableModelのテーブル情報を書き込みます。
        パラメータ:
        table - DBTableModelオブジェクト
        writer - PrintWriterオブジェクト
        変更履歴:
        2.0.0.5 (2002/09/30) 先頭が0 でかつ数字タイプ(S9 or R)でない場合に ' を出力するように修正。, 2.3.1.2 (2003/01/28) データ出力時に、改行が余分に出される箇所を修正。, 3.1.0.0 (2003/03/20) DBColumn から、getDbType() キーを直接取り出す, 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 3.3.3.1 (2003/07/18) ファイルリード/ライト時に後ろスペースの除去を行います。, 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定, 3.8.0.1 (2005/06/17) DBTypeが NVAR の場合は、元のUnicodeに戻します。, 5.1.6.0 (2010/05/01) DbType の初期値(dbType)を利用する。, 5.2.1.0 (2010/10/01) このメソッドは、abstract 化します。
      • setDBTableModel

        public void setDBTableModel​(DBTableModel table,
                                    String lang)
        DBTableModel をセットします。
        定義:
        setDBTableModel インタフェース内 TableWriter
        パラメータ:
        table - DBTableModelオブジェクト
        lang - 言語コード
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。, 3.5.4.2 (2003/12/15) lang 引数も同時に設定します。
      • getDBTableModel

        public DBTableModel getDBTableModel()
        内部の DBTableModel を返します。
        定義:
        getDBTableModel インタフェース内 TableWriter
        戻り値:
        DBTableModelオブジェクト
      • setHeaderSequence

        public void setHeaderSequence​(String hs)
        DBTableModelの出力順をセットします。 Name,Label,Size,Class,Data の各フィールドの頭文字のアルファベットで 出力順を設定します。 ※ 7.2.6.1 (2020/07/17) H:Header(ヘッダー)属性追加
        定義:
        setHeaderSequence インタフェース内 TableWriter
        パラメータ:
        hs - 出力順 (LNSCD など)
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
      • getHeaderSequence

        public String getHeaderSequence()
        DBTableModelの出力順を返します。 Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで 出力順を設定します。 なお,出力順に指定しない項目は出力されません
        定義:
        getHeaderSequence インタフェース内 TableWriter
        戻り値:
        出力順 (LNSCD など)
      • setSeparator

        public void setSeparator​(String sep)
        データを書き込む場合の,区切り文字をセットします。
        定義:
        setSeparator インタフェース内 TableWriter
        パラメータ:
        sep - 区切り文字
        変更履歴:
        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
      • getSeparator

        public String getSeparator()
        データを書き込む場合の,区切り文字を返します。
        戻り値:
        区切り文字
      • setAppend

        public void setAppend​(boolean flag)
        DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを設定します。 初期値は、false(新規モード)です。
        定義:
        setAppend インタフェース内 TableWriter
        パラメータ:
        flag - [true:追加モード/false:新規モード]
        変更履歴:
        3.5.4.2 (2003/12/15) 新規追加
      • isAppend

        public boolean isAppend()
        DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを取得します。 初期値は、false(新規モード)です。
        定義:
        isAppend インタフェース内 TableWriter
        戻り値:
        true(追加モード)/false(新規モード)
        変更履歴:
        3.5.4.2 (2003/12/15) 新規追加
      • setSheetName

        public void setSheetName​(String sheetName)
        DBTableModelのデータとして読み込むときのシート名を設定します。 初期値は、"Sheet1" です。 これは、EXCEL追加機能として実装されています。 ※ このクラスでは実装されていません。
        定義:
        setSheetName インタフェース内 TableWriter
        パラメータ:
        sheetName - シート名
        変更履歴:
        3.5.4.2 (2003/12/15) 新規追加, 3.5.4.3 (2004/01/05) 実装廃止(TableWriter_Excel へ移動), 6.0.2.0 (2014/09/19) isExcel() で判定しているので、Exception は投げない。
      • setRefSheetName

        public void setRefSheetName​(String sheetName)
        EXCEL雛型参考ファイルのシート名を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、雛型として参照するシート名を指定します。 これにより、複数の形式の異なるデータを順次書き出したり(appendモードを併用)する ことや、シートを指定して新規にEXCELを作成する場合にフォームを設定する事が可能になります。 初期値は、null(第一シート) です。 ※ このクラスでは実装されていません。
        定義:
        setRefSheetName インタフェース内 TableWriter
        パラメータ:
        sheetName - シート名
        変更履歴:
        3.5.4.3 (2004/01/05) 新規追加, 6.0.2.0 (2014/09/19) isExcel() で判定しているので、Exception は投げない。
      • isExcel

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

        public void setFilename​(String directory,
                                String filename)
        出力先ディレクトリとファイル名をセットします。 これは、EXCEL追加機能として実装されています。 ※ このクラスでは実装されていません。 このメソッドでは、必ず、UnsupportedOperationException が、throw されます。
        定義:
        setFilename インタフェース内 TableWriter
        パラメータ:
        directory - 出力先ディレクトリ名
        filename - 出力先ファイル名
        変更履歴:
        3.5.4.3 (2004/01/05) 新規作成, 6.0.2.0 (2014/09/19) ディレクトリとファイルを分けて管理します。
      • setRefFilename

        public void setRefFilename​(String filename)
        EXCEL雛型参考ファイル名をセットします。(DIR + Filename) これは、EXCEL追加機能として実装されています。 ※ このクラスでは実装されていません。 このメソッドでは、必ず、UnsupportedOperationException が、throw されます。
        定義:
        setRefFilename インタフェース内 TableWriter
        パラメータ:
        filename - EXCEL雛型参考ファイル名
        変更履歴:
        3.5.4.3 (2004/01/05) 新規作成, 6.0.2.0 (2014/09/19) isExcel() で判定しているので、Exception は投げない。
      • setSheetOverwrite

        public void setSheetOverwrite​(boolean flag)
        雛形のシート名を、そのまま使用する(true)か、新規、または、外部指定のシート名を使用する(false)を指定します。(初期値:false[外部指定のシート名を使用])。 ※ Ver5では、追記モード時に、指定シートが存在した場合は上書きします(初期値:false[上書きしない])。5.9.12.1 (2016/09/09) Ver6では、追記モード時に、雛形を指定できないため、雛形のシート名を、そのまま使用する(true)か、 新規、または、外部指定のシート名を使用する(false)を指定する属性になります。
        定義:
        setSheetOverwrite インタフェース内 TableWriter
        パラメータ:
        flag - 元のシート名を使用するかどうか[true:使用する/false:新規、または、外部指定のシート名を使用]
        変更履歴:
        6.5.0.0 (2016/09/30) sheetOverwrite で、雛形シートの使用時に、元のシート名を使用します。
      • setRecalcSheetName

        public void setRecalcSheetName​(String sheet)
        EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をCSV形式で指定します。
        定義:
        setRecalcSheetName インタフェース内 TableWriter
        パラメータ:
        sheet - 対象シート名をCSV形式で指定
        変更履歴:
        6.5.0.0 (2016/09/30) recalcSheetName で、セル内の計算式を再計算させるシート名を指定。5.9.12.1 (2016/09/09)
      • setFontName

        public void setFontName​(String fontName)
        EXCEL出力時のデフォルトフォント名を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトフォント名を指定します。 フォント名は、EXCELのフォント名をそのまま使用してください。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontName( String ) に設定されます。 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_NAME です。 ※ このクラスでは実装されていません。 このメソッドでは、必ず、UnsupportedOperationException が、throw されます。
        定義:
        setFontName インタフェース内 TableWriter
        パラメータ:
        fontName - フォント名
        変更履歴:
        3.8.5.3 (2006/08/07) 新規追加, 6.0.2.0 (2014/09/19) isExcel() で判定しているので、Exception は投げない。
      • setFontPoint

        public void setFontPoint​(short point)
        EXCEL出力時のデフォルトフォントポイント数を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトポイント数を指定します。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontHeightInPoints( short ) に設定されます。 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_POINTS です。 ※ このクラスでは実装されていません。 このメソッドでは、必ず、UnsupportedOperationException が、throw されます。
        定義:
        setFontPoint インタフェース内 TableWriter
        パラメータ:
        point - フォントポイント数
        変更履歴:
        3.8.5.3 (2006/08/07) 新規追加, 6.0.2.0 (2014/09/19) isExcel() で判定しているので、Exception は投げない。
      • setEncode

        public void setEncode​(String enc)
        読み取り元ファイルのエンコード文字列を指定します。 ファイルは、BufferedReader で受け取る為、本来は、エンコードは不要ですが、 固定長ファイルの読み取り時のバイトコード分割時に、指定のエンコードで 分割する必要があります。(例えば、半角文字は、Shift_JIS では、1バイト)
        定義:
        setEncode インタフェース内 TableWriter
        パラメータ:
        enc - ファイルのエンコード文字列
        変更履歴:
        3.5.4.5 (2004/01/23) 新規作成
      • getEncode

        protected String getEncode()
        読み取り元ファイルのエンコード文字列を取得します。 ファイルは、BufferedReader で受け取る為、本来は、エンコードは不要ですが、 固定長ファイルの読み取り時のバイトコード分割時に、指定のエンコードで 分割する必要があります。(例えば、半角文字は、Shift_JIS では、1バイト)
        戻り値:
        ファイルのエンコード文字列
        変更履歴:
        3.5.4.5 (2004/01/23) 新規作成
      • setUseNumber

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

        protected boolean isUseNumber()
        行番号情報を、出力する(true)/しない(false)を返します。 通常のフォーマットでは、各行の先頭に行番号を出力します。 これは、#NAME 属性を使用する場合には、必ず出力する必要があります。 (#NAME 属性は、読み取り時には、必須です。) この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力、 このシステムでは、#NAME 属性が出力されないため、読み込みできません。) この行番号を出力しないようにできます。 初期値は、true(出力する) です。
        戻り値:
        行番号情報を、出力する(true)/しない(false)
        変更履歴:
        3.7.0.2 (2005/02/14) 新規追加
      • setParam

        public void setParam​(List<HybsEntry> listParam)
        パラメーターリストをセットします。 内部は、HybsEntry クラスを持っています。 引数が、null の場合は、何もしません。 ※ このクラスでは実装されていません。
        定義:
        setParam インタフェース内 TableWriter
        パラメータ:
        listParam - パラメーターリスト
        変更履歴:
        4.0.0.0 (2005/01/31) 新規追加
      • setColumns

        public void setColumns​(String clms)
        出力先ファイルのカラム列を、外部(タグ)よりCSV形式の文字列で指定します。 ただし、指定のカラム名は、DBTableModel上に存在している必要があります。
        定義:
        setColumns インタフェース内 TableWriter
        パラメータ:
        clms - 出力先ファイルのカラム列(CSV形式)
        変更履歴:
        4.0.0.0 (2005/11/30) 新規追加
      • setOmitNames

        public void setOmitNames​(String clms)
        書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します。 指定するカラム名に対して、書き込み処理を行いません。 ここで指定するカラム名は、検索したDBTableModel上に含まれる必要はありません。 その場合は、ここでの指定は無視されます。
        定義:
        setOmitNames インタフェース内 TableWriter
        パラメータ:
        clms - 書き込み対象外のカラム列(CSV形式)
        変更履歴:
        6.1.0.0 (2014/12/26) omitNames 属性を追加
      • setSkipRowCount

        public void setSkipRowCount​(int skipRowCount)
        データの書き込み開始行番号を設定します(初期値:0)。 TAB区切りテキストやEXCEL等のデータの書き込みの開始行番号を指定します。 属性名は、行を飛ばす処理ということで、readTable タグと同じ名称です。 ファイルの先頭行が、0行としてカウントしますので、設定値は、読み飛ばす 件数になります。(1と指定すると、1件読み飛ばし、2行目から読み込みます。) 行の読み飛ばしと、カラムの読み飛ばし(columns)、refFileURL、refFilename、 refSheetName とともに使用すれば、ある程度のレイアウト設定が可能です。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setSkipRowCount インタフェース内 TableWriter
        パラメータ:
        skipRowCount - 書き込み開始行番号
        変更履歴:
        5.7.9.0 (2014/08/08) 新規作成, 6.0.2.0 (2014/09/19) isExcel() で判定しているので、Exception は投げない。
      • setUseCellStyle

        public void setUseCellStyle​(boolean useCellStyle)
        EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します。 データを書き込んでEXCELを作成しても、ノーマルのセルに値がセットされている だけなので、ある程度加工が必要です。 そこで、データのセットされたセルに罫線を入れることで、それなりのデータが 出力された感じになります。 この設定と、useAutoCellSize="true" で、セルの幅を自動調整すれば、見栄えが良くなります。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setUseCellStyle インタフェース内 TableWriter
        パラメータ:
        useCellStyle - 罫線を入れるかどうか(true:入れる/false:入れない)
        関連項目:
        setUseAutoCellSize( boolean )
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setUseAutoCellSize

        public void setUseAutoCellSize​(boolean useAutoCellSize)
        EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します。 データを書き込んでEXCELを作成しても、ノーマルのセルに値がセットされている だけなので、ある程度加工が必要です。 そこで、データのセットされたセルの幅を自動調整することで、それなりのデータが 出力された感じになります。 この設定と、useCellStyle="true" で、セルの罫線を自動設定すれば、見栄えが良くなります。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setUseAutoCellSize インタフェース内 TableWriter
        パラメータ:
        useAutoCellSize - データの幅に自動的に合わせるかどうか(true:自動調整/false:何もしない)
        関連項目:
        setUseCellStyle( boolean )
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setUseActiveWorkbook

        public void setUseActiveWorkbook​(boolean useActiveWorkbook)
        EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します。 セルの有効範囲というのは、EXCELでの 空行、空列の存在しない範囲を指します。 通常、空行でも、データとして残っている場合は、EXCELのセルオブジェクトは存在します。 ここで、useActiveWorkbook="true" とすると、空行、空列を削除します。 雛形を使用した場合は、データより多めに設定した計算などは、この処理で 削除されますので、データサイズにフィットさせることができます。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setUseActiveWorkbook インタフェース内 TableWriter
        パラメータ:
        useActiveWorkbook - セルの有効範囲を設定するかどうか(true:設定する/false:そのまま)
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setPageBreakColumn

        public void setPageBreakColumn​(String pageBreakColumn)
        EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)。 EXCEL帳票では、帳票雛形に、PAGE_BRAKE キーを設定しましたが、TableWriterでは、 メモリ上のカラムの値が変更したときに、シート変更させることができます。 このカラムの値がキーブレイクすると、新しいシートに書き出し始めます。 シート名は、このカラムの値(キーブレイクする値)です。 雛形ファイルを使用する場合、雛形シートもキーブレイクに伴って、+1されます。 つまり、雛形シートとデータシートは同時に変更されます。 ただし、雛形シートは、最後の雛形シートで止まります。 これは、雛形シートにヘッダー雛形とボディ雛形を用意しておき、最初のキーブレイクで ヘッダーからボディの書き込みにチェンジするイメージで使用できます。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setPageBreakColumn インタフェース内 TableWriter
        パラメータ:
        pageBreakColumn - シート変更するキーとなるカラム名を指定
        関連項目:
        setFileBreakColumn( String )
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setFileBreakColumn

        public void setFileBreakColumn​(String fileBreakColumn)
        EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)。 EXCEL帳票では、メモリ上のカラムの値が変更したときに、ファイル名を変更することができます。 このカラムの値がキーブレイクすると、新しいファイルに書き出し始めます。 ファイル名は、このカラムの値(キーブレイクする値)+ 元の出力ファイル名の拡張子(.xlsなど)です。 この設定を使用する場合は、出力ファイル名は無視されますが、拡張子だけは使用されます。 雛形ファイルを使用する場合、雛形ファイルもキーブレイクに伴って、再利用されます。 例えば、pageBreakColumn と併用する場合、キーブレイクで雛形シートも最初から適用になります。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setFileBreakColumn インタフェース内 TableWriter
        パラメータ:
        fileBreakColumn - ファイル名を変更するキーとなるカラム名を指定
        関連項目:
        setPageBreakColumn( String )
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setHyperLinkColumn

        public void setHyperLinkColumn​(String hyperLinkColumn)
        EXCEL出力時に、Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定します。 ここで、作成するハイパーリンクは、EXCELのシートに対するハイパーリンクです。 それ以外のリンク(本当のURLやファイル等)のリンクは(今は)作成できません。 ハイパーリンクを作成するには、①作成するカラム と ②作成する値 が必要です。 このメソッドで設定するのは、「①:②」という形式でカラム名を指定します。 ②がなければ、①と同じとします。 ②の値のシートの存在有無は、無視します。ハイパーリンクを作成するシートを作成する前に ハイパーリンクを作成するケースが存在します。 (例えば、各シートへのリンクを持った一覧を作成してから、明細の各シートを作成する様なケース) なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setHyperLinkColumn インタフェース内 TableWriter
        パラメータ:
        hyperLinkColumn - Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setAddTitleSheet

        public void setAddTitleSheet​(String sheetName)
        EXCEL出力時に、Sheet一覧を先頭Sheetに作成する場合のSheet名を指定します。 これは、Workbook に含まれる Sheet 一覧を作成する場合に、利用可能です。 なお、この機能は、TableWriter_Excel のみに実装します。
        定義:
        setAddTitleSheet インタフェース内 TableWriter
        パラメータ:
        sheetName - EXCELファイルのシート名
        変更履歴:
        6.0.2.0 (2014/09/19) 新規作成
      • setUseRenderer

        public void setUseRenderer​(boolean useRenderer)
        書込処理でコードリソースのラベル変換を行うかどうか[true/false]を指定します。 コードリソースをそのままの値で出力すると、数字や記号になり何が書かれているのか 不明になります。 これは、コードリソースをラベルに変換して出力するかどうかを指定します。 当然、コードはユニークですが、ラベルはユニークになるかどうか保障はされていませんので TableReader 系で読み込む場合には、リスクが発生します。 また、TableReader 系で読み込む場合にも、ラベルからコードを求める逆変換を行うように、 setUseRenderer メソッドで指定する必要があります。 従来は、TableWriter 系に、TableWriter_Renderer 系のクラスを作って対応していましたが、 このメソッドの属性値のフラグで、制御します。
        定義:
        setUseRenderer インタフェース内 TableWriter
        パラメータ:
        useRenderer - コードリソースのラベル変換を行うかどうか [true:行う/false:行わない]
        変更履歴:
        5.2.1.0 (2010/10/01) 新規作成
      • isUseRenderer

        protected boolean isUseRenderer()
        書き出し処理でコードリソースのラベル変換を行うかどうかを返します。 初期値は、false(行わない) です。
        戻り値:
        ラベル変換を行うかどうか(true:行う/false:行わない)
        変更履歴:
        5.2.1.0 (2010/10/01) 新規作成
      • quotation

        protected String quotation​(String data)
        データを ダブルコーテーション(")で囲みます。 この処理では、前後をダブルクオートで囲うため、改行の有無は判定する 必要はありません。 ダブルクオートを含む場合は、その直前にダブルクオートを強制的に追加します。
        パラメータ:
        data - 元のString文字列
        戻り値:
        ダブルコーテーションで囲まれた文字列
        このメソッドは、nullを返しません
      • quotation2

        protected String quotation2​(String data)
        データに対して 改行、ダブルクオート等の処理を行います。 これは、データの前後をダブルクオートで括る quotation(String)と異なり 前後には、ダブルクオート を追加しません。 ただし、以下の2つの条件で処理を行います。 1.改行を含む場合は、ダブルクオートを強制的に前後に追加する。 2.ダブルクオートを含む場合は、その直前にダブルクオートを強制的に追加する。
        パラメータ:
        data - 元のString文字列
        戻り値:
        改行、ダブルクオート等の処理
        変更履歴:
        5.2.2.0 (2010/11/01) 新規追加
      • checkParam

        protected void checkParam​(String key,
                                  Map<String,​String> keysMap)
        keys の整合性チェックを行います。 キーかkeysMapのどちらかが null の場合は、何もしません。 チェックするキーは、内部で大文字に変換しておきます。 keysMap に登録するキーは、大文字で登録しておいてください。 ここのチェックでは、キーマップに存在しなければ、エラーになります。
        パラメータ:
        key - チェックするキー文字列(null の場合は、処理しない)
        keysMap - 利用可能なキーのマップ(大文字に統一)
        変更履歴:
        5.6.6.1 (2013/07/12) keys の整合性チェックを行います。, 6.4.3.4 (2016/03/11) forループを、forEach メソッドに置き換えます。, 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"/>" 止めを、">" に変更します)。
      • setDebug

        public void setDebug​(boolean useDebug)
        デバッグ情報を出力するかどうか[true:する/false:しない]を指定します。 EXCELなどを書き出す場合、シートブレイクやファイルブレイク時の行番号が、検索時の行番号と 異なる為、エラー時の判定が難しくなります。 そこで、どうしてもわからなくなった場合に備えて、デバッグ情報を出力できるようにします。 通常は使用しませんので、設定を無視します。 初期値は、false:デバッグ情報を出力しない です。
        定義:
        setDebug インタフェース内 TableWriter
        パラメータ:
        useDebug - デバッグ出力するか [true:する/false:しない]
        変更履歴:
        6.1.0.0 (2014/12/26) デバッグ情報を出力するかどうかを指定
      • isDebug

        protected boolean isDebug()
        デバッグ情報を出力するかどうか[true:する/false:しない]を取得します。 EXCELなどを書き出す場合、シートブレイクやファイルブレイク時の行番号が、検索時の行番号と 異なる為、エラー時の判定が難しくなります。 そこで、どうしてもわからなくなった場合に備えて、デバッグ情報を出力できるようにします。
        戻り値:
        デバッグ出力 [true:する/false:しない]
        変更履歴:
        6.1.0.0 (2014/12/26) デバッグ情報を出力するかどうかを指定