org.opengion.plugin.io

## クラス TableWriter_Calc

- java.lang.Object
- - org.opengion.hayabusa.io.AbstractTableWriter
  - - org.opengion.plugin.io.TableWriter_Default
    - - org.opengion.plugin.io.TableWriter_Calc

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

      public class TableWriter_Calc
      extends TableWriter_Default

       Calcファイルの書き出しクラスです。

       DefaultTableWriter を継承していますので，ラベル，名前，データの出力部のみ
       オーバーライドして，OpenOfficeのCalcファイルの出力機能を実現しています。

  機能分類
    ファイル出力
  バージョン
    5.0
  作成者
    Hiroki Nakamura
  導入されたバージョン:
    JDK6.0,

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected org.odftoolkit.odfdom.doc.office.OdfOfficeAutomaticStyles` | `contentAutoStyles`
    `protected org.odftoolkit.odfdom.OdfFileDom` | `contentDom`
    `protected org.odftoolkit.odfdom.doc.office.OdfOfficeSpreadsheet` | `officeSpreadsheet`
    `protected org.odftoolkit.odfdom.doc.table.OdfTable` | `sheet`
    `protected boolean` | `useNumber`
    `protected org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument` | `wb`

    - ### クラスから継承されたフィールド org.opengion.hayabusa.io.AbstractTableWriter

      `BUFFER_MIDDLE, clmNo, CR, dbColumn, dbType, isKeyLbl, NUMBER, numberOfColumns, NVAR, STRING, table`

    - ### インタフェースから継承されたフィールド org.opengion.hayabusa.io.TableWriter

      `CSV_SEPARATOR, TAB_SEPARATOR`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `TableWriter_Calc()` デフォルトコンストラクター

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `protected org.odftoolkit.odfdom.doc.table.OdfTableCell` | `createTextCell(org.odftoolkit.odfdom.OdfFileDom contentDom, String content, Boolean isCellTypeNumber, Boolean isNumberList)` テキストコンテンツ用のセルを生成する。
    `boolean` | `isExcel()` このクラスが、Calc対応機能(=Excel対応機能)を持っているかどうかを返します。
    `protected void` | `resetAutoStylesAndMasterStyles()` デフォルトで用意されているStylesを調整します。
    `void` | `setFilename(String directory, String filename)` 出力先ディレクトリとファイル名をセットします。
    `void` | `setSheetName(String sheetName)` DBTableModelのデータとして読み込むときのシート名を設定します。
    `protected void` | `writeClass(DBTableModel table, PrintWriter writer)` PrintWriter に DBTableModelのクラス名情報を書き込みます。
    `protected void` | `writeData(DBTableModel table, PrintWriter writer)` PrintWriter に DBTableModelのテーブル情報を書き込みます。
    `void` | `writeDBTable()` DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。
    `protected void` | `writeLabel(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のサイズ情報を書き込みます。

    - ### クラスから継承されたメソッド org.opengion.plugin.io.TableWriter_Default

      `writeDBTable`

    - ### クラスから継承されたメソッド org.opengion.hayabusa.io.AbstractTableWriter

      `checkParam, createDBColumn, getDBTableModel, getEncode, getHeaderSequence, getSeparator, isAppend, isDebug, isUseNumber, isUseRenderer, quotation, quotation2, setAddTitleSheet, setAppend, setColumns, setDBTableModel, setDebug, setEncode, setFileBreakColumn, setFontName, setFontPoint, setHeaderSequence, setHyperLinkColumn, setOmitNames, setPageBreakColumn, setParam, setRefFilename, setRefSheetName, setSeparator, setSkipRowCount, setUseActiveWorkbook, setUseAutoCellSize, setUseCellStyle, setUseNumber, setUseRenderer, writeHeader`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

    - #### wb

          protected org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument wb

    - #### sheet

          protected org.odftoolkit.odfdom.doc.table.OdfTable sheet

    - #### contentDom

          protected org.odftoolkit.odfdom.OdfFileDom contentDom

    - #### officeSpreadsheet

          protected org.odftoolkit.odfdom.doc.office.OdfOfficeSpreadsheet officeSpreadsheet

    - #### contentAutoStyles

          protected org.odftoolkit.odfdom.doc.office.OdfOfficeAutomaticStyles contentAutoStyles

    - #### useNumber

          protected boolean useNumber

  - ### コンストラクタの詳細

    - #### TableWriter_Calc

          public TableWriter_Calc()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### writeDBTable

          public void writeDBTable()

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

    - #### writeLabel

          protected void writeLabel(DBTableModel table,
                                    PrintWriter writer)

      PrintWriter に DBTableModelのラベル情報を書き込みます。 第一カラム目は、ラベル情報を示す "#Label" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
      オーバーライド:
        `writeLabel` クラス内 `AbstractTableWriter`
      パラメータ:
        `table` - DBTableModelオブジェクト
        `writer` - PrintWriterオブジェクト
      変更履歴:

        6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加
        6.2.4.2 (2015/05/29) StringUtil#tagCut(String) をラベルに適用します。

    - #### writeName

          protected void writeName(DBTableModel table,
                                   PrintWriter writer)

      PrintWriter に DBTableModelの項目名情報を書き込みます。 第一カラム目は、項目名情報を示す "#Name" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
      オーバーライド:
        `writeName` クラス内 `AbstractTableWriter`
      パラメータ:
        `table` - DBTableModelオブジェクト
        `writer` - PrintWriterオブジェクト
      変更履歴:

        6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加

    - #### writeSize

          protected void writeSize(DBTableModel table,
                                   PrintWriter writer)

      PrintWriter に DBTableModelのサイズ情報を書き込みます。 第一カラム目は、サイズ情報を示す "#Size" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
      オーバーライド:
        `writeSize` クラス内 `AbstractTableWriter`
      パラメータ:
        `table` - DBTableModelオブジェクト
        `writer` - PrintWriterオブジェクト
      変更履歴:

        6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加

    - #### writeClass

          protected void writeClass(DBTableModel table,
                                    PrintWriter writer)

      PrintWriter に DBTableModelのクラス名情報を書き込みます。 第一カラム目は、サイズ情報を示す "#Class" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
      オーバーライド:
        `writeClass` クラス内 `AbstractTableWriter`
      パラメータ:
        `table` - DBTableModelオブジェクト
        `writer` - PrintWriterオブジェクト
      変更履歴:

        6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加

    - #### writeSeparator

          protected void writeSeparator(DBTableModel table,
                                        PrintWriter writer)

      PrintWriter に セパレーターを書き込みます。 第一カラム目は、サイズ情報を示す "#----" を書き込みます。 この行は、出力形式に無関係に、TableWriter.TAB_SEPARATOR で区切られます。
      オーバーライド:
        `writeSeparator` クラス内 `AbstractTableWriter`
      パラメータ:
        `table` - DBTableModelオブジェクト
        `writer` - PrintWriterオブジェクト

    - #### writeData

          protected void writeData(DBTableModel table,
                                   PrintWriter writer)

      PrintWriter に DBTableModelのテーブル情報を書き込みます。 このクラスでは，データを ダブルコーテーション(")で囲みます。 PrintWriter に DBTableModelのテーブル情報を書き込みます。
      オーバーライド:
        `writeData` クラス内 `TableWriter_Default`
      パラメータ:
        `table` - DBTableModelオブジェクト
        `writer` - PrintWriterオブジェクト
      変更履歴:

        5.2.1.0 (2010/10/01) useRenderer 対応
        6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加
        6.0.4.0 (2014/11/28) データ出力用のレンデラー

    - #### createTextCell

          protected org.odftoolkit.odfdom.doc.table.OdfTableCell createTextCell(org.odftoolkit.odfdom.OdfFileDom contentDom,
                                                                                String content,
                                                                                Boolean isCellTypeNumber,
                                                                                Boolean isNumberList)

      テキストコンテンツ用のセルを生成する。
      パラメータ:
        `contentDom` - OdfFileDomオブジェクト
        `content` - コンテンツ
        `isCellTypeNumber` - [true:数字型/false:文字型]
        `isNumberList` - [true:数字リスト=999/false:通常]
      戻り値:
        OpenOfficeのセルテーブルオブジェクト

    - #### resetAutoStylesAndMasterStyles

          protected void resetAutoStylesAndMasterStyles()

      デフォルトで用意されているStylesを調整します。 ※ここでは何もしません。

    - #### isExcel

          public boolean isExcel()

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

    - #### setFilename

          public void setFilename(String directory,
                                  String filename)

      出力先ディレクトリとファイル名をセットします。 これは、Calc追加機能として実装されています。 EXCELで使用することを主にしているため、ここでは、すぐに合成しておきます。
      定義:
        `setFilename` インタフェース内 `TableWriter`
      オーバーライド:
        `setFilename` クラス内 `AbstractTableWriter`
      パラメータ:
        `directory` - 出力先ディレクトリ名
        `filename` - Calc雛型参考ファイル名
      変更履歴:

        6.0.2.0 (2014/09/19) ディレクトリとファイルを分けて管理します。

    - #### setSheetName

          public void setSheetName(String sheetName)

      DBTableModelのデータとして読み込むときのシート名を設定します。 初期値は、"Sheet1" です。 これは、Calc追加機能として実装されています。
      定義:
        `setSheetName` インタフェース内 `TableWriter`
      オーバーライド:
        `setSheetName` クラス内 `AbstractTableWriter`
      パラメータ:
        `sheetName` - シート名

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