org.opengion.hayabusa.taglib

## クラス WriteTableTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.WriteTableTag

- すべての実装されたインタフェース:
    java.io.Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally

      public class WriteTableTag
      extends CommonTagSupport

       DBTableModelオブジェクトを指定のファイルに出力するタグです。

       データ(DBTableModel)と、コントローラ(WriteTableTagForm)を与えて、
       外部からコントロールすることで、各種形式で データ(DBTableModel)を表示できます。
       writeTableタグ に対して、コマンドを与えることにより、内部のコントローラの
       実装に対応した、 形式でデータを作成します。

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：
             <og:writeTable
                 fileURL   = "{@USER.ID}"    保存先ディレクトリ名
                 filename  = "{@filename}"   保存ファイル名
                 encode    = "UnicodeLittle"      保存ファイルエンコード名
             />

         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
           <og:writeTable
               writerClass        【TAG】実際に書き出すクラス名の略称(TableWriter_**** クラスの ****)を指定します
        									(初期値:TABLE_WRITER_DEFAULT_CLASS[=Excel])
               separator          【TAG】可変長ファイルを作成するときの項目区切り文字をセットします(初期値:TableWriter#TAB_SEPARATOR[= ])
               headerSequence     【TAG】DBTableModelの出力順(LNSCD など)をセットします
               fileURL            【TAG】ファイル保存先ディレクトリ名を指定します(初期値:FILE_URL[=filetemp/])
               filename           【TAG】ファイルを作成するときのファイル名をセットします(初期値:FILE_FILENAME[=file.xlsx])
               beforeDelete       【TAG】事前にファイルを削除するかどうかをセットします (初期値:false)
               encode             【TAG】ファイルを作成するときのファイルエンコーディング名をセットします(初期値:FILE_ENCODE[=UnicodeLittle])
               fileAppend         【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])
               zip                【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)
               zipFilename        【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")
               tableId            【TAG】(通常は使いません)sessionから所得する DBTableModelオブジェクトの ID
               scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)
               useNumber          【TAG】行番号情報を、出力する/しない[true/false]を指定します(初期値:true)
               columns            【TAG】書き込み先ファイルのカラム列を、外部(タグ)よりCSV形式で指定します
               omitNames          【TAG】書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します
               useRenderer        【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します
                                              (初期値:USE_TABLE_WRITER_RENDERER[=false])
               selectedAll        【TAG】チェック行のみを対象にするかを指定します(初期値:true)
           ※  sheetName          【TAG】EXCELファイルを書き出すときのシート名を設定します
           ※  refFileURL         【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします
           ※  refFilename        【TAG】EXCEL雛型参考ファイル名をセットします
           ※  refSheetName       【TAG】EXCEL雛型参考ファイルのシート名を設定します
           ※  sheetOverwrite     【TAG】EXCELでsheetNameでの指定シート名に対して上書きを行うかどうかを指定します。
           ※  recalcSheetName    【TAG】EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をCSV形式で指定します。
           ※  fontName           【TAG】EXCEL出力時のデフォルトフォント名を設定します
                                              (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[=ＭＳ Ｐゴシック])
           ※  fontPoint          【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します
                                              (初期値:TABLE_WRITER_DEFAULT_FONT_POINTS[=11])
           ※  skipRowCount       【TAG】(通常は使いません)EXCEL出力時のデータの書き込み開始位置を設定します
           ※  useCellStyle       【TAG】EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します(初期値:false)
           ※  useAutoCellSize    【TAG】EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します(初期値:false)
           ※  useActiveWorkbook  【TAG】EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します(初期値:false)
           ※  pageBreakColumn    【TAG】EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)
           ※  fileBreakColumn    【TAG】EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)
           ※  hyperLinkColumn    【TAG】EXCEL出力時に、Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定します
           ※  addTitleSheet      【TAG】EXCEL出力時に、存在するSheet名一覧を作成する場合に、そのSheet名を指定します。
               language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
               caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
               caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
               caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
               caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
               caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           >   ... Body ...
           </og:writeTable>

         【廃止】6.9.5.0 (2018/04/23) 物理削除
           //  direct             【廃止】結果をダイレクトにEXCEL起動するかどうか[true/false]を指定します(初期値:false[ファイル])  6.9.5.0 (2018/04/23) 物理削除
           //  disposition        【廃止】Content-Disposition (inline:埋め込む/attachment:ダイアログを起動)を指定します(初期値:attachment)  6.9.5.0 (2018/04/23) 物理削除

         ●使用例
             <og:writeTable ･････ >
                 <og:writeTableParam
                     key  = "Tablename"  value="GE12"
                 />
                 <og:writeTableParam
                     key  = "First"             First:最初に登録
                 >
                              insert into GE12bk
                                 select * from GE12
                                 where SYSTEM_ID='**'
                 </og:writeTableParam
                 <og:writeTableParam
                     key  = "First"             First:の２番目に登録
                 >
                      delete from GE12 where SYSTEM_ID='**' and KBSAKU='0'
                 </og:writeTableParam
                 <og:writeTableParam
                     key  = "Last"              Last:最後に登録
                 >
                      update GE12 set XXXX='YYYY' where SYSTEM_ID='**' and KBSAKU='0'
                 </og:writeTableParam
             </og:writeTableParam

  機能分類
    ファイル出力
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

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

      `BR, BUFFER_MIDDLE, CR`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.BodyTagSupport

      `bodyContent`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.TagSupport

      `id, pageContext`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.BodyTag

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `protected void` | `addParam(HybsEntry entry)` WriteTable オブジェクトに渡すパラメータオブジェクトをセットします。
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setAddTitleSheet(java.lang.String sheetName)` 【TAG】EXCEL出力時に、Sheet一覧を作成する場合のSheet名を指定します。
    `void` | `setBeforeDelete(java.lang.String flag)` 【TAG】事前にファイルを削除するかどうかを指定します(初期値:false)。
    `void` | `setColumns(java.lang.String clms)` 【TAG】書き込み先ファイルのカラム列を、外部(タグ)よりCSV形式で指定します。
    `void` | `setEncode(java.lang.String enc)` 【TAG】ファイルを作成するときのファイルエンコーディング名をセットします (初期値:FILE_ENCODE[=])。
    `void` | `setFileAppend(java.lang.String flag)` 【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])。
    `void` | `setFileBreakColumn(java.lang.String fbColumn)` 【TAG】EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)。
    `void` | `setFilename(java.lang.String filename)` 【TAG】ファイルを作成するときのファイル名をセットします (初期値:FILE_FILENAME[=])。
    `void` | `setFileURL(java.lang.String url)` 【TAG】ファイル保存先ディレクトリ名を指定します (初期値:FILE_URL[=])。
    `void` | `setFontName(java.lang.String name)` 【TAG】EXCEL出力時のデフォルトフォント名を設定します (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[=])。
    `void` | `setFontPoint(java.lang.String point)` 【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します (初期値:TABLE_WRITER_DEFAULT_FONT_POINTS[=])。
    `void` | `setHeaderSequence(java.lang.String hs)` 【TAG】DBTableModelの出力順(LNSCD など)をセットします。
    `void` | `setHyperLinkColumn(java.lang.String hlColumn)` 【TAG】EXCEL出力時に、Hyperlinkを作成するキーとなる「カラム名:値」形式のカラム名を指定します。
    `void` | `setOmitNames(java.lang.String clms)` 【TAG】書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します。
    `void` | `setPageBreakColumn(java.lang.String pbColumn)` 【TAG】EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)。
    `void` | `setRecalcSheetName(java.lang.String sheet)` 【TAG】EXCELで、出力処理の最後に、セル内の計算式を再計算させるシート名をCSV形式で指定します。
    `void` | `setRefFilename(java.lang.String filename)` 【TAG】EXCEL雛型参考ファイル名をセットします。
    `void` | `setRefFileURL(java.lang.String url)` 【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします (初期値:FILE_URL[=])。
    `void` | `setRefSheetName(java.lang.String sheet)` 【TAG】EXCEL雛型参考ファイルのシート名を設定します。
    `void` | `setSelectedAll(java.lang.String flag)` 【TAG】チェック行のみを対象にするかを指定します(初期値:true)。
    `void` | `setSeparator(java.lang.String separator)` 【TAG】可変長ファイルを作成するときの項目区切り文字をセットします (初期値:TableWriter#TAB_SEPARATOR[=])。
    `void` | `setSheetName(java.lang.String sheet)` 【TAG】EXCELファイルを書き出すときのシート名を設定します(初期値:Sheet1)。
    `void` | `setSheetOverwrite(java.lang.String flag)` 【TAG】雛形のシート名を、そのまま使用する(true)か、新規、または、外部指定のシート名を使用する(false)を指定します。
    `void` | `setSkipRowCount(java.lang.String count)` 【TAG】(通常は使いません)EXCEL出力時のデータの書き込み開始行番号を設定します(初期値:0)。
    `void` | `setTableId(java.lang.String id)` 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])。
    `void` | `setUseActiveWorkbook(java.lang.String useActWB)` 【TAG】EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します(初期値:false)。
    `void` | `setUseAutoCellSize(java.lang.String useAutoSize)` 【TAG】EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します(初期値:false)。
    `void` | `setUseCellStyle(java.lang.String useStyle)` 【TAG】EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します(初期値:false)。
    `void` | `setUseNumber(java.lang.String useNo)` 【TAG】ファイル出力時に、行番号情報を、出力する/しない[true/false]を指定します(初期値:true)。
    `void` | `setUseRenderer(java.lang.String flag)` 【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します (初期値:USE_TABLE_WRITER_RENDERER[=])。
    `void` | `setWriterClass(java.lang.String writerClass)` 【TAG】実際に書き出すクラス名の略称()を指定します (初期値:TABLE_WRITER_DEFAULT_CLASS[=])。
    `void` | `setZip(java.lang.String flag)` 【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)。
    `void` | `setZipFilename(java.lang.String zipFile)` 【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

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

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.BodyTagSupport

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport

      `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

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

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

    - ### インタフェースから継承されたメソッド javax.servlet.jsp.tagext.Tag

      `getParent, setPageContext, setParent`

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

    - #### WriteTableTag

          public WriteTableTag()

      デフォルトコンストラクター
      変更履歴:
        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
        `doStartTag` インタフェース内 `Tag`
      オーバーライド:
        `doStartTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示( EVAL_BODY_BUFFERED )
      変更履歴:
        5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか（beforeDelete）フラグを追加, 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加, 6.0.4.0 (2014/11/28) Zipファイル名を、内部変数化。(将来的に引数化を容易にするため)

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:
        2.1.3.1 (2002/12/13) ContentType を、x-msexcel から vnd.ms-excel に変更した。, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。, 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。, 3.2.0.0 (2003/05/22) GZIPOutputStream を使用していたが、ZipOutputStream に変更。, 3.5.4.1 (2003/12/01) 引数の PrintWriter を、OutputStream に変更。, 3.5.4.3 (2004/01/05) 引数を、 PrintWriter に戻す。, 3.6.0.2 (2004/10/04) EXCELダイレクト出力時にファイルエンドまで出力されない不具合対策, 3.8.0.9 (2005/10/17) disposition属性を使用できるように変更します。, 3.8.6.0 (2006/08/23) フォルダがない場合は、複数階層分のフォルダを自動で作成します。, 4.3.4.3 (2008/12/22) Excel出力の判別方法を前方一致に変更, 5.1.6.0 (2010/05/01) 画面帳票作成機能対応, 5.5.2.0 (2012/05/01) ZIP時にもencodeが有効にする, 5.5.5.5 (2012/08/24) selectedAllの処理を追加, 5.5.9.1 (2012/12/07) beforeDeleteフラグの追加に伴う、ロジック変更, 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加, 6.0.4.0 (2014/11/28) Zip処理を、ZipOutputStream → ZipArchiveOutputStream に変更, 6.2.0.0 (2015/02/27) EXCEL出力のparamLevel初期値変更 3:標準推奨 → 4:個人設定可, 6.9.5.0 (2018/04/23) direct 廃止(false固定)

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`
      変更履歴:
        2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。, 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。, 3.5.4.2 (2003/12/15) EXCELのシート名を指定できるように変更。, 3.5.4.3 (2004/01/05) EXCEL雛型参照ファイルのURL,filenameを追加します。, 3.8.5.3 (2006/08/07) writerClass 属性の初期値をシステムリソースより取得します。, 3.8.5.3 (2006/08/07) fontName 属性を追加します。, 3.8.5.3 (2006/08/07) fontPoint 属性を追加します。, 3.8.6.0 (2006/08/23) directory 属性を追加します。, 4.0.0.0 (2005/02/28) XMLファイルにセットする、param を追加。, 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか useRenderer 属性追加, 5.5.5.5 (2012/08/24) selectedAll属性を追加, 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。互換性のため、false に設定。推奨は、true, 5.7.9.0 (2014/08/08) データの書き込み開始位置(skipRowCount)を設定, 6.0.2.0 (2014/09/19) EXCEL関係機能追加(useCellStyle,useAutoCellSize,useActiveWorkbook, pageBreakColumn,fileBreakColumn,hyperLinkColumn,addTitleSheet), 6.0.4.0 (2014/11/28) zipFilename属性を追加。, 6.1.0.0 (2014/12/26) omitNames 属性を追加, 6.2.0.0 (2015/02/27) EXCEL出力のparamLevel初期値変更 3:標準推奨 → 4:個人設定可, 5.9.12.1 (2016/09/09) sheetOverwrite で、雛形シートの使用時に、元のシート名を使用します。, 6.9.5.0 (2018/04/23) direct 廃止(false固定)

    - #### setTableId

          public void setTableId(java.lang.String id)

      【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])。
      パラメータ:
        `id` - テーブルID (sessionに登録する時のID)
      説明:
        検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 渡す場合に、通常は、session を利用します。その場合の登録キーです。 query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 この tableId 属性を利用して、メモリ空間を分けます。 (初期値:HybsSystem#TBL_MDL_KEY[=])。

    - #### setSeparator

          public void setSeparator(java.lang.String separator)

      【TAG】可変長ファイルを作成するときの項目区切り文字をセットします (初期値:TableWriter#TAB_SEPARATOR[=])。
      パラメータ:
        `separator` - 項目区切り文字
      関連項目:
        `TableWriter.TAB_SEPARATOR`
      説明:
        可変長ファイルを作成するときの項目区切り文字をセットします。 (初期値:TableWriter#TAB_SEPARATOR[=])。

    - #### setHeaderSequence

          public void setHeaderSequence(java.lang.String hs)

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

    - #### setFileURL

          public void setFileURL(java.lang.String url)

      【TAG】ファイル保存先ディレクトリ名を指定します (初期値:FILE_URL[=])。
      パラメータ:
        `url` - 保存先ディレクトリ名
      説明:
        この属性で指定されるディレクトリに、ファイルをセーブします。 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、２文字目が、 ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、 システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。 fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、 さらに、各個人ID別のフォルダを作成して、そこにセーブします。
      変更履歴:
        3.5.4.3 (2004/01/05) 内部処理を、makeFileURL に移動。, 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用, 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。, 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。

    - #### setFilename

          public void setFilename(java.lang.String filename)

      【TAG】ファイルを作成するときのファイル名をセットします (初期値:FILE_FILENAME[=])。
      パラメータ:
        `filename` - ファイル名
      関連項目:
        `SystemData.FILE_FILENAME`
      説明:
        ファイルを作成するときのファイル名をセットします。 (初期値:システム定数のFILE_ENCODE[=])。

    - #### setSheetName

          public void setSheetName(java.lang.String sheet)

      【TAG】EXCELファイルを書き出すときのシート名を設定します(初期値:Sheet1)。
      パラメータ:
        `sheet` - シート名
      説明:
        EXCELファイルを書き出す時に、シート名を指定します。これにより、複数の形式の 異なるデータを順次書き出したり(appendモードを併用)することや、シートを指定して 新規にEXCELを作成することが可能になります。 初期値は、Sheet1 です。
      変更履歴:
        3.5.4.2 (2003/12/15) 新規追加

    - #### setEncode

          public void setEncode(java.lang.String enc)

      【TAG】ファイルを作成するときのファイルエンコーディング名をセットします (初期値:FILE_ENCODE[=])。
      パラメータ:
        `enc` - エンコーディング名 (例:DEFAULT,JISAutoDetect,JIS,EUC_JP,MS932,SJIS,Windows-31J,Shift_JIS)
      関連項目:
        IANA Charset Registry, `SystemData.FILE_ENCODE`
      説明:
        "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS" (初期値:システム定数のFILE_ENCODE[=])。
      変更履歴:
        2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更, 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。

    - #### setWriterClass

          public void setWriterClass(java.lang.String writerClass)

      【TAG】実際に書き出すクラス名の略称()を指定します (初期値:TABLE_WRITER_DEFAULT_CLASS[=])。
      パラメータ:
        `writerClass` - クラス名(の略称)
      関連項目:
        `TableWriterのサブクラス`
      説明:
        実際に書き出すクラス名(の略称)をセットします。 org.opengion.hayabusa.io.TableWriter インターフェースを継承したサブクラスです。 これは、org.opengion.plugin.io 以下の TableWriter_**** クラスの **** を与えます。 属性クラス定義の `TableWriter` を参照願います。 ExcelRenderer と、Renderer は、特別な名前で、useRenderer 属性に、"true" をセットするのと同じ効果があります。 実際は、ExcelRenderer ⇒ Excel 、Renderer ⇒ Default のクラスが呼ばれます。 (初期値:TABLE_WRITER_DEFAULT_CLASS[=])。

    - #### setFileAppend

          public void setFileAppend(java.lang.String flag)

      【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])。
      パラメータ:
        `flag` - 追加モードか [true:追加モード/それ以外:新規モード]
      説明:
        DBTableModelのファイルを、追加モードで書き込むかどうかをセットします。

    - #### setZip

          public void setZip(java.lang.String flag)

      【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
        `flag` - ZIPで圧縮する [true:圧縮する/それ以外:しない]
      説明:
        初期値は、圧縮しないです。

    - #### setZipFilename

          public void setZipFilename(java.lang.String zipFile)

      【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")。
      パラメータ:
        `zipFile` - ZIPファイル名
      関連項目:
        `setZip( String )`
      説明:
        zip 属性に、true を指定した場合に、ZIPファイル化します。その場合のファイル名を指定します。 なにも指定しない場合は、filename + ".zip" になります。
      変更履歴:
        6.0.4.0 (2014/11/28) Zipファイル名を外部から与えられるように修正

    - #### setRefFileURL

          public void setRefFileURL(java.lang.String url)

      【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします (初期値:FILE_URL[=])。
      パラメータ:
        `url` - 雛型ﾃﾞｨﾚｸﾄﾘ名
      説明:
        この属性で指定されるディレクトリに、ファイルをセーブします。 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、２文字目が、 ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、 システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。 fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、 さらに、各個人ID別のフォルダを作成して、そこにセーブします。
      変更履歴:
        3.5.4.3 (2004/01/05) 新規作成, 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用, 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。, 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。

    - #### setRefFilename

          public void setRefFilename(java.lang.String filename)

      【TAG】EXCEL雛型参考ファイル名をセットします。
      パラメータ:
        `filename` - 雛型ﾌｧｲﾙ名
      説明:
        内部処理的には、雛形ファイルの雛形シートをメモリ上に構築し、 そのシートのセルに、データを追加していきます。 最後には、雛形シートとして存在しない部分は、すべて削除します。 雛形シートを使わない場合は、新規シートに追加していくことになります。 appendモードの場合は、オリジナルが雛形ファイルになります。 雛形ファイルの指定は、無効になります。 ※ 互換性の為、同じ名前の設定は有効です。 ※ Excel2007形式(XSSF)では、行全体を指定した色や罫線は、 セルとして認識されません。範囲指定で、罫線や色付けを行う必要があります。
      変更履歴:
        3.5.4.3 (2004/01/05) 新規作成

    - #### setRefSheetName

          public void setRefSheetName(java.lang.String sheet)

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

    - #### setSheetOverwrite

          public void setSheetOverwrite(java.lang.String flag)

      【TAG】雛形のシート名を、そのまま使用する(true)か、新規、または、外部指定のシート名を使用する(false)を指定します。(初期値:false[外部指定のシート名を使用])。
      パラメータ:
        `flag` - 元のシート名を使用するかどうか [true:使用する/false:新規、または、外部指定のシート名を使用]
      説明:
        ※ Ver5では、追記モード時に、指定シートが存在した場合は上書きします(初期値:false[上書きしない])。5.9.12.1 (2016/09/09) Ver6では、追記モード時に、雛形を指定できないため、雛形のシート名を、そのまま使用する(true)か、 新規、または、外部指定のシート名を使用する(false)を指定する属性になります。
      変更履歴:
        6.5.0.0 (2016/09/30) sheetOverwrite で、雛形シートの使用時に、元のシート名を使用します。

    - #### setRecalcSheetName

          public void setRecalcSheetName(java.lang.String sheet)

      【TAG】EXCELで、出力処理の最後に、セル内の計算式を再計算させるシート名をCSV形式で指定します。
      パラメータ:
        `sheet` - 対象シート名(CSV形式文字)
      説明:
        通常は利用する必要はありません。 一覧結果を利用した集計用シートを別に持っているような雛形を利用した出力で利用します。
      変更履歴:
        6.5.0.0 (2016/09/30) recalcSheetName で、セル内の計算式を再計算させるシート名を指定。5.9.12.1 (2016/09/09)

    - #### setFontName

          public void setFontName(java.lang.String name)

      【TAG】EXCEL出力時のデフォルトフォント名を設定します (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[=])。
      パラメータ:
        `name` - デフォルトフォント名
      関連項目:
        `SystemData.TABLE_WRITER_DEFAULT_FONT_NAME`
      説明:
        これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトフォント名を指定します。 フォント名は、EXCELのフォント名をそのまま使用してください。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontName( String ) に設定されます。 (初期値:システム定数のTABLE_WRITER_DEFAULT_FONT_NAME[=])。
      変更履歴:
        3.8.5.3 (2006/08/07) 新規追加

    - #### setFontPoint

          public void setFontPoint(java.lang.String point)

      【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します (初期値:TABLE_WRITER_DEFAULT_FONT_POINTS[=])。
      パラメータ:
        `point` - フォントポイント数
      関連項目:
        `SystemData.TABLE_WRITER_DEFAULT_FONT_POINTS`
      説明:
        これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトポイント数を指定します。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontHeightInPoints( short ) に設定されます。 (初期値:システム定数のTABLE_WRITER_DEFAULT_FONT_POINTS[=])。
      変更履歴:
        3.8.5.3 (2006/08/07) 新規追加

    - #### setUseNumber

          public void setUseNumber(java.lang.String useNo)

      【TAG】ファイル出力時に、行番号情報を、出力する/しない[true/false]を指定します(初期値:true)。
      パラメータ:
        `useNo` - 行番号情報 [true:出力する/false:しない]
      説明:
        通常のフォーマットでは、各行の先頭に行番号を出力します。 これは、#NAME 属性を使用する場合には、必ず出力する必要があります。 (#NAME 属性は、読み取り時にあれば、自動的にカラムに割り当てられます。) この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力等) の為に出力する場合に、false を設定することで、行番号列を出力しない ようにできます。 初期値は、true(出力する) です。
      変更履歴:
        3.7.0.2 (2005/02/14) 新規追加

    - #### setColumns

          public void setColumns(java.lang.String clms)

      【TAG】書き込み先ファイルのカラム列を、外部(タグ)よりCSV形式で指定します。
      パラメータ:
        `clms` - 書込カラム列 (CSV形式)
      説明:
        この指定により、書き込むカラムを限定的に使用することが可能です。 カラム名は、検索したDBTableModel上に含まれる名前で指定する必要があります。 別名で書き込みたい場合は、予めその名前で検索しておく必要があります。 カラム名を指定しない場合(例えば ,,, など)は、カラムを書き飛ばします。
      変更履歴:
        4.0.0.0 (2005/12/31) 新規作成

    - #### setOmitNames

          public void setOmitNames(java.lang.String clms)

      【TAG】書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します。
      パラメータ:
        `clms` - 書込対象外カラム列 (CSV形式)
      説明:
        指定するカラム名に対して、書き込み処理を行いません。 ここで指定するカラム名は、検索したDBTableModel上に含まれる必要はありません。 その場合は、ここでの指定は無視されます。
      変更履歴:
        6.1.0.0 (2014/12/26) omitNames 属性を追加

    - #### setUseRenderer

          public void setUseRenderer(java.lang.String flag)

      【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します (初期値:USE_TABLE_WRITER_RENDERER[=])。
      パラメータ:
        `flag` - ラベル変換可否 [true:する/false:しない]
      関連項目:
        `SystemData.USE_TABLE_WRITER_RENDERER`
      説明:
        コードリソースをそのままの値で出力すると、数字や記号になり何が書かれているのか 不明になります。 これは、コードリソースをラベルに変換して出力するかどうかを指定します。 当然、コードはユニークですが、ラベルはユニークになるかどうか保障はされていませんので TableReader 系で読み込む場合には、リスクが発生します。 また、TableReader 系で読み込む場合にも、ラベルからコードを求める逆変換を行うように、 setUseRenderer メソッドで指定する必要があります。 従来は、TableWriter 系に、TableWriter_Renderer 系のクラスを作って対応していましたが、 このメソッドの属性値のフラグで、制御します。 (初期値:システム定数のUSE_TABLE_WRITER_RENDERER[=])。
      変更履歴:
        5.2.1.0 (2010/10/01) 新規作成

    - #### setSkipRowCount

          public void setSkipRowCount(java.lang.String count)

      【TAG】(通常は使いません)EXCEL出力時のデータの書き込み開始行番号を設定します(初期値:0)。
      パラメータ:
        `count` - 書き込み開始行番号
      説明:
        EXCELのデータの書き込みの開始行番号を指定します。 属性名は、行を飛ばす処理ということで、readTable タグと同じ名称です。 ファイルの先頭行が、０行としてカウントしますので、設定値は、読み飛ばす 件数になります。(１と指定すると、１行読み飛ばし、２行目から読み込みます。) 行の読み飛ばしと、カラムの読み飛ばし(columns)、refFileURL、refFilename、 refSheetName とともに使用すれば、ある程度のレイアウト設定が可能です。 現時点では、Excel の場合のみ有効です。
      変更履歴:
        5.7.9.0 (2014/08/08) 新規作成

    - #### setUseCellStyle

          public void setUseCellStyle(java.lang.String useStyle)

      【TAG】EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します(初期値:false)。
      パラメータ:
        `useStyle` - 罫線追記 [true:する/false:しない]
      関連項目:
        `setUseAutoCellSize( String )`
      説明:
        データを書き込んでEXCELを作成しても、ノーマルのセルに値がセットされている だけなので、ある程度加工が必要です。 そこで、データのセットされたセルに罫線を入れることで、それなりのデータが 出力された感じになります。 この設定と、useAutoCellSize="true" で、セルの幅を自動調整すれば、見栄えが良くなります。 なお、この機能は、TableWriter_Excel のみに実装します。
      変更履歴:
        6.0.2.0 (2014/09/19) 新規作成

    - #### setUseAutoCellSize

          public void setUseAutoCellSize(java.lang.String useAutoSize)

      【TAG】EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します(初期値:false)。
      パラメータ:
        `useAutoSize` - 幅の自動的調整 [true:する/false:しない]
      関連項目:
        `setUseCellStyle( String )`
      説明:
        データを書き込んでEXCELを作成しても、ノーマルのセルに値がセットされている だけなので、ある程度加工が必要です。 そこで、データのセットされたセルの幅を自動調整することで、それなりのデータが 出力された感じになります。 この設定と、useCellStyle="true" で、セルの罫線を自動設定すれば、見栄えが良くなります。 なお、この機能は、TableWriter_Excel のみに実装します。
      変更履歴:
        6.0.2.0 (2014/09/19) 新規作成

    - #### setUseActiveWorkbook

          public void setUseActiveWorkbook(java.lang.String useActWB)

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

    - #### setPageBreakColumn

          public void setPageBreakColumn(java.lang.String pbColumn)

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

    - #### setFileBreakColumn

          public void setFileBreakColumn(java.lang.String fbColumn)

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

    - #### setHyperLinkColumn

          public void setHyperLinkColumn(java.lang.String hlColumn)

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

    - #### setAddTitleSheet

          public void setAddTitleSheet(java.lang.String sheetName)

      【TAG】EXCEL出力時に、Sheet一覧を作成する場合のSheet名を指定します。
      パラメータ:
        `sheetName` - タイトルシート名
      説明:
        これは、Workbook に含まれる Sheet 一覧を作成する場合に、利用可能です。 なお、この機能は、TableWriter_Excel のみに実装します。
      変更履歴:
        6.0.2.0 (2014/09/19) 新規作成

    - #### setSelectedAll

          public void setSelectedAll(java.lang.String flag)

      【TAG】チェック行のみを対象にするかを指定します(初期値:true)。
      パラメータ:
        `flag` - 対象にするか [true:全件/false:対象のみ]
      説明:
        falseを指定する事で、前画面でチェックした行のみを出力します。 初期値は全ての行を出力(true)です。 出力されるファイルの行番号は、1から振りなおされます。
      変更履歴:
        5.5.5.5 (2012/08/24) 新規作成

    - #### setBeforeDelete

          public void setBeforeDelete(java.lang.String flag)

      【TAG】事前にファイルを削除するかどうかを指定します(初期値:false)。
      パラメータ:
        `flag` - 事前削除するかどうか [true:削除する/false:削除しない]
      説明:
        出力元の DBTableModel が、存在しないか、０件の場合、過去に作成したファイルが そのまま、残っていると、不要なトラブルのもととなる為、実行前に削除するか どうかを指定できます。 なお、fileAppend="true"（追加モードで書き込むを指定)時には、データが０件でも 事前削除は行いません。 初期値は互換性のため削除しない(false)です。
      変更履歴:
        5.5.9.1 (2012/12/07) 新規作成

    - #### addParam

          protected void addParam(HybsEntry entry)

      WriteTable オブジェクトに渡すパラメータオブジェクトをセットします。 WriteTableParamTag クラスよりセットされます。
      パラメータ:
        `entry` - HybsEntryオブジェクト
      変更履歴:
        4.0.0.0 (2005/02/28) 新規追加

    - #### toString

          public java.lang.String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現
      このメソッドは、nullを返しません

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