001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.hayabusa.taglib;
017
018import org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.hayabusa.common.HybsSystemException;
020import org.opengion.hayabusa.db.DBTableModel;
021import org.opengion.hayabusa.io.TableWriter;
022import org.opengion.fukurou.util.FileUtil;
023import org.opengion.fukurou.util.HybsEntry;
024import org.opengion.fukurou.system.Closer ;
025import org.opengion.fukurou.util.StringUtil ;
026import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
027
028import static org.opengion.fukurou.util.StringUtil.nval ;
029
030// import jakarta.servlet.ServletResponse ;
031// import jakarta.servlet.http.HttpServletResponse ;
032// import jakarta.servlet.jsp.JspWriter ;
033
034import java.util.List;
035import java.util.ArrayList;
036import java.util.Locale;
037import java.io.File;
038import java.io.OutputStream;
039import java.io.PrintWriter;
040import java.io.FileOutputStream;
041import java.io.BufferedOutputStream;                            // 6.0.4.0 (2014/11/28)
042import java.io.ByteArrayOutputStream;
043import java.io.IOException;
044import java.io.InputStream;                                                     // 6.0.4.0 (2014/11/28)
045import java.io.FileInputStream;                                         // 6.0.4.0 (2014/11/28)
046import java.io.BufferedInputStream;                                     // 6.0.4.0 (2014/11/28)
047
048import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;                       // 6.0.4.0 (2014/11/28)
049import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;        // 6.0.4.0 (2014/11/28)
050import org.apache.commons.compress.utils.IOUtils;                                                       // 6.0.4.0 (2014/11/28)
051
052/**
053 * DBTableModelオブジェクトを指定のファイルに出力するタグです。
054 *
055 * データ(DBTableModel)と、コントローラ(WriteTableTagForm)を与えて、
056 * 外部からコントロールすることで、各種形式で データ(DBTableModel)を表示できます。
057 * writeTableタグ に対して、コマンドを与えることにより、内部のコントローラの
058 * 実装に対応した、 形式でデータを作成します。
059 *
060 * @og.formSample
061 * ●形式:
062 *     <og:writeTable
063 *         fileURL   = "{@USER.ID}"    保存先ディレクトリ名
064 *         filename  = "{@filename}"   保存ファイル名
065 *         encode    = "UnicodeLittle"      保存ファイルエンコード名
066 *     />
067 *
068 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
069 *
070 * ●Tag定義:
071 *   <og:writeTable
072 *       writerClass        【TAG】実際に書き出すクラス名の略称(TableWriter_**** クラスの ****)を指定します
073 *                                                                      (初期値:TABLE_WRITER_DEFAULT_CLASS[={@og.value SystemData#TABLE_WRITER_DEFAULT_CLASS}])
074 *       separator          【TAG】可変長ファイルを作成するときの項目区切り文字をセットします(初期値:TableWriter#TAB_SEPARATOR[= ])
075 *       headerSequence     【TAG】DBTableModelの出力順(LNSCD など)をセットします。(7.2.6.1 (2020/07/17) H追加)
076 *       fileURL            【TAG】ファイル保存先ディレクトリ名を指定します(初期値:FILE_URL[={@og.value SystemData#FILE_URL}])
077 *       baseURL            【TAG】ファイル保存先ディレクトリ名を指定します(初期値:コンテキストパス) 7.2.7.0 (2020/08/07)
078 *       filename           【TAG】ファイルを作成するときのファイル名をセットします(初期値:FILE_FILENAME[={@og.value SystemData#FILE_FILENAME}])
079 *       beforeDelete       【TAG】事前にファイルを削除するかどうかをセットします (初期値:false)
080 *       encode             【TAG】ファイルを作成するときのファイルエンコーディング名をセットします(初期値:FILE_ENCODE[={@og.value SystemData#FILE_ENCODE}])
081 *       fileAppend         【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])
082 *       zip                【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)
083 *       zipFilename        【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")
084 *       tableId            【TAG】(通常は使いません)sessionから所得する DBTableModelオブジェクトの ID
085 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)
086 *       useNumber          【TAG】行番号情報を、出力する/しない[true/false]を指定します(初期値:true)
087 *       columns            【TAG】書き込み先ファイルのカラム列を、外部(タグ)よりCSV形式で指定します
088 *       omitNames          【TAG】書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します
089 *       useRenderer        【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します
090 *                                      (初期値:USE_TABLE_WRITER_RENDERER[={@og.value SystemData#USE_TABLE_WRITER_RENDERER}])
091 *       selectedAll        【TAG】チェック行のみを対象にするかを指定します(初期値:true)
092 *   ※  sheetName          【TAG】EXCELファイルを書き出すときのシート名を設定します
093 *   ※  refFileURL         【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします
094 *   ※  refFilename        【TAG】EXCEL雛型参考ファイル名をセットします
095 *   ※  refSheetName       【TAG】EXCEL雛型参考ファイルのシート名を設定します
096 *   ※  sheetOverwrite     【TAG】EXCELでsheetNameでの指定シート名に対して上書きを行うかどうかを指定します。
097 *   ※  recalcSheetName    【TAG】EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をCSV形式で指定します。
098 *   ※  fontName           【TAG】EXCEL出力時のデフォルトフォント名を設定します
099 *                                      (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[={@og.value SystemData#TABLE_WRITER_DEFAULT_FONT_NAME}])
100 *   ※  fontPoint          【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します
101 *                                      (初期値:TABLE_WRITER_DEFAULT_FONT_POINTS[={@og.value SystemData#TABLE_WRITER_DEFAULT_FONT_POINTS}])
102 *   ※  skipRowCount       【TAG】(通常は使いません)EXCEL出力時のデータの書き込み開始位置を設定します
103 *   ※  useCellStyle       【TAG】EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します(初期値:false)
104 *   ※  useAutoCellSize    【TAG】EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します(初期値:false)
105 *   ※  useActiveWorkbook  【TAG】EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します(初期値:false)
106 *   ※  pageBreakColumn    【TAG】EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)
107 *   ※  fileBreakColumn    【TAG】EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)
108 *   ※  hyperLinkColumn    【TAG】EXCEL出力時に、Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定します
109 *   ※  addTitleSheet      【TAG】EXCEL出力時に、存在するSheet名一覧を作成する場合に、そのSheet名を指定します。
110 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
111 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
112 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
113 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
114 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
115 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
116 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
117 *   >   ... Body ...
118 *   </og:writeTable>
119 *
120 * 【廃止】6.9.5.0 (2018/04/23) 物理削除
121 *   //  direct             【廃止】結果をダイレクトにEXCEL起動するかどうか[true/false]を指定します(初期値:false[ファイル])  6.9.5.0 (2018/04/23) 物理削除
122 *   //  disposition        【廃止】Content-Disposition (inline:埋め込む/attachment:ダイアログを起動)を指定します(初期値:attachment)  6.9.5.0 (2018/04/23) 物理削除
123 *
124 *
125 * ●使用例
126 *     <og:writeTable ・・・・・ >
127 *         <og:writeTableParam
128 *             key  = "Tablename"  value="GE12"
129 *         />
130 *         <og:writeTableParam
131 *             key  = "First"             First:最初に登録
132 *         >
133 *                      insert into GE12bk
134 *                         select * from GE12
135 *                         where SYSTEM_ID='**'
136 *         </og:writeTableParam
137 *         <og:writeTableParam
138 *             key  = "First"             First:の2番目に登録
139 *         >
140 *              delete from GE12 where SYSTEM_ID='**' and KBSAKU='0'
141 *         </og:writeTableParam
142 *         <og:writeTableParam
143 *             key  = "Last"              Last:最後に登録
144 *         >
145 *              update GE12 set XXXX='YYYY' where SYSTEM_ID='**' and KBSAKU='0'
146 *         </og:writeTableParam
147 *     </og:writeTableParam
148 *
149 * @og.group ファイル出力
150 *
151 * @version  4.0
152 * @author   Kazuhiko Hasegawa
153 * @since    JDK5.0,
154 */
155public class WriteTableTag extends CommonTagSupport {
156        /** このプログラムのVERSION文字列を設定します    {@value} */
157        private static final String VERSION = "7.2.7.0 (2020/08/07)" ;
158        private static final long serialVersionUID = 727020200807L ;
159
160        private final String  BASE_URL  = HybsSystem.sys( "FILE_URL" );
161
162        private String  separator               = TableWriter.TAB_SEPARATOR;     // 項目区切り文字
163        private String  headerSequence  ;                                       // ヘッダー項目の並び順
164        private String  fileURL                 = BASE_URL;
165        private String  filename                = HybsSystem.sys( "FILE_FILENAME" );   // ファイル名
166        private String  sheetName               = "Sheet1" ;            // 3.5.4.2 (2003/12/15)
167        private String  refFileURL              = BASE_URL;                     // 3.5.4.3 (2004/01/05)
168        private String  refFilename     ;                                       // 3.5.4.3 (2004/01/05)
169        private String  refSheetName    ;                                       // 3.5.4.3 (2004/01/05)
170        private String  fontName                = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_NAME" );                   // 3.8.5.3 (2006/08/07)
171        private String  fontPoint               = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_POINTS" );                 // 3.8.5.3 (2006/08/07)
172        private String  encode                  = HybsSystem.sys( "FILE_ENCODE" );      // ファイルエンコーディング  "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS"
173        private String  writerClass     ;                                                                                                               // 6.2.0.0 (2015/02/27) 個人設定可
174        private boolean fileAppend              ;                                       // ファイルをAPPENDモードで出力するか
175//      private boolean direct                  ;                                       // 6.9.5.0 (2018/04/23) 廃止
176        private boolean zip                     ;
177        private String  zipFilename             ;                                       // 6.0.4.0 (2014/11/28) Zipファイル名を外部から与えられるように修正
178//      private String  disposition     = "attachment";         // 3.8.0.9 (2005/10/17) Content-Disposition 初期値変更 inline ⇒ attachment 6.9.5.0 (2018/04/23) 廃止
179
180        private transient DBTableModel table ;
181        private String  tableId                 = HybsSystem.TBL_MDL_KEY ;
182        private String  directory               ;                                       // 3.8.6.0 (2006/08/23)
183
184        private transient List<HybsEntry> param ;                       // 4.0.0 (2005/02/28)
185
186        private boolean useNumber               = true;                         // 3.7.0.2 (2005/02/14)
187        // 4.0.0 (2005/12/31) 外部よりカラム列(CSV形式)を指定できるようにする。
188        private String          columns         ;
189        // 6.1.0.0 (2014/12/26) 書き込み対象外のカラム列を、外部(タグ)より指定する。
190        private String          omitNames       ;                                       // 6.1.0.0 (2014/12/26)
191
192        // 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか
193        private boolean useRenderer             = HybsSystem.sysBool( "USE_TABLE_WRITER_RENDERER" );    // 5.2.1.0 (2010/10/01)
194
195        // 5.5.5.5 (2012/08/24) チェック対応
196        private boolean selectedAll             = true;                         // 5.5.5.5 (2012/08/24)
197
198        // 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。互換性のため、false に設定。推奨は、true
199        private boolean beforeDelete    ;                                       // 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。
200
201        private int             skipRowCount    ;                                       // 5.7.9.0 (2014/08/08) データの書き込み開始位置設定
202
203        // 5.9.12.1 (2016/09/09)
204        private boolean sheetOverwrite;                                         // 5.9.12.1 (2016/09/09)
205        private String recalcSheetName;                                         // 5.9.12.1 (2016/09/09)
206
207        // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
208        private boolean useCellStyle            ;                       // EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します
209        private boolean useAutoCellSize         ;                       // EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します
210        private boolean useActiveWorkbook       ;                       // EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します
211        private String  pageBreakColumn         ;                       // EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)
212        private String  fileBreakColumn         ;                       // EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)
213        private String  hyperLinkColumn         ;                       // EXCEL出力時に、Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定します
214        private String  addTitleSheet           ;                       // EXCEL出力時に、存在するSheet名一覧を作成する場合に、そのSheet名を指定します。
215
216        /**
217         * デフォルトコンストラクター
218         *
219         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
220         */
221        public WriteTableTag() { super(); }             // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
222
223        /**
224         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
225         *
226         * @og.rev 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか(beforeDelete)フラグを追加
227         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
228         * @og.rev 6.0.4.0 (2014/11/28) Zipファイル名を、内部変数化。(将来的に引数化を容易にするため)
229         *
230         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
231         */
232        @Override
233        public int doStartTag() {
234                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
235                if( !useTag() ) { return SKIP_BODY ; }
236
237                directory = HybsSystem.url2dir( fileURL );              // 5.5.9.1 (2012/12/07) doEndTag() から移動
238                if( zip && zipFilename == null ) { zipFilename = filename + ".zip"; }           // 6.0.4.0 (2014/11/28)
239
240                // 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか
241                if( beforeDelete && !fileAppend ) {
242                        File delFile = null;
243                        if( zip ) {
244                                delFile = new File( directory,zipFilename );                            // 6.0.4.0 (2014/11/28)
245                        }
246                        else      {
247                                delFile = new File( directory,filename );
248                        }
249                        // 6.0.2.4 (2014/10/17) RV  java.io.File.delete() の例外的戻り値を無視しています。
250                        if( delFile.exists() && !delFile.delete() ) {
251                                        final String errMsg = "事前にファイルを削除するのに失敗しました。filename=[" + delFile +"]" ;
252                                        System.err.println( errMsg );
253                        }
254                }
255
256                return EVAL_BODY_BUFFERED ;     // Body を評価する。( extends BodyTagSupport 時)
257        }
258
259        /**
260         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
261         *
262         * @og.rev 2.1.3.1 (2002/12/13) ContentType を、x-msexcel から vnd.ms-excel に変更した。
263         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
264         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
265         * @og.rev 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。
266         * @og.rev 3.2.0.0 (2003/05/22) GZIPOutputStream を使用していたが、ZipOutputStream に変更。
267         * @og.rev 3.5.4.1 (2003/12/01) 引数の PrintWriter を、OutputStream に変更。
268         * @og.rev 3.5.4.3 (2004/01/05) 引数を、 PrintWriter に戻す。
269         * @og.rev 3.6.0.2 (2004/10/04) EXCELダイレクト出力時にファイルエンドまで出力されない不具合対策
270         * @og.rev 3.8.0.9 (2005/10/17) disposition属性を使用できるように変更します。
271         * @og.rev 3.8.6.0 (2006/08/23) フォルダがない場合は、複数階層分のフォルダを自動で作成します。
272         * @og.rev 4.3.4.3 (2008/12/22) Excel出力の判別方法を前方一致に変更
273         * @og.rev 5.1.6.0 (2010/05/01) 画面帳票作成機能対応
274         * @og.rev 5.5.2.0 (2012/05/01) ZIP時にもencodeが有効にする
275         * @og.rev 5.5.5.5 (2012/08/24) selectedAllの処理を追加
276         * @og.rev 5.5.9.1 (2012/12/07) beforeDeleteフラグの追加に伴う、ロジック変更
277         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
278         * @og.rev 6.0.4.0 (2014/11/28) Zip処理を、ZipOutputStream → ZipArchiveOutputStream に変更
279         * @og.rev 6.2.0.0 (2015/02/27) EXCEL出力のparamLevel初期値変更 3:標準推奨 → 4:個人設定可
280         * @og.rev 6.9.5.0 (2018/04/23) direct 廃止(false固定)
281         * @og.rev 5.10.23.0 (2020/06/01) 書込み件数をリクエスト変数WRITE.COUNTに出力
282         *
283         * @return      後続処理の指示
284         */
285        @Override
286        public int doEndTag() {
287                int tblcnt = 0;         // 5.10.23.0 (2020/06/01)
288                debugPrint();           // 4.0.0 (2005/02/28)
289
290                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
291                if( !useTag() ) { return EVAL_PAGE ; }
292
293                table = (DBTableModel)getObject( tableId );
294                if( ! selectedAll ){            // 5.5.5.5 (2012/08/24)
295                        table = getSelRowsTable( table );
296                }
297                if( table != null && table.getRowCount() > 0 ) {
298
299                        final File dir = new File( directory );
300                        if( ! dir.exists() && ! dir.mkdirs() ) {
301                                final String errMsg = "ディレクトリの作成に失敗しました。[" + directory + "]";
302                                throw new HybsSystemException( errMsg );
303                        }
304
305                        // 6.2.0.0 (2015/02/27) EXCEL出力のparamLevel初期値変更 3:標準推奨 → 4:個人設定可
306                        if( writerClass == null ) {
307                                writerClass = nval( sys( "TABLE_WRITER_DEFAULT_CLASS" ) , "Default" );          // 6.2.0.0 (2015/02/27) 個人設定可
308                        }
309
310                        PrintWriter pw = null;
311                        ByteArrayOutputStream bt = null ;
312                        try {
313//                              // 6.9.5.0 (2018/04/23) 廃止(false固定)
314//                              if( direct ) {
315//                                      // 6.0.4.0 (2014/11/28) 共通処理を、if( zip ) の前後でまとめます。
316//                                      bt = new ByteArrayOutputStream();
317//                                      pw = new PrintWriter( bt );
318//                                      create( pw ) ;
319//                                      pw.flush();                             // 3.6.0.2 (2004/10/04)
320//                                      final ServletResponse response = pageContext.getResponse() ;
321//                                      if( zip ) {
322//                                              ((HttpServletResponse)response).addHeader( "Content-Encoding","gzip" );
323//
324//                                              final ZipArchiveOutputStream gzip = new ZipArchiveOutputStream(bt);     // 6.0.4.0 (2014/11/28)
325//                                              gzip.finish() ;
326//                                              response.setContentLength( bt.size() );
327//
328//                                              gzip.closeArchiveEntry();       // 6.0.4.0 (2014/11/28)
329//                                              gzip.finish() ;                         // 6.0.4.0 (2014/11/28)
330//                                              Closer.ioClose( gzip );         // 6.0.4.0 (2014/11/28)
331//
332//                                      }
333//                                      else {
334//                                              response.setContentType( "application/vnd.ms-excel; charset=" + encode );
335//      //                                      response.setContentType( "application/x-msexcel; charset=" + encode );
336//      //                                      response.setContentType( "text/comma-separated-values ; charset=" + encode );
337//      //                                      ((HttpServletResponse)response).setHeader( "contentType","application/x-msexcel; charset=Shift_JIS" );
338//      //                                      ((HttpServletResponse)response).setHeader( "Content-Disposition","attachment; filename=\"" + filename + "\"" );
339//      //                                      ((HttpServletResponse)response).setHeader( "Content-Disposition","inline; filename=\"" + filename + "\"" );
340//                                              // 3.8.0.9 (2005/10/17) disposition属性を使用できるように変更します。
341//                                              ((HttpServletResponse)response).setHeader( "Content-Disposition",disposition + "; filename=\"" + filename + "\"" );
342//
343//                                      }
344//                                      final JspWriter out = pageContext.getOut();
345//                                      out.clear();
346//                                      out.print( bt );
347//                                      out.flush();                    // 3.6.0.2 (2004/10/04)
348//                              }
349//                              else {
350                                        final boolean isExcel =  writerClass.toUpperCase(Locale.JAPAN).startsWith("EXCEL")
351                                                                                  || writerClass.toUpperCase(Locale.JAPAN).startsWith("CALC");  // 6.0.4.0 (2014/11/28)
352
353                                        // 3.2.0.0 (2003/05/22) GZIPOutputStream を使用していたが、ZipOutputStream に変更。
354                                        if( zip ) {
355                                                InputStream is = null;                  // 6.0.4.0 (2014/11/28)
356                                                if( isExcel ) {                                 // 6.0.4.0 (2014/11/28)
357                                                        create( null );                         // 6.0.4.0 (2014/11/28)
358                                                }
359                                                else{
360                                                        bt = new ByteArrayOutputStream();
361                                                        pw = getPrintWriter( bt );      // 6.0.4.0 (2014/11/28)
362                                                        create( pw ) ;                          // 6.0.4.0 (2014/11/28)
363                                                        pw.flush();                                     // 6.0.4.0 (2014/11/28)
364                                                }
365
366                                                // 6.0.4.0 (2014/11/28) Zip処理を、ZipOutputStream → ZipArchiveOutputStream に変更
367                                                ZipArchiveOutputStream gzip = null;                     // 6.0.4.0 (2014/11/28)
368                                                try {
369                                                        gzip = new ZipArchiveOutputStream(
370                                                                                new BufferedOutputStream (
371                                                                                        new FileOutputStream (
372                                                                                                new File( directory,zipFilename ))));   // 6.0.4.0 (2014/11/28)
373                                                        gzip.setEncoding( "Windows-31J" );
374                                                        gzip.putArchiveEntry( new ZipArchiveEntry( filename ) );
375                                                        // 6.0.4.0 (2014/11/28) Excel処理とText処理が異なる。
376                                                        // bt.writeTo( gzip );
377                                                        if( isExcel ) {
378                                                                // 6.0.4.0 (2014/11/28) Excel の場合は、直接書き込むのではなく、ファイルを読み込んで Zip化する。
379                                                                final File xlsTemp = new File( directory,filename );
380                                                                is = new BufferedInputStream( new FileInputStream( xlsTemp ) );
381                                                                IOUtils.copy( is,gzip );
382                                                                Closer.ioClose( is );
383                                                                if( xlsTemp.exists() && !xlsTemp.delete() ) {
384                                                                        final String errMsg = "ExcelをZip化する時のTempファイルを削除するのに失敗しました。filename=[" + xlsTemp +"]" ;
385                                                                        System.err.println( errMsg );
386                                                                }
387                                                        }
388                                                        else {
389                                                                bt.writeTo( gzip );
390                                                        }
391                                                        gzip.closeArchiveEntry();                               // 6.0.4.0 (2014/11/28)
392                                                        gzip.finish() ;
393                                                }
394                                                finally {
395                                                        Closer.ioClose( gzip );         // 4.0.0.0 (2006/01/31) close 処理時の IOException を無視
396                                                        Closer.ioClose( is );           // 6.0.4.0 (2014/11/28) is は、null でも処理する。
397                                                }
398                                        }
399                                        else {
400                                                if( isExcel ) {                                 // 6.0.4.0 (2014/11/28)
401                                                        create( null );
402                                                }
403                                                else {
404                                                        pw = getPrintWriter();
405                                                        create( pw );
406                                                        pw.flush();                                     // 3.6.0.2 (2004/10/04)
407                                                }
408                                        }
409//                              }
410                                tblcnt = table.getRowCount();                   // 5.10.23.0 (2020/06/01)
411                        }
412                        catch( final IOException ex ) {
413                                final String errMsg = "テーブル出力時に、IOエラーが発生しました。" + toString();
414                                throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
415                        }
416                        finally {
417                                Closer.ioClose( pw );           // 4.0.0 (2006/01/31) close 処理時の IOException を無視
418                                Closer.ioClose( bt );           // 4.0.0 (2006/01/31) close 処理時の IOException を無視
419                        }
420                }
421                setRequestAttribute( "WRITE.COUNT" , String.valueOf( tblcnt ) ); // 5.10.23.0 (2020/06/01)
422
423                return EVAL_PAGE ;
424        }
425
426        /**
427         * タグリブオブジェクトをリリースします。
428         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
429         *
430         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
431         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
432         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
433         * @og.rev 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。
434         * @og.rev 3.5.4.2 (2003/12/15) EXCELのシート名を指定できるように変更。
435         * @og.rev 3.5.4.3 (2004/01/05) EXCEL雛型参照ファイルのURL,filenameを追加します。
436         * @og.rev 3.8.5.3 (2006/08/07) writerClass 属性の初期値をシステムリソースより取得します。
437         * @og.rev 3.8.5.3 (2006/08/07) fontName 属性を追加します。
438         * @og.rev 3.8.5.3 (2006/08/07) fontPoint 属性を追加します。
439         * @og.rev 3.8.6.0 (2006/08/23) directory 属性を追加します。
440         * @og.rev 4.0.0.0 (2005/02/28) XMLファイルにセットする、param を追加。
441         * @og.rev 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか useRenderer 属性追加
442         * @og.rev 5.5.5.5 (2012/08/24) selectedAll属性を追加
443         * @og.rev 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。互換性のため、false に設定。推奨は、true
444         * @og.rev 5.7.9.0 (2014/08/08) データの書き込み開始位置(skipRowCount)を設定
445         * @og.rev 6.0.2.0 (2014/09/19) EXCEL関係機能追加(useCellStyle,useAutoCellSize,useActiveWorkbook,
446         *                                                              pageBreakColumn,fileBreakColumn,hyperLinkColumn,addTitleSheet)
447         * @og.rev 6.0.4.0 (2014/11/28) zipFilename属性を追加。
448         * @og.rev 6.1.0.0 (2014/12/26) omitNames 属性を追加
449         * @og.rev 6.2.0.0 (2015/02/27) EXCEL出力のparamLevel初期値変更 3:標準推奨 → 4:個人設定可
450         * @og.rev 5.9.12.1 (2016/09/09) sheetOverwrite で、雛形シートの使用時に、元のシート名を使用します。
451         * @og.rev 6.9.5.0 (2018/04/23) direct 廃止(false固定)
452         */
453        @Override
454        protected void release2() {
455                super.release2();
456                separator               = TableWriter.TAB_SEPARATOR;   // 項目区切り文字
457                headerSequence  = null;                         // ヘッダー項目の並び順
458                fileURL                 = BASE_URL;
459                filename                = HybsSystem.sys( "FILE_FILENAME" );   // ファイル名
460                sheetName               = "Sheet1";                     // 3.5.4.2 (2003/12/15)
461                beforeDelete    = false;                        // 5.5.9.1 (2012/12/07)
462                refFileURL              = BASE_URL;                     // 3.5.4.3 (2004/01/05)
463                refFilename     = null;                         // 3.5.4.3 (2004/01/05)
464                refSheetName    = null;                         // 3.5.4.2 (2003/12/15)
465                sheetOverwrite  = false;                        // 5.9.12.1 (2016/09/09)
466                recalcSheetName = null;                         // 5.9.12.1 (2016/09/09)
467                fontName                = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_NAME" );                   // 3.8.5.3 (2006/08/07)
468                fontPoint               = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_POINTS" );                 // 3.8.5.3 (2006/08/07)
469                encode                  = HybsSystem.sys( "FILE_ENCODE" );       // ファイルエンコーディング  "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS"
470                writerClass     = null;                                                                                                 // 6.2.0.0 (2015/02/27) 個人設定可
471                fileAppend              = false;                        // ファイルをAPPENDモードで出力するか
472//              direct                  = false;                        // 6.9.5.0 (2018/04/23) direct 廃止(false固定)
473                zip                     = false;
474                zipFilename             = null;                         // 6.0.4.0 (2014/11/28)
475                table                   = null;
476                tableId                 = HybsSystem.TBL_MDL_KEY ;
477//              disposition     = "attachment";         // 3.8.0.9 (2005/10/17) 初期値変更 inline ⇒ attachment 6.9.5.0 (2018/04/23) 廃止
478                param                   = null ;                        // 4.0.0 (2005/01/31)
479                useNumber               = true;                         // 3.7.0.2 (2005/02/14)
480                skipRowCount    = 0;                            // 5.7.9.0 (2014/08/08) データの書き込み開始位置を設定
481                directory               = null;                         // 3.8.6.0 (2006/08/23)
482                columns                 = null;                         // 4.0.0 (2005/12/31)
483                omitNames               = null;                         // 6.1.0.0 (2014/12/26)
484                useRenderer             = HybsSystem.sysBool( "USE_TABLE_WRITER_RENDERER" );    // 5.2.1.0 (2010/10/01)
485                selectedAll             = true;                         // 5.5.5.5 (2012/08/24)
486                // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
487                useCellStyle            = false;                // EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します
488                useAutoCellSize         = false;                // EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します
489                useActiveWorkbook       = false;                // EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します
490                pageBreakColumn         = null;                 // EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)
491                fileBreakColumn         = null;                 // EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)
492                hyperLinkColumn         = null;                 // EXCEL出力時に、Hyperlinkを作成するキーとなるカラム名と値となるカラム名を指定します
493                addTitleSheet           = null;                 // EXCEL出力時に、存在するSheet名一覧を作成する場合に、そのSheet名を指定します。
494        }
495
496        /**
497         * TableWriter の実オブジェクトを生成して,引数のPrintWriter に書きだします。
498         *
499         * EXCEL系は、自身で出力先のOutputStreamを作成するので、引数のPrintWriterを
500         * 使わず、directory , filename から、生成します。
501         *
502         * @og.rev 3.5.4.1 (2003/12/01) 引数の PrintWriter を、OutputStream に変更。
503         * @og.rev 3.5.4.2 (2003/12/15) lang 引数も table と同時に設定します。
504         * @og.rev 3.5.4.2 (2003/12/15) TableWriter のサブクラス名変更。
505         * @og.rev 3.5.4.3 (2004/01/05) EXCEL雛型参考ファイルを指定するように変更。
506         * @og.rev 3.5.4.3 (2004/01/05) 引数を、 PrintWriter に戻す。
507         * @og.rev 3.5.4.5 (2004/01/23) 文字エンコードを渡すように変更する。
508         * @og.rev 3.5.6.0 (2004/06/18) 各種プラグイン関連付け設定を、システムパラメータ に記述します。
509         * @og.rev 3.8.5.3 (2006/08/07) EXCEL時に fontName と fontPoint 属性をセットします。
510         * @og.rev 4.0.0.0 (2005/01/31) キーの指定を、TableWriter. から、TableWriter_ に変更します。
511         * @og.rev 4.0.0.0 (2005/12/31) 外部よりカラム列(CSV形式)を指定できるようにする。
512         * @og.rev 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか設定 useRenderer 属性追加
513         * @og.rev 5.7.9.0 (2014/08/08) データの書き込み開始位置(skipRowCount)を設定
514         * @og.rev 6.0.2.0 (2014/09/19) EXCEL関係機能追加(useCellStyle,useAutoCellSize,useActiveWorkbook,pageBreakColumn,fileBreakColumn)
515         * @og.rev 6.0.4.0 (2014/11/28) NullPointerException が発生するので、事前にチェックします。
516         * @og.rev 6.1.0.0 (2014/12/26) デバッグ情報を出力するかどうかを指定
517         * @og.rev 6.1.0.0 (2014/12/26) omitNames 属性を追加
518         * @og.rev 6.4.2.1 (2016/02/05) HybsSystem.url2dir に引数追加。
519         * @og.rev 6.4.3.3 (2016/03/04) HybsSystem.newInstance(String,String) への置き換え。
520         * @og.rev 5.9.12.1 (2016/09/09) sheetOverwrite で、雛形シートの使用時に、元のシート名を使用します。
521         *
522         * @param   outPW 出力先のPrintWriterオブジェクト
523         */
524        private void create( final PrintWriter outPW )  {
525                // 5.2.1.0 (2010/10/01) writerClass で Renderer系の場合は、useRendererフラグに変更する。
526                if( "ExcelRenderer".equalsIgnoreCase( writerClass ) ) {
527                        writerClass = "Excel" ;
528                        useRenderer = true;
529                }
530                else if( "Renderer".equalsIgnoreCase( writerClass ) ) {
531                        writerClass = "Default" ;
532                        useRenderer = true;
533                }
534
535                final TableWriter writer = HybsSystem.newInstance( "TableWriter_" , writerClass );      // 3.5.5.3 (2004/04/09)
536                writer.setDBTableModel( table,getLanguage() );
537                writer.setSeparator( separator );
538                writer.setHeaderSequence( headerSequence );
539                writer.setEncode( encode );                                     // 3.5.4.5 (2004/01/23)
540                writer.setAppend( fileAppend );                         // 3.5.4.2 (2003/12/15)
541                if( param != null ) { writer.setParam( param ); }       // 4.0.0 (2005/01/31)
542                writer.setUseNumber( useNumber );                       // 3.7.0.2 (2005/02/14)
543        //      if( columns == null ) {
544        //              columns = (String)getSessionAttribute( HybsSystem.TBL_WRITER_CLMS );
545        //              removeSessionAttribute( HybsSystem.TBL_WRITER_CLMS );
546        //      }
547                writer.setColumns( columns );                           // 4.0.0 (2005/12/31)
548                writer.setOmitNames( omitNames );                       // 6.1.0.0 (2014/12/26)
549                writer.setUseRenderer( useRenderer );           // 5.2.1.0 (2010/10/01)
550                writer.setDebug( isDebug() );                           // 6.1.0.0 (2014/12/26) デバッグ情報を出力するかどうかを指定
551                if( writer.isExcel() ) {                                        // 3.5.4.3 (2004/01/05)
552                        writer.setSheetName( sheetName );
553                        writer.setFilename( directory , filename );                                     // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
554                        if( refFileURL != null && refFilename != null ) {
555                                writer.setRefFilename( HybsSystem.url2dir( refFileURL , refFilename ) );                        // 6.4.2.1 (2016/02/05) HybsSystem.url2dir に引数追加
556                        }
557                        if( refSheetName != null && refSheetName.length() > 0 ) {       // 5.7.9.0 (2014/08/08) nullチェック
558                                writer.setRefSheetName( refSheetName );
559                        }
560                        writer.setFontName( fontName )  ;                                                       // 5.7.9.0 (2014/08/08) nvalはずし
561                        if( fontPoint != null && fontPoint.length() > 0 ) {
562                                writer.setFontPoint( Short.parseShort( fontPoint ) );   // 3.8.5.3 (2006/08/07)
563                        }
564                        writer.setSkipRowCount( skipRowCount );                                         // 5.7.9.0 (2014/08/08)
565
566                        writer.setSheetOverwrite( sheetOverwrite );                                     // 5.9.12.1 (2016/09/09)
567                        writer.setRecalcSheetName( recalcSheetName );                           // 5.9.12.1 (2016/09/09)
568
569                        writer.setUseCellStyle( useCellStyle );                                         // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
570                        writer.setUseAutoCellSize( useAutoCellSize );                           // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
571                        writer.setUseActiveWorkbook( useActiveWorkbook );                       // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
572                        writer.setPageBreakColumn( pageBreakColumn );                           // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
573                        writer.setFileBreakColumn( fileBreakColumn );                           // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
574                        writer.setHyperLinkColumn( hyperLinkColumn );                           // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
575                        writer.setAddTitleSheet( addTitleSheet );                                       // 6.0.2.0 (2014/09/19) EXCEL関係機能追加
576
577                        writer.writeDBTable();
578                }
579                else {
580                        writer.writeDBTable( outPW );
581                }
582        }
583
584        /**
585         * PrintWriter を取得します。
586         *
587         * ここでは、一般的なファイル出力を考慮した PrintWriter を作成します。
588         *
589         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
590         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
591         * @og.rev 3.5.4.1 (2003/12/01) PrintWriter を、OutputStream に変更。
592         * @og.rev 3.5.5.9 (2004/06/07) FileUtil.getBufferedReader を使用
593         * @og.rev 3.7.1.1 (2005/05/23) フォルダがない場合は、複数階層分のフォルダを自動で作成します。
594         * @og.rev 3.8.0.0 (2005/06/07) FileUtil#getPrintWriter を利用。
595         *
596         * @return      ファイル書き出し用のPrintWriterオブジェクト
597         */
598        private PrintWriter getPrintWriter() {
599                if( filename == null ) {
600                        final String errMsg = "ファイル名がセットされていません。";
601                        throw new HybsSystemException( errMsg );
602                }
603
604                // 6.4.1.1 (2016/01/16) ワンクッションいれずに return します。
605                return FileUtil.getPrintWriter( new File( directory,filename ),encode,fileAppend );
606        }
607
608        /**
609         * PrintWriter を取得します。
610         *
611         * 引数で指定したOutputStreamを利用して出力します。
612         *
613         * @og.rev 5.5.2.0 (2012/05/01) 新規作成
614         *
615         * @param       os      OutputStreamオブジェクト
616         *
617         * @return      指定したstreamに書き出すPrintWriter
618         */
619        private PrintWriter getPrintWriter( final OutputStream os ) {
620                // 6.4.1.1 (2016/01/16) ワンクッションいれずに return します。
621                return FileUtil.getPrintWriter( os,encode );
622        }
623
624        /**
625         * チェック分のテーブルモデルを再構成します。
626         *
627         * @og.rev 5.5.5.5 (2012/08/24) 新規作成
628         * @og.rev 5.5.9.1 (2012/12/07) 内部処理変更
629         *
630         * @param       oldTable        コピー元テーブルモデル
631         *
632         * @return      チェックした分だけで再構成したテーブルモデル
633         */
634        private DBTableModel getSelRowsTable( final DBTableModel oldTable ) {
635                if( oldTable == null ) { return null; }         // 5.5.9.1 (2012/12/07) 引数のDBTableModelが null の場合の処理。
636
637                final DBTableModel newTable = oldTable.newModel();
638                final int[] rowNo = getParameterRows();
639                final int rowCount = rowNo.length ;
640
641                for( int i=0; i<rowCount; i++ ) {
642                        newTable.addValues( oldTable.getValues(rowNo[i]), i );
643                }
644                return newTable;
645        }
646
647        /**
648         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
649         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
650         *
651         * @og.tag
652         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
653         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
654         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
655         * この tableId 属性を利用して、メモリ空間を分けます。
656         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
657         *
658         * @param       id テーブルID (sessionに登録する時のID)
659         */
660        public void setTableId( final String id ) {
661                tableId = nval( getRequestParameter( id ), tableId );
662        }
663
664        /**
665         * 【TAG】可変長ファイルを作成するときの項目区切り文字をセットします
666         *              (初期値:TableWriter#TAB_SEPARATOR[={@og.value org.opengion.hayabusa.io.TableWriter#TAB_SEPARATOR}])。
667         *
668         * @og.tag 可変長ファイルを作成するときの項目区切り文字をセットします。
669         * (初期値:TableWriter#TAB_SEPARATOR[={@og.value org.opengion.hayabusa.io.TableWriter#TAB_SEPARATOR}])。
670         *
671         * @param   separator 項目区切り文字
672         * @see         org.opengion.hayabusa.io.TableWriter#TAB_SEPARATOR
673         */
674        public void setSeparator( final String separator ) {
675                this.separator = nval( getRequestParameter( separator ),this.separator );
676        }
677
678        /**
679         * 【TAG】DBTableModelの出力順(LNSCD など)をセットします。
680         *
681         * @og.tag
682         * Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで
683         * 出力順を設定します。
684         *
685         * N: Name(名前)属性。ファイルを読み取る(DBTableReader)場合には必要です。
686         * L: Label(ラベル)属性。指定のカラムの名称を表示します。
687         * S: Size(サイズ)属性。指定のカラムの桁数を表示します。
688         * C: Class(クラス)属性。指定のカラムのクラス(文字、数字など)を表示します。
689         * -: ----(区切り記号)属性。必要な箇所に入れることで、ヘッダー部とデータ部を分離します。
690         * D: Data(データ)属性。実際のデータを繰り返し表示します。
691         *
692         * H:#なしのLabel(ラベル)属性を出力します(EXCELは除く)
693         *
694         * ※ 7.2.6.1 (2020/07/17) H:Header(ヘッダー)属性追加。Label(ラベル)属性の先頭の#を削除します。
695         *
696         * @param   hs 出力順 (LNSCD など)
697         */
698        public void setHeaderSequence( final String hs ) {
699                final String[] headers = getRequestParameterValues( hs );
700                if( headers != null ) {
701                        final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
702                        // 7.2.9.4 (2020/11/20) PMD:This for loop can be replaced by a foreach loop
703                        for( final String head : headers ) {
704                                if( head != null ) { buf.append( head ); }
705                        }
706//                      for( int i=0; i<headers.length; i++ ) {
707//                              if( headers[i] != null ) { buf.append( headers[i] ); }
708//                      }
709                        headerSequence = buf.toString();
710                }
711        }
712
713        /**
714         * 【TAG】ファイル保存先ディレクトリ名を指定します
715         *              (初期値:FILE_URL[={@og.value SystemData#FILE_URL}])。
716         *
717         * @og.tag
718         * この属性で指定されるディレクトリに、ファイルをセーブします。
719         * 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
720         * ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
721         * システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。
722         * fileURL = "{&#064;USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
723         * さらに、各個人ID別のフォルダを作成して、そこにセーブします。
724         *
725         * @og.rev 3.5.4.3 (2004/01/05) 内部処理を、makeFileURL に移動。
726         * @og.rev 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用
727         * @og.rev 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。
728         * @og.rev 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。
729         *
730         * @param       url 保存先ディレクトリ名
731         */
732        public void setFileURL( final String url ) {
733                final String furl = nval( getRequestParameter( url ),null );
734                if( furl != null ) {
735                        fileURL = StringUtil.urlAppend( fileURL,furl );
736                }
737        }
738
739        /**
740         * 【TAG】ファイル保存先ディレクトリ名を指定します(初期値:コンテキストパス)。
741         *
742         * @og.tag
743         * この属性で指定されるディレクトリに、ファイルをセーブします。
744         * 絶対パスに関しては、fileURL の指定と同じですが、相対パスで指定する場合は、
745         * 基準パスが、コンテキストパス になります。
746         * この属性は特殊で、互換性のために持っています。
747         * fileUpdate や、fileDownload サーブレットなどの基準パスが、コンテキストパスなので、これらの
748         * タグと組み合わせて使用する場合に、使用します。
749         *
750         * @og.rev 7.2.7.0 (2020/08/07) コンテキストパスを基準パスとするfileURLの設定
751         *
752         * @param       url 保存先ディレクトリ名
753         */
754        public void setBaseURL( final String url ) {
755                fileURL = nval( getRequestParameter( url ),"" );
756        }
757
758        /**
759         * 【TAG】ファイルを作成するときのファイル名をセットします
760         *              (初期値:FILE_FILENAME[={@og.value SystemData#FILE_FILENAME}])。
761         *
762         * @og.tag ファイルを作成するときのファイル名をセットします。
763         * (初期値:システム定数のFILE_ENCODE[={@og.value SystemData#FILE_FILENAME}])。
764         *
765         * @param   filename ファイル名
766         * @see         org.opengion.hayabusa.common.SystemData#FILE_FILENAME
767         */
768        public void setFilename( final String filename ) {
769                this.filename = nval( getRequestParameter( filename ),this.filename );
770        }
771
772        /**
773         * 【TAG】EXCELファイルを書き出すときのシート名を設定します(初期値:Sheet1)。
774         *
775         * @og.tag
776         * EXCELファイルを書き出す時に、シート名を指定します。これにより、複数の形式の
777         * 異なるデータを順次書き出したり(appendモードを併用)することや、シートを指定して
778         * 新規にEXCELを作成することが可能になります。
779         * 初期値は、Sheet1 です。
780         *
781         * @og.rev 3.5.4.2 (2003/12/15) 新規追加
782         *
783         * @param   sheet シート名
784         */
785        public void setSheetName( final String sheet ) {
786                sheetName = nval( getRequestParameter( sheet ),sheetName );
787        }
788
789        /**
790         * 【TAG】ファイルを作成するときのファイルエンコーディング名をセットします
791         *              (初期値:FILE_ENCODE[={@og.value SystemData#FILE_ENCODE}])。
792         *
793         * @og.tag
794         * "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS"
795         * (初期値:システム定数のFILE_ENCODE[={@og.value SystemData#FILE_ENCODE}])。
796         *
797         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
798         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
799         *
800         * @param   enc エンコーディング名 (例:DEFAULT,JISAutoDetect,JIS,EUC_JP,MS932,SJIS,Windows-31J,Shift_JIS)
801         * @see     <a href="http://www.iana.org/assignments/character-sets">IANA Charset Registry</a>
802         * @see         org.opengion.hayabusa.common.SystemData#FILE_ENCODE
803         */
804        public void setEncode( final String enc ) {
805                encode = nval( getRequestParameter( enc ),encode );
806        }
807
808        /**
809         * 【TAG】実際に書き出すクラス名の略称({@og.doc03Link writerClass TableWriter_**** クラスの ****})を指定します
810         *              (初期値:TABLE_WRITER_DEFAULT_CLASS[={@og.value SystemData#TABLE_WRITER_DEFAULT_CLASS}])。
811         *
812         * @og.tag
813         * 実際に書き出すクラス名(の略称)をセットします。
814         * org.opengion.hayabusa.io.TableWriter インターフェースを継承したサブクラスです。
815         * これは、org.opengion.plugin.io 以下の TableWriter_**** クラスの **** を与えます。
816         * 属性クラス定義の {@link org.opengion.hayabusa.io.TableWriter TableWriter} を参照願います。
817         * {@og.doc03Link writerClass TableWriter_**** クラス}
818         *
819         * ExcelRenderer と、Renderer は、特別な名前で、useRenderer 属性に、"true" をセットするのと同じ効果があります。
820         * 実際は、ExcelRenderer ⇒ Excel 、Renderer  ⇒ Default のクラスが呼ばれます。
821         * (初期値:TABLE_WRITER_DEFAULT_CLASS[={@og.value SystemData#TABLE_WRITER_DEFAULT_CLASS}])。
822         *
823         * @param   writerClass クラス名(の略称)
824         * @see         org.opengion.hayabusa.io.TableWriter  TableWriterのサブクラス
825         */
826        public void setWriterClass( final String writerClass ) {
827                this.writerClass = nval( getRequestParameter( writerClass ),this.writerClass );
828        }
829
830        /**
831         * 【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])。
832         *
833         * @og.tag DBTableModelのファイルを、追加モードで書き込むかどうかをセットします。
834         *
835         * @param   flag 追加モードか [true:追加モード/それ以外:新規モード]
836         */
837        public void setFileAppend( final String flag ) {
838                fileAppend = nval( getRequestParameter( flag ),fileAppend );
839        }
840
841//      /**
842//       * 【廃止】結果をダイレクトにEXCEL起動するかどうか[true/false]を指定します(初期値:false[ファイル])。
843//       *
844//       * @og.tag 結果をダイレクトに EXCEL ファイルとして出力するかどうかをセットします。
845//       *
846//       * @og.rev 6.9.5.0 (2018/04/23) 物理的に廃止
847//       *
848//       * @param  flag ダイレクト起動か [true:ダイレクト/それ以外:ファイル]
849//       * @deprecated 結果をダイレクトするとエンコード等でおかしな動きをする可能性がある。
850//       */
851//      @Deprecated public void setDirect( final String flag ) {
852//              direct = nval( getRequestParameter( flag ),direct );
853//      }
854
855        /**
856         * 【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)。
857         *
858         * @og.tag
859         * 初期値は、圧縮しないです。
860         *
861         * @param  flag ZIPで圧縮する [true:圧縮する/それ以外:しない]
862         */
863        public void setZip( final String flag ) {
864                zip = nval( getRequestParameter( flag ),zip );
865        }
866
867        /**
868         * 【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")。
869         *
870         * @og.tag
871         * zip 属性に、true を指定した場合に、ZIPファイル化します。その場合のファイル名を指定します。
872         * なにも指定しない場合は、filename + ".zip" になります。
873         *
874         * @og.rev 6.0.4.0 (2014/11/28) Zipファイル名を外部から与えられるように修正
875         *
876         * @param   zipFile ZIPファイル名
877         * @see #setZip( String )
878         */
879        public void setZipFilename( final String zipFile ) {
880                zipFilename = nval( getRequestParameter( zipFile ),zipFilename );
881        }
882
883//      /**
884//       * 【廃止】Content-Disposition [inline:埋め込む/attachment:ダイアログを起動]を指定します(初期値:attachment)。
885//       *
886//       * @og.tag
887//       * Content-Disposition を指定することで、ブラウザにアプリケーションデータを
888//       * 埋め込むのか(inline)、セーブ/オープンのダイアログを起動するのか(attachment)
889//       * 指定します。
890//       * この属性が有効なのは、direct="true" で、zip="false"(初期値)のときのみです。
891//       * 値は、inline 、attachment が指定できます。
892//       * 初期値は、attachment です。
893//       * 注意:動作検証しましたが、inline と attachment で動作に差が現れませんでした。
894//       *
895//       * @og.rev 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。
896//       * @og.rev 3.8.0.9 (2005/10/17) Content-Disposition 初期値変更 inline ⇒ attachment
897//       * @og.rev 6.9.5.0 (2018/04/23) 物理的に廃止
898//       *
899//       * @param  pos 埋め込みするかどうか [inline:埋め込む/attachment:ダイアログを起動]
900//       */
901//      public void setDisposition( final String pos ) {
902//              disposition = nval( getRequestParameter( pos ),disposition );
903//              if( !"inline".equals( disposition ) && !"attachment".equals( disposition ) ) {
904//                      final String errMsg = "disposition には、inline か attachment 以外は指定できません。"
905//                                              + "disposition=[" + disposition + "]" ;
906//                      throw new HybsSystemException( errMsg );
907//              }
908//      }
909
910        /**
911         * 【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします
912         *              (初期値:FILE_URL[={@og.value SystemData#FILE_URL}])。
913         *
914         * @og.tag
915         * この属性で指定されるディレクトリに、ファイルをセーブします。
916         * 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
917         * ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
918         * システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。
919         * fileURL = "{&#064;USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
920         * さらに、各個人ID別のフォルダを作成して、そこにセーブします。
921         *
922         * @og.rev 3.5.4.3 (2004/01/05) 新規作成
923         * @og.rev 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用
924         * @og.rev 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。
925         * @og.rev 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。
926         *
927         * @param       url 雛型ディレクトリ名
928         */
929        public void setRefFileURL( final String url ) {
930                final String furl = nval( getRequestParameter( url ),null );
931                if( furl != null ) {
932                        refFileURL = StringUtil.urlAppend( refFileURL,furl );
933                }
934        }
935
936        /**
937         * 【TAG】EXCEL雛型参考ファイル名をセットします。
938         *
939         * @og.tag
940         * 内部処理的には、雛形ファイルの雛形シートをメモリ上に構築し、
941         * そのシートのセルに、データを追加していきます。
942         * 最後には、雛形シートとして存在しない部分は、すべて削除します。
943         * 雛形シートを使わない場合は、新規シートに追加していくことになります。
944         * appendモードの場合は、オリジナルが雛形ファイルになります。
945         * 雛形ファイルの指定は、無効になります。
946         * ※ 互換性の為、同じ名前の設定は有効です。
947         *
948         * ※ Excel2007形式(XSSF)では、行全体を指定した色や罫線は、
949         * セルとして認識されません。範囲指定で、罫線や色付けを行う必要があります。
950         *
951         * @og.rev 3.5.4.3 (2004/01/05) 新規作成
952         *
953         * @param   filename 雛型ファイル名
954         */
955        public void setRefFilename( final String filename ) {
956                refFilename = nval( getRequestParameter( filename ),refFilename );
957        }
958
959        /**
960         * 【TAG】EXCEL雛型参考ファイルのシート名を設定します。
961         *
962         * @og.tag
963         * EXCELファイルを書き出す時に、雛型として参照するシート名を指定します。
964         * これにより、複数の形式の異なるデータを順次書き出したり(appendモードを併用)する
965         * ことや、シートを指定して新規にEXCELを作成する場合にフォームを設定する事が可能になります。
966         * 初期値は、null(第一シート) です。
967         *
968         * @og.rev 3.5.4.3 (2004/01/05) 新規追加
969         *
970         * @param   sheet 雛型シート名
971         */
972        public void setRefSheetName( final String sheet ) {
973                refSheetName = nval( getRequestParameter( sheet ),refSheetName );
974        }
975
976        /**
977         * 【TAG】雛形のシート名を、そのまま使用する(true)か、新規、または、外部指定のシート名を使用する(false)を指定します。(初期値:false[外部指定のシート名を使用])。
978         *
979         * @og.tag
980         * ※ Ver5では、追記モード時に、指定シートが存在した場合は上書きします(初期値:false[上書きしない])。5.9.12.1 (2016/09/09)
981         *    Ver6では、追記モード時に、雛形を指定できないため、雛形のシート名を、そのまま使用する(true)か、
982         *    新規、または、外部指定のシート名を使用する(false)を指定する属性になります。
983         *
984         * @og.rev 6.5.0.0 (2016/09/30) sheetOverwrite で、雛形シートの使用時に、元のシート名を使用します。
985         *
986         * @param   flag 元のシート名を使用するかどうか [true:使用する/false:新規、または、外部指定のシート名を使用]
987         */
988        public void setSheetOverwrite( final String flag ) {
989                sheetOverwrite = nval( getRequestParameter( flag ),sheetOverwrite );
990        }
991
992        /**
993         * 【TAG】EXCELで、出力処理の最後に、セル内の計算式を再計算させるシート名をCSV形式で指定します。
994         *
995         * @og.tag
996         * 通常は利用する必要はありません。
997         * 一覧結果を利用した集計用シートを別に持っているような雛形を利用した出力で利用します。
998         *
999         * @og.rev 6.5.0.0 (2016/09/30) recalcSheetName で、セル内の計算式を再計算させるシート名を指定。5.9.12.1 (2016/09/09)
1000         *
1001         * @param   sheet 対象シート名(CSV形式文字)
1002         */
1003        public void setRecalcSheetName( final String sheet ) {
1004                recalcSheetName = nval( getRequestParameter( sheet ),recalcSheetName );
1005        }
1006
1007        /**
1008         * 【TAG】EXCEL出力時のデフォルトフォント名を設定します
1009         *              (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[={@og.value SystemData#TABLE_WRITER_DEFAULT_FONT_NAME}])。
1010         *
1011         * @og.tag
1012         * これは、EXCEL追加機能として実装されています。
1013         *
1014         * EXCELファイルを書き出す時に、デフォルトフォント名を指定します。
1015         * フォント名は、EXCELのフォント名をそのまま使用してください。
1016         * 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontName( String )
1017         * に設定されます。
1018         * (初期値:システム定数のTABLE_WRITER_DEFAULT_FONT_NAME[={@og.value SystemData#TABLE_WRITER_DEFAULT_FONT_NAME}])。
1019         *
1020         * @og.rev 3.8.5.3 (2006/08/07) 新規追加
1021         *
1022         * @param   name デフォルトフォント名
1023         * @see         org.opengion.hayabusa.common.SystemData#TABLE_WRITER_DEFAULT_FONT_NAME
1024         */
1025        public void setFontName( final String name ) {
1026                fontName = nval( getRequestParameter( name ),fontName );
1027        }
1028
1029        /**
1030         * 【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します
1031         *              (初期値:TABLE_WRITER_DEFAULT_FONT_POINTS[={@og.value SystemData#TABLE_WRITER_DEFAULT_FONT_POINTS}])。
1032         *
1033         * @og.tag
1034         * これは、EXCEL追加機能として実装されています。
1035         *
1036         * EXCELファイルを書き出す時に、デフォルトポイント数を指定します。
1037         * 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontHeightInPoints( short )
1038         * に設定されます。
1039         * (初期値:システム定数のTABLE_WRITER_DEFAULT_FONT_POINTS[={@og.value SystemData#TABLE_WRITER_DEFAULT_FONT_POINTS}])。
1040         *
1041         * @og.rev 3.8.5.3 (2006/08/07) 新規追加
1042         *
1043         * @param   point フォントポイント数
1044         * @see         org.opengion.hayabusa.common.SystemData#TABLE_WRITER_DEFAULT_FONT_POINTS
1045         */
1046        public void setFontPoint( final String point ) {
1047                fontPoint = nval( getRequestParameter( point ),fontPoint );
1048        }
1049
1050        /**
1051         * 【TAG】ファイル出力時に、行番号情報を、出力する/しない[true/false]を指定します(初期値:true)。
1052         *
1053         * @og.tag
1054         * 通常のフォーマットでは、各行の先頭に行番号を出力します。
1055         * これは、#NAME 属性を使用する場合には、必ず出力する必要があります。
1056         * (#NAME 属性は、読み取り時にあれば、自動的にカラムに割り当てられます。)
1057         * この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力等)
1058         * の為に出力する場合に、false を設定することで、行番号列を出力しない
1059         * ようにできます。
1060         * 初期値は、true(出力する) です。
1061         *
1062         * @og.rev 3.7.0.2 (2005/02/14) 新規追加
1063         *
1064         * @param   useNo 行番号情報 [true:出力する/false:しない]
1065         */
1066        public void setUseNumber( final String useNo ) {
1067                useNumber = nval( getRequestParameter( useNo ),useNumber );
1068        }
1069
1070        /**
1071         * 【TAG】書き込み先ファイルのカラム列を、外部(タグ)よりCSV形式で指定します。
1072         *
1073         * @og.tag
1074         * この指定により、書き込むカラムを限定的に使用することが可能です。
1075         * カラム名は、検索したDBTableModel上に含まれる名前で指定する必要があります。
1076         * 別名で書き込みたい場合は、予めその名前で検索しておく必要があります。
1077         * カラム名を指定しない場合(例えば ,,, など)は、カラムを書き飛ばします。
1078         *
1079         * @og.rev 4.0.0.0 (2005/12/31) 新規作成
1080         *
1081         * @param   clms 書込カラム列 (CSV形式)
1082         */
1083        public void setColumns( final String clms ) {
1084                columns = nval( getRequestParameter( clms ),columns );
1085        }
1086
1087        /**
1088         * 【TAG】書き込み対象外のカラム列を、外部(タグ)よりCSV形式で指定します。
1089         *
1090         * @og.tag
1091         * 指定するカラム名に対して、書き込み処理を行いません。
1092         * ここで指定するカラム名は、検索したDBTableModel上に含まれる必要はありません。
1093         * その場合は、ここでの指定は無視されます。
1094         *
1095         * @og.rev 6.1.0.0 (2014/12/26) omitNames 属性を追加
1096         *
1097         * @param   clms 書込対象外カラム列 (CSV形式)
1098         */
1099        public void setOmitNames( final String clms ) {
1100                omitNames = nval( getRequestParameter( clms ),omitNames );
1101        }
1102
1103        /**
1104         * 【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します
1105         *              (初期値:USE_TABLE_WRITER_RENDERER[={@og.value SystemData#USE_TABLE_WRITER_RENDERER}])。
1106         *
1107         * @og.tag
1108         * コードリソースをそのままの値で出力すると、数字や記号になり何が書かれているのか
1109         * 不明になります。
1110         * これは、コードリソースをラベルに変換して出力するかどうかを指定します。
1111         * 当然、コードはユニークですが、ラベルはユニークになるかどうか保障はされていませんので
1112         * TableReader 系で読み込む場合には、リスクが発生します。
1113         * また、TableReader 系で読み込む場合にも、ラベルからコードを求める逆変換を行うように、
1114         * setUseRenderer メソッドで指定する必要があります。
1115         *
1116         * 従来は、TableWriter 系に、TableWriter_Renderer 系のクラスを作って対応していましたが、
1117         * このメソッドの属性値のフラグで、制御します。
1118         * (初期値:システム定数のUSE_TABLE_WRITER_RENDERER[={@og.value SystemData#USE_TABLE_WRITER_RENDERER}])。
1119         *
1120         * @og.rev 5.2.1.0 (2010/10/01) 新規作成
1121         *
1122         * @param  flag ラベル変換可否 [true:する/false:しない]
1123         * @see         org.opengion.hayabusa.common.SystemData#USE_TABLE_WRITER_RENDERER
1124         */
1125        public void setUseRenderer( final String flag ) {
1126                useRenderer = nval( getRequestParameter( flag ),useRenderer );
1127        }
1128
1129        /**
1130         * 【TAG】(通常は使いません)EXCEL出力時のデータの書き込み開始行番号を設定します(初期値:0)。
1131         *
1132         * @og.tag
1133         * EXCELのデータの書き込みの開始行番号を指定します。
1134         * 属性名は、行を飛ばす処理ということで、readTable タグと同じ名称です。
1135         * ファイルの先頭行が、0行としてカウントしますので、設定値は、読み飛ばす
1136         * 件数になります。(1と指定すると、1行読み飛ばし、2行目から読み込みます。)
1137         * 行の読み飛ばしと、カラムの読み飛ばし(columns)、refFileURL、refFilename、
1138         * refSheetName とともに使用すれば、ある程度のレイアウト設定が可能です。
1139         * 現時点では、Excel の場合のみ有効です。
1140         *
1141         * @og.rev 5.7.9.0 (2014/08/08) 新規作成
1142         *
1143         * @param       count 書き込み開始行番号
1144         */
1145        public void setSkipRowCount( final String count ) {
1146                skipRowCount = nval( getRequestParameter( count ),skipRowCount );
1147        }
1148
1149        /**
1150         * 【TAG】EXCEL出力時に、データを書き込んだ範囲に罫線を入れるかどうかを指定します(初期値:false)。
1151         *
1152         * @og.tag
1153         * データを書き込んでEXCELを作成しても、ノーマルのセルに値がセットされている
1154         * だけなので、ある程度加工が必要です。
1155         * そこで、データのセットされたセルに罫線を入れることで、それなりのデータが
1156         * 出力された感じになります。
1157         * この設定と、useAutoCellSize="true" で、セルの幅を自動調整すれば、見栄えが良くなります。
1158         * なお、この機能は、TableWriter_Excel のみに実装します。
1159         *
1160         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1161         *
1162         * @param       useStyle 罫線追記 [true:する/false:しない]
1163         * @see         #setUseAutoCellSize( String )
1164         */
1165        public void setUseCellStyle( final String useStyle ) {
1166                useCellStyle = nval( getRequestParameter( useStyle ),useCellStyle );
1167        }
1168
1169        /**
1170         * 【TAG】EXCEL出力時に、セルの幅をデータの幅に自動的に合わせるかどうかを指定します(初期値:false)。
1171         *
1172         * @og.tag
1173         * データを書き込んでEXCELを作成しても、ノーマルのセルに値がセットされている
1174         * だけなので、ある程度加工が必要です。
1175         * そこで、データのセットされたセルの幅を自動調整することで、それなりのデータが
1176         * 出力された感じになります。
1177         * この設定と、useCellStyle="true" で、セルの罫線を自動設定すれば、見栄えが良くなります。
1178         * なお、この機能は、TableWriter_Excel のみに実装します。
1179         *
1180         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1181         *
1182         * @param       useAutoSize 幅の自動的調整 [true:する/false:しない]
1183         * @see         #setUseCellStyle( String )
1184         */
1185        public void setUseAutoCellSize( final String useAutoSize ) {
1186                useAutoCellSize = nval( getRequestParameter( useAutoSize ),useAutoCellSize );
1187        }
1188
1189        /**
1190         * 【TAG】EXCEL出力時に、セルの有効範囲を設定するかどうかを指定します(初期値:false)。
1191         *
1192         * @og.tag
1193         * セルの有効範囲というのは、EXCELでの 空行、空列の存在しない範囲を指します(初期値:false)。
1194         * 通常、空行でも、データとして残っている場合は、EXCELのセルオブジェクトは存在します。
1195         * ここで、useActiveWorkbook="true" とすると、空行、空列を削除します。
1196         *
1197         * 雛形を使用した場合は、データより多めに設定した計算などは、この処理で
1198         * 削除されますので、データサイズにフィットさせることができます。
1199         * なお、この機能は、TableWriter_Excel のみに実装します。
1200         *
1201         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1202         *
1203         * @param       useActWB 有効範囲の設定 [true:する/false:しない]
1204         */
1205        public void setUseActiveWorkbook( final String useActWB ) {
1206                useActiveWorkbook = nval( getRequestParameter( useActWB ),useActiveWorkbook );
1207        }
1208
1209        /**
1210         * 【TAG】EXCEL出力時に、シート変更するキーとなるカラム名を指定します(このカラムの値がシート名になります)。
1211         *
1212         * @og.tag
1213         * EXCEL帳票では、帳票雛形に、PAGE_BRAKE キーを設定しましたが、TableWriterでは、
1214         * メモリ上のカラムの値が変更したときに、シート変更させることができます。
1215         * このカラムの値がキーブレイクすると、新しいシートに書き出し始めます。
1216         * シート名は、このカラムの値(キーブレイクする値)です。
1217         *
1218         * 雛形ファイルを使用する場合、雛形シートもキーブレイクに伴って、+1されます。
1219         * つまり、雛形シートとデータシートは同時に変更されます。
1220         * ただし、雛形シートは、最後の雛形シートで止まります。
1221         * これは、雛形シートにヘッダー雛形とボディ雛形を用意しておき、最初のキーブレイクで
1222         * ヘッダーからボディの書き込みにチェンジするイメージで使用できます。
1223         * なお、この機能は、TableWriter_Excel のみに実装します。
1224         *
1225         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1226         *
1227         * @param       pbColumn シート変更カラム名
1228         * @see         #setFileBreakColumn( String )
1229         */
1230        public void setPageBreakColumn( final String pbColumn ) {
1231                pageBreakColumn = nval( getRequestParameter( pbColumn ),pageBreakColumn );
1232        }
1233
1234        /**
1235         * 【TAG】EXCEL出力時に、ファイル名を変更するキーとなるカラム名を指定します(このカラムの値がファイル名になります)。
1236         *
1237         * @og.tag
1238         * EXCEL帳票では、メモリ上のカラムの値が変更したときに、ファイル名を変更することができます。
1239         * このカラムの値がキーブレイクすると、新しいファイルに書き出し始めます。
1240         * ファイル名は、このカラムの値(キーブレイクする値)+ 元の出力ファイル名の拡張子(.xlsなど)です。
1241         * この設定を使用する場合は、出力ファイル名は無視されますが、拡張子だけは使用されます。
1242         *
1243         * 雛形ファイルを使用する場合、雛形ファイルもキーブレイクに伴って、再利用されます。
1244         * 例えば、pageBreakColumn と併用する場合、キーブレイクで雛形シートも最初から適用になります。
1245         * なお、この機能は、TableWriter_Excel のみに実装します。
1246         *
1247         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1248         *
1249         * @param       fbColumn ファイルブレイクカラム
1250         * @see         #setPageBreakColumn( String )
1251         */
1252        public void setFileBreakColumn( final String fbColumn ) {
1253                fileBreakColumn = nval( getRequestParameter( fbColumn ),fileBreakColumn );
1254        }
1255
1256        /**
1257         * 【TAG】EXCEL出力時に、Hyperlinkを作成するキーとなる「カラム名:値」形式のカラム名を指定します。
1258         *
1259         * @og.tag
1260         * ここで、作成するハイパーリンクは、EXCELのシートに対するハイパーリンクです。
1261         * それ以外のリンク(本当のURLやファイル等)のリンクは(今は)作成できません。
1262         * ハイパーリンクを作成するには、①作成するカラム と ②作成する値 が必要です。
1263         * このメソッドで設定するのは、「①:②」という形式でカラム名を指定します。
1264         * ②がなければ、①と同じとします。
1265         * ②の値のシートの存在有無は、無視します。ハイパーリンクを作成するシートを作成する前に
1266         * ハイパーリンクを作成するケースが存在します。
1267         * (例えば、各シートへのリンクを持った一覧を作成してから、明細の各シートを作成する様なケース)
1268         * なお、この機能は、TableWriter_Excel のみに実装します。
1269         *
1270         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1271         *
1272         * @param       hlColumn リンク作成カラム名 (「カラム名:値」形式)
1273         */
1274        public void setHyperLinkColumn( final String hlColumn ) {
1275                hyperLinkColumn = nval( getRequestParameter( hlColumn ),hyperLinkColumn );
1276        }
1277
1278        /**
1279         * 【TAG】EXCEL出力時に、Sheet一覧を作成する場合のSheet名を指定します。
1280         *
1281         * @og.tag
1282         * これは、Workbook に含まれる Sheet 一覧を作成する場合に、利用可能です。
1283         * なお、この機能は、TableWriter_Excel のみに実装します。
1284         *
1285         * @og.rev 6.0.2.0 (2014/09/19) 新規作成
1286         *
1287         * @param       sheetName タイトルシート名
1288         */
1289        public void setAddTitleSheet( final String sheetName ) {
1290                addTitleSheet = nval( getRequestParameter( sheetName ),addTitleSheet );
1291        }
1292
1293        /**
1294         * 【TAG】チェック行のみを対象にするかを指定します(初期値:true)。
1295         *
1296         * @og.tag
1297         * falseを指定する事で、前画面でチェックした行のみを出力します。
1298         * 初期値は全ての行を出力(true)です。
1299         * 出力されるファイルの行番号は、1から振りなおされます。
1300         *
1301         * @og.rev 5.5.5.5 (2012/08/24) 新規作成
1302         *
1303         * @param   flag 対象にするか [true:全件/false:対象のみ]
1304         */
1305        public void setSelectedAll( final String flag ) {
1306                selectedAll = nval( getRequestParameter( flag ),selectedAll );          // 5.5.9.1 (2012/12/07) バグ対応
1307        }
1308
1309        /**
1310         * 【TAG】事前にファイルを削除するかどうかを指定します(初期値:false)。
1311         *
1312         * @og.tag
1313         * 出力元の DBTableModel が、存在しないか、0件の場合、過去に作成したファイルが
1314         * そのまま、残っていると、不要なトラブルのもととなる為、実行前に削除するか
1315         * どうかを指定できます。
1316         * なお、fileAppend="true"(追加モードで書き込むを指定)時には、データが0件でも
1317         * 事前削除は行いません。
1318         * 初期値は互換性のため削除しない(false)です。
1319         *
1320         * @og.rev 5.5.9.1 (2012/12/07) 新規作成
1321         *
1322         * @param   flag 事前削除するかどうか [true:削除する/false:削除しない]
1323         */
1324        public void setBeforeDelete( final String flag ) {
1325                beforeDelete = nval( getRequestParameter( flag ),beforeDelete );
1326        }
1327
1328        /**
1329         * WriteTable オブジェクトに渡すパラメータオブジェクトをセットします。
1330         *
1331         * WriteTableParamTag クラスよりセットされます。
1332         *
1333         * @og.rev 4.0.0.0 (2005/02/28) 新規追加
1334         *
1335         * @param   entry HybsEntryオブジェクト
1336         */
1337        protected void addParam( final HybsEntry entry ) {
1338                if( param == null ) { param = new ArrayList<>(); }
1339                param.add( entry );
1340        }
1341
1342        /**
1343         * このオブジェクトの文字列表現を返します。
1344         * 基本的にデバッグ目的に使用します。
1345         *
1346         * @return このクラスの文字列表現
1347         * @og.rtnNotNull
1348         */
1349        @Override
1350        public String toString() {
1351                return ToString.title( this.getClass().getName() )
1352                                .println( "VERSION"                     ,VERSION                )
1353                                .println( "BASE_URL"            ,BASE_URL               )
1354                                .println( "separator"           ,separator              )
1355                                .println( "headerSequence"      ,headerSequence )
1356                                .println( "fileURL"                     ,fileURL                )
1357                                .println( "filename"            ,filename               )
1358                                .println( "refFileURL"          ,refFileURL             )
1359                                .println( "refFilename"         ,refFilename    )
1360                                .println( "encode"                      ,encode                 )
1361                                .println( "writerClass"         ,writerClass    )
1362                                .println( "fileAppend"          ,fileAppend             )
1363//                              .println( "direct"                      ,direct                 )               // 6.9.5.0 (2018/04/23) 物理的に廃止
1364                                .println( "zip"                         ,zip                    )
1365                                .println( "zipFilename"         ,zipFilename    )               // 6.0.4.0 (2014/11/28)
1366//                              .println( "disposition"         ,disposition    )               // 6.9.5.0 (2018/04/23) 物理的に廃止
1367                                .println( "tableId"                     ,tableId                )
1368                                .println( "sheetName"           ,sheetName              )
1369                                .println( "refSheetName"        ,refSheetName   )
1370                                .println( "useNumber"           ,useNumber              )
1371                                .println( "Other..."    ,getAttributes().getAttribute() )
1372                                .fixForm().toString() ;
1373        }
1374}