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.util.Closer ;
025import org.opengion.fukurou.util.StringUtil ;
026import static org.opengion.fukurou.util.StringUtil.nval ;
027
028import javax.servlet.ServletResponse ;
029import javax.servlet.http.HttpServletResponse ;
030import javax.servlet.jsp.JspWriter ;
031
032import java.util.zip.GZIPOutputStream;
033import java.util.zip.ZipOutputStream;
034import java.util.zip.ZipEntry;
035import java.util.List;
036import java.util.ArrayList;
037import java.util.Locale;
038import java.io.File;
039import java.io.OutputStream;
040import java.io.PrintWriter;
041import java.io.FileOutputStream;
042import java.io.ByteArrayOutputStream;
043import java.io.ObjectOutputStream;
044import java.io.ObjectInputStream;
045import java.io.IOException;
046
047/**
048 * DBTableModelオブジェクトを指定のファイルに出力するタグです。
049 *
050 * データ(DBTableModel)と、コントローラ(WriteTableTagForm)を与えて、
051 * 外部からコントロールすることで、各種形式で データ(DBTableModel)を表示できます。
052 * writeTableタグ に対して、コマンドを与えることにより、内部のコントローラの
053 * 実装に対応した、 形式でデータを作成します。
054 *
055 * @og.formSample
056 * ●形式:
057 *     <og:writeTable
058 *         fileURL   = "{@USER.ID}"    保存先ディレクトリ名
059 *         filename  = "{@filename}"   保存ファイル名
060 *         encode    = "UnicodeLittle"      保存ファイルエンコード名
061 *     />
062 *
063 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
064 *
065 * ●Tag定義:
066 *   <og:writeTable
067 *       writerClass        【TAG】実際に書き出すクラス名の略称(TableWriter_**** クラスの ****)を指定します(初期値:Default)
068 *       separator          【TAG】可変長ファイルを作成するときの項目区切り文字をセットします (初期値:TableWriter#TAB_SEPARATOR[= ])
069 *       headerSequence     【TAG】DBTableModelの出力順(LNSCD など)をセットします
070 *       fileURL            【TAG】ファイル保存先ディレクトリ名を指定します
071 *       filename           【TAG】ファイルを作成するときのファイル名をセットします (初期値:FILE_FILENAME[=UnicodeLittle])
072 *       sheetName          【TAG】EXCELファイルを書き出すときのシート名を設定します
073 *       beforeDelete       【TAG】事前にファイルを削除するかどうかをセットします (初期値:false)
074 *       encode             【TAG】ファイルを作成するときのファイルエンコーディング名をセットします (初期値:FILE_ENCODE[=UnicodeLittle])
075 *       fileAppend         【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])
076 *       direct             【廃止】結果をダイレクトにEXCEL起動するかどうか[true/false]を指定します(初期値:false[ファイル])
077 *       zip                【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)
078 *       tableId            【TAG】(通常使いません)sessionから所得する DBTableModelオブジェクトの ID
079 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session)
080 *       disposition        【TAG】Content-Disposition (inline:埋め込む/attachment:ダイアログを起動)を指定します(初期値:attachment)
081 *       refFileURL         【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします
082 *       refFilename        【TAG】EXCEL雛型参考ファイル名をセットします
083 *       refSheetName       【TAG】EXCEL雛型参考ファイルのシート名を設定します
084 *       sheetOverwrite     【TAG】EXCELでsheetNameでの指定シート名に対して上書きを行うかどうかを指定します。
085 *       recalcSheetName    【TAG】EXCELで、出力処理の最後にセルの計算式の再計算をさせるシート名をカンマ区切りで指定します。
086 *       useNumber          【TAG】行番号情報を、出力する/しない[true/false]を指定します(初期値:true)
087 *       columns            【TAG】書き込み先ファイルのカラム列を、外部(タグ)より指定します
088 *       useRenderer        【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します (初期値:USE_TABLE_WRITER_RENDERER[=false])
089 *       selectedAll        【TAG】チェック行のみを対象にするかを指定します(初期値:true)。
090 *       fontName           【TAG】EXCEL出力時のデフォルトフォント名を設定します (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[=MS Pゴシック])
091 *       fontPoint          【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します(初期値:TABLE_WRITER_DEFAULT_FONT_POINTS[=11])
092 *       skipRowCount       【TAG】(通常は使いません)データの書き込み開始位置を設定します
093 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
094 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
095 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
096 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:true) 5.7.7.2 (2014/06/20)
097 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:true) 5.7.7.2 (2014/06/20)
098 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
099 *   >   ... Body ...
100 *   </og:writeTable>
101 *
102 * ●使用例
103 *     <og:writeTable ・・・・・ >
104 *         <og:writeTableParam
105 *             key  = "Tablename"  value="GE12"
106 *         />
107 *         <og:writeTableParam
108 *             key  = "First"             First:最初に登録
109 *         >
110 *                      insert into GE12bk
111 *                         select * from GE12
112 *                         where SYSTEM_ID='**'
113 *         </og:writeTableParam
114 *         <og:writeTableParam
115 *             key  = "First"             First:の2番目に登録
116 *         >
117 *              delete from GE12 where SYSTEM_ID='**' and KBSAKU='0'
118 *         </og:writeTableParam
119 *         <og:writeTableParam
120 *             key  = "Last"              Last:最後に登録
121 *         >
122 *              update GE12 set XXXX='YYYY' where SYSTEM_ID='**' and KBSAKU='0'
123 *         </og:writeTableParam
124 *     </og:writeTableParam
125 *
126 * @og.group ファイル出力
127 *
128 * @version  4.0
129 * @author   Kazuhiko Hasegawa
130 * @since    JDK5.0,
131 */
132public class WriteTableTag extends CommonTagSupport {
133        //* このプログラムのVERSION文字列を設定します。   {@value} */
134        private static final String VERSION = "5.7.9.0 (2014/08/08)" ;
135
136        private static final long serialVersionUID = 579020140808L ;
137
138        private final String  BASE_URL  = HybsSystem.sys( "FILE_URL" );
139
140        private String  separator               = TableWriter.TAB_SEPARATOR;     // 項目区切り文字
141//      private String  headerSequence  = null;                         // ヘッダー項目の並び順
142        private String  headerSequence  = HybsSystem.sys( "TABLE_WRITER_DEFAULT_HEADERSEQ" );   // 5.9.20.2 (2017/05/19)
143        private String  fileURL                 = BASE_URL;
144        private String  filename                = HybsSystem.sys( "FILE_FILENAME" );   // ファイル名
145        private String  sheetName               = "Sheet1" ;            // 3.5.4.2 (2003/12/15)
146        private String  refFileURL              = BASE_URL;                     // 3.5.4.3 (2004/01/05)
147        private String  refFilename     = null;                         // 3.5.4.3 (2004/01/05)
148        private String  refSheetName    = null ;                        // 3.5.4.3 (2004/01/05)
149        private String  fontName                = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_NAME" );                   // 3.8.5.3 (2006/08/07)
150        private String  fontPoint               = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_POINTS" );                 // 3.8.5.3 (2006/08/07)
151        private String  encode                  = HybsSystem.sys( "FILE_ENCODE" );      // ファイルエンコーディング  "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS"
152        private String  writerClass     = HybsSystem.sys( "TABLE_WRITER_DEFAULT_CLASS" );               // 3.8.5.3 (2006/08/07)
153        private boolean fileAppend              = false;                        // ファイルをAPPENDモードで出力するか
154        private boolean direct                  = false;
155        private boolean zip                     = false;
156        private String  disposition     = "attachment";         // 3.8.0.9 (2005/10/17) Content-Disposition 初期値変更 inline ⇒ attachment
157
158        private transient DBTableModel table      = null;
159        private String  tableId                 = HybsSystem.TBL_MDL_KEY ;
160        private String  directory               = null ;                        // 3.8.6.0 (2006/08/23)
161
162        private transient List<HybsEntry> param   = null ;                // 4.0.0 (2005/02/28)
163
164        private boolean useNumber               = true;                         // 3.7.0.2 (2005/02/14)
165        // 4.0.0 (2005/12/31) 外部よりカラム列(カンマ区切り)を指定できるようにする。
166        private String          columns         = null;
167        // 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか
168        private boolean useRenderer             = HybsSystem.sysBool( "USE_TABLE_WRITER_RENDERER" );    // 5.2.1.0 (2010/10/01)
169        
170        // 5.5.5.5 (2012/08/24) チェック対応
171        private boolean selectedAll             = true;                         // 5.5.5.5 (2012/08/24)
172
173        // 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。互換性のため、false に設定。推奨は、true
174        private boolean beforeDelete    = false;                        // 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。
175
176        private int             skipRowCount    = 0;                            // 5.7.9.0 (2014/08/08) データの書き込み開始位置設定
177        
178        // 5.9.12.1 (2016/09/09)
179        private boolean sheetOverwrite  = false;        // 5.9.12.1(2016/09/09)
180        private String recalcSheetName; // 5.9.12.1 (2016/09/09)
181
182        /**
183         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
184         *
185         * @og.rev 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか(beforeDelete)フラグを追加
186         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
187         *
188         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
189         */
190        @Override
191        public int doStartTag() {
192                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
193                if( !useTag() ) { return SKIP_BODY ; }
194
195                directory = HybsSystem.url2dir( fileURL );              // 5.5.9.1 (2012/12/07) doEndTag() から移動
196
197                // 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか
198                if( beforeDelete && !fileAppend ) {
199                        File delFile = null;
200                        if( zip ) { delFile = new File( directory,filename + ".zip" ); }
201                        else      { delFile = new File( directory,filename ); }
202                        if( delFile.exists() ) { delFile.delete(); }
203                }
204
205                return EVAL_BODY_BUFFERED ;     // Body を評価する。( extends BodyTagSupport 時)
206        }
207
208        /**
209         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
210         *
211         * @og.rev 2.1.3.1 (2002/12/13) ContentType を、x-msexcel から vnd.ms-excel に変更した。
212         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
213         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
214         * @og.rev 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。
215         * @og.rev 3.2.0.0 (2003/05/22) GZIPOutputStream を使用していたが、ZipOutputStream に変更。
216         * @og.rev 3.5.4.1 (2003/12/01) 引数の PrintWriter を、OutputStream に変更。
217         * @og.rev 3.5.4.3 (2004/01/05) 引数を、 PrintWriter に戻す。
218         * @og.rev 3.6.0.2 (2004/10/04) EXCELダイレクト出力時にファイルエンドまで出力されない不具合対策
219         * @og.rev 3.8.0.9 (2005/10/17) disposition属性を使用できるように変更します。
220         * @og.rev 3.8.6.0 (2006/08/23) フォルダがない場合は、複数階層分のフォルダを自動で作成します。
221         * @og.rev 4.3.4.3 (2008/12/22) Excel出力の判別方法を前方一致に変更
222         * @og.rev 5.1.6.0 (2010/05/01) 画面帳票作成機能対応
223         * @og.rev 5.5.2.0 (2012/05/01) ZIP時にもencodeが有効にする
224         * @og.rev 5.5.5.5 (2012/08/24) selectedAllの処理を追加
225         * @og.rev 5.5.9.1 (2012/12/07) beforeDeleteフラグの追加に伴う、ロジック変更
226         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
227         *
228         * @return      後続処理の指示
229         */
230        @Override
231        public int doEndTag() {
232                debugPrint();           // 4.0.0 (2005/02/28)
233
234                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
235                if( !useTag() ) { return EVAL_PAGE ; }
236
237                table = (DBTableModel)getObject( tableId );
238                if( ! selectedAll ){ // 5.5.5.5 (2012/08/24) 
239                        table = getSelRowsTable( table );
240                }
241                if( table != null && table.getRowCount() > 0 ) {
242
243                        File dir = new File(directory);
244                        if( ! dir.exists() && ! dir.mkdirs() ) {
245                                String errMsg = "ディレクトリの作成に失敗しました。[" + directory + "]";
246                                throw new HybsSystemException( errMsg );
247                        }
248
249                        PrintWriter pw = null;
250                        ByteArrayOutputStream bt = null ;
251                        try {
252                                if( direct ) {
253                                        if( zip ) {
254                                                bt = new ByteArrayOutputStream();
255                                                pw = new PrintWriter( bt );
256                                                create( pw ) ;
257                                                pw.flush();                             // 3.6.0.2 (2004/10/04)
258                                                ServletResponse response = pageContext.getResponse() ;
259                                                ((HttpServletResponse)response).addHeader( "Content-Encoding","gzip" );
260
261                                                GZIPOutputStream gzip = new GZIPOutputStream(bt);
262                                                gzip.finish() ;
263                                                response.setContentLength( bt.size() );
264
265                                                JspWriter out = pageContext.getOut();
266                                                out.clear();
267                                                out.print( bt );
268                                                out.flush();                    // 3.6.0.2 (2004/10/04)
269                                        }
270                                        else {
271                                                bt = new ByteArrayOutputStream();
272                                                pw = new PrintWriter( bt );
273                                                create( pw ) ;
274                                                pw.flush();                             // 3.6.0.2 (2004/10/04)
275                                                ServletResponse response = pageContext.getResponse() ;
276                                                response.setContentType( "application/vnd.ms-excel; charset=" + encode );
277        //                                      response.setContentType( "application/x-msexcel; charset=" + encode );
278        //                                      response.setContentType( "text/comma-separated-values ; charset=" + encode );
279        //                                      ((HttpServletResponse)response).setHeader( "contentType","application/x-msexcel; charset=Shift_JIS" );
280        //                                      ((HttpServletResponse)response).setHeader( "Content-Disposition","attachment; filename=\"" + filename + "\"" );
281        //                                      ((HttpServletResponse)response).setHeader( "Content-Disposition","inline; filename=\"" + filename + "\"" );
282                                                // 3.8.0.9 (2005/10/17) disposition属性を使用できるように変更します。
283                                                ((HttpServletResponse)response).setHeader( "Content-Disposition",disposition + "; filename=\"" + filename + "\"" );
284
285                                                JspWriter out = pageContext.getOut();
286                                                out.clear();
287                                                out.print( bt );
288                                                out.flush();                    // 3.6.0.2 (2004/10/04)
289                                        }
290                                }
291                                else {
292                                // 3.2.0.0 (2003/05/22) GZIPOutputStream を使用していたが、ZipOutputStream に変更。
293                                        if( zip ) {
294                                                bt = new ByteArrayOutputStream();
295                                                if( writerClass.toUpperCase(Locale.JAPAN).startsWith("EXCEL") // 5.5.2.0(2012/05/01)
296                                                                || writerClass.toUpperCase(Locale.JAPAN).startsWith("CALC") ) {
297                                                        pw = new PrintWriter( bt );
298                                                }
299                                                else{
300                                                        pw = getPrintWriter(bt);
301                                                }
302                                                create( pw ) ;
303                                                pw.flush();                             // 3.6.0.2 (2004/10/04)
304
305                                                ZipOutputStream gzip = null;
306                                                try {
307                                                        gzip = new ZipOutputStream(
308                                                                                        new FileOutputStream(
309                                                                                                StringUtil.urlAppend( directory,filename + ".zip" )));
310                                                        gzip.putNextEntry( new ZipEntry( filename ) );
311                                                        (bt).writeTo( gzip );
312                                                        gzip.finish() ;
313                                                }
314                                                finally {
315                                                        Closer.ioClose( gzip );         // 4.0.0 (2006/01/31) close 処理時の IOException を無視
316                                                }
317                                        }
318                                        else {
319                                                // if( "Excel".equalsIgnoreCase( writerClass ) ) {
320                                                if( writerClass.toUpperCase(Locale.JAPAN).startsWith("EXCEL") // 4.3.4.3 (2008/12/22)
321                                                        ||  writerClass.toUpperCase(Locale.JAPAN).startsWith("CALC") ) { // 5.1.6.0 (2010/05/01)
322                                                        create( null );
323                                                }
324                                                else {
325                                                        pw = getPrintWriter();
326                                                        create( pw );
327                                                        pw.flush();                             // 3.6.0.2 (2004/10/04)
328                                                }
329                                        }
330                                }
331                        }
332                        catch( IOException ex ) {
333                                String errMsg = "テーブル出力時に、IOエラーが発生しました。" + toString();
334                                throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
335                        }
336                        finally {
337                                Closer.ioClose( pw );           // 4.0.0 (2006/01/31) close 処理時の IOException を無視
338                                Closer.ioClose( bt );           // 4.0.0 (2006/01/31) close 処理時の IOException を無視
339                        }
340                }
341
342                return EVAL_PAGE ;
343        }
344
345        /**
346         * タグリブオブジェクトをリリースします。
347         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
348         *
349         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
350         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
351         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
352         * @og.rev 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。
353         * @og.rev 3.5.4.2 (2003/12/15) EXCELのシート名を指定できるように変更。
354         * @og.rev 3.5.4.3 (2004/01/05) EXCEL雛型参照ファイルのURL,filenameを追加します。
355         * @og.rev 3.8.5.3 (2006/08/07) writerClass 属性の初期値をシステムリソースより取得します。
356         * @og.rev 3.8.5.3 (2006/08/07) fontName 属性を追加します。
357         * @og.rev 3.8.5.3 (2006/08/07) fontPoint 属性を追加します。
358         * @og.rev 3.8.6.0 (2006/08/23) directory 属性を追加します。
359         * @og.rev 4.0.0.0 (2005/02/28) XMLファイルにセットする、param を追加。
360         * @og.rev 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか useRenderer 属性追加
361         * @og.rev 5.5.5.5 (2012/08/24) selectedAll属性を追加
362         * @og.rev 5.5.9.1 (2012/12/07) 事前にファイルを削除するかどうか。互換性のため、false に設定。推奨は、true
363         * @og.rev 5.7.9.0 (2014/08/08) データの書き込み開始位置(skipRowCount)を設定
364         * @og.rev 5.9.12.1 (2016/09/09) sheetOverwrite
365         * @og.rev 5.9.20.2 (2017/05/19) headerSequence
366         *
367         */
368        @Override
369        protected void release2() {
370                super.release2();
371                separator               = TableWriter.TAB_SEPARATOR;   // 項目区切り文字
372//              headerSequence  = null;                         // ヘッダー項目の並び順
373                headerSequence  =HybsSystem.sys( "TABLE_WRITER_DEFAULT_HEADERSEQ" );    // 5.9.20.2 (2017/05/19)
374                fileURL                 = BASE_URL;
375                filename                = HybsSystem.sys( "FILE_FILENAME" );   // ファイル名
376                sheetName               = "Sheet1";                     // 3.5.4.2 (2003/12/15)
377                beforeDelete    = false;                        // 5.5.9.1 (2012/12/07)
378                refFileURL              = BASE_URL;                     // 3.5.4.3 (2004/01/05)
379                refFilename     = null;                         // 3.5.4.3 (2004/01/05)
380                refSheetName    = null;                         // 3.5.4.2 (2003/12/15)
381                fontName                = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_NAME" );                   // 3.8.5.3 (2006/08/07)
382                fontPoint               = HybsSystem.sys( "TABLE_WRITER_DEFAULT_FONT_POINTS" );                 // 3.8.5.3 (2006/08/07)
383                encode                  = HybsSystem.sys( "FILE_ENCODE" );       // ファイルエンコーディング  "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS"
384                writerClass     = HybsSystem.sys( "TABLE_WRITER_DEFAULT_CLASS" );               // 3.8.5.3 (2006/08/07)
385                fileAppend              = false;                        // ファイルをAPPENDモードで出力するか
386                direct                  = false;
387                zip                     = false;
388                table                   = null;
389                tableId                 = HybsSystem.TBL_MDL_KEY ;
390                disposition     = "attachment";         // 3.8.0.9 (2005/10/17) 初期値変更 inline ⇒ attachment
391                param                   = null ;                        // 4.0.0 (2005/01/31)
392                useNumber               = true;                         // 3.7.0.2 (2005/02/14)
393                skipRowCount    = 0;                            // 5.7.9.0 (2014/08/08) データの書き込み開始位置を設定
394                directory               = null;                         // 3.8.6.0 (2006/08/23)
395                columns                 = null;                         // 4.0.0 (2005/12/31)
396                useRenderer             = HybsSystem.sysBool( "USE_TABLE_WRITER_RENDERER" );    // 5.2.1.0 (2010/10/01)
397                selectedAll             = true;                         // 5.5.5.5 (2012/08/24)
398                sheetOverwrite  = false;                        // 5.9.12.1 (2016/09/09)
399                recalcSheetName = null;                         // 5.9.12.1 (2016/09/09)
400        }
401
402        /**
403         * TableWriter の実オブジェクトを生成して,OutputStream に書き込みます。
404         *
405         * @og.rev 3.5.4.1 (2003/12/01) 引数の PrintWriter を、OutputStream に変更。
406         * @og.rev 3.5.4.2 (2003/12/15) lang 引数も table と同時に設定します。
407         * @og.rev 3.5.4.2 (2003/12/15) TableWriter のサブクラス名変更。
408         * @og.rev 3.5.4.3 (2004/01/05) EXCEL雛型参考ファイルを指定するように変更。
409         * @og.rev 3.5.4.3 (2004/01/05) 引数を、 PrintWriter に戻す。
410         * @og.rev 3.5.4.5 (2004/01/23) 文字エンコードを渡すように変更する。
411         * @og.rev 3.5.6.0 (2004/06/18) 各種プラグイン関連付け設定を、システムパラメータ に記述します。
412         * @og.rev 3.8.5.3 (2006/08/07) EXCEL時に fontName と fontPoint 属性をセットします。
413         * @og.rev 4.0.0.0 (2005/01/31) キーの指定を、TableWriter. から、TableWriter_ に変更します。
414         * @og.rev 4.0.0.0 (2005/12/31) 外部よりカラム列(カンマ区切り)を指定できるようにする。
415         * @og.rev 5.2.1.0 (2010/10/01) 書込処理でコードリソースのラベル変換を行うかどうか設定 useRenderer 属性追加
416         * @og.rev 5.7.9.0 (2014/08/08) データの書き込み開始位置(skipRowCount)を設定
417         * @og.rev 5.9.12.1 (2016/09/09) sheetOverwrite
418         *
419         * @param   out PrintWriterオブジェクト
420         */
421        private void create( final PrintWriter out )  {
422                // 5.2.1.0 (2010/10/01) writerClass で Renderer系の場合は、useRendererフラグに変更する。
423                if( "ExcelRenderer".equalsIgnoreCase( writerClass ) ) {
424                        writerClass = "Excel" ;
425                        useRenderer = true;
426                }
427                else if( "Renderer".equalsIgnoreCase( writerClass ) ) {
428                        writerClass = "Default" ;
429                        useRenderer = true;
430                }
431
432                String className = HybsSystem.sys( "TableWriter_" + writerClass ) ;             // 4.0.0 (2005/01/31)
433                TableWriter writer = (TableWriter)HybsSystem.newInstance( className );  // 3.5.5.3 (2004/04/09)
434
435                writer.setDBTableModel( table,getLanguage() );
436                writer.setSeparator( separator );
437                writer.setHeaderSequence( headerSequence );
438                writer.setEncode( encode );                                     // 3.5.4.5 (2004/01/23)
439                writer.setAppend( fileAppend );                         // 3.5.4.2 (2003/12/15)
440                if( param != null ) { writer.setParam( param ); }       // 4.0.0 (2005/01/31)
441                writer.setUseNumber( useNumber );                       // 3.7.0.2 (2005/02/14)
442        //      if( columns == null ) {
443        //              columns = (String)getSessionAttribute( HybsSystem.TBL_WRITER_CLMS );
444        //              removeSessionAttribute( HybsSystem.TBL_WRITER_CLMS );
445        //      }
446                writer.setColumns( columns );                           // 4.0.0 (2005/12/31)
447                writer.setUseRenderer( useRenderer );           // 5.2.1.0 (2010/10/01)
448                if( writer.isExcel() ) {                                        // 3.5.4.3 (2004/01/05)
449                        writer.setSheetName( sheetName );
450                        writer.setFilename( StringUtil.urlAppend( directory , filename ) );
451                        if( refFileURL != null && refFilename != null ) {
452                                writer.setRefFilename( StringUtil.urlAppend( HybsSystem.url2dir(refFileURL) , refFilename ) );
453                        }
454                        if( refSheetName != null && fontPoint.length() > 0 ) {               // 5.7.9.0 (2014/08/08) nullチェック
455                                writer.setRefSheetName( refSheetName );
456                        }
457//                      writer.setFontName( nval( fontName,null ) );                            // 3.8.5.3 (2006/08/07)
458                        writer.setFontName( fontName )  ;                                                       // 5.7.9.0 (2014/08/08) nvalはずし
459                        if( fontPoint != null && fontPoint.length() > 0 ) {
460                                writer.setFontPoint( Short.parseShort( fontPoint ) );   // 3.8.5.3 (2006/08/07)
461                        }
462                        writer.setSkipRowCount( skipRowCount );                                         // 5.7.9.0 (2014/08/08)
463                        
464                        writer.setSheetOverwrite( sheetOverwrite );             // 5.9.12.1 (2016/09/09) 
465                        writer.setRecalcSheetName( recalcSheetName );   // 5.9.12.1 (2016/09/09)
466                        
467                        writer.writeDBTable();
468                }
469                else {
470                        writer.writeDBTable( out );
471                }
472        }
473
474        /**
475         * PrintWriter を取得します。
476         *
477         * ここでは、一般的なファイル出力を考慮した PrintWriter を作成します。
478         *
479         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
480         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
481         * @og.rev 3.5.4.1 (2003/12/01) PrintWriter を、OutputStream に変更。
482         * @og.rev 3.5.5.9 (2004/06/07) FileUtil.getBufferedReader を使用
483         * @og.rev 3.7.1.1 (2005/05/23) フォルダがない場合は、複数階層分のフォルダを自動で作成します。
484         * @og.rev 3.8.0.0 (2005/06/07) FileUtil#getPrintWriter を利用。
485         *
486         * @return      ファイル書き出し用のPrintWriterオブジェクト
487         */
488        private PrintWriter getPrintWriter() {
489                if( filename == null ) {
490                        String errMsg = "ファイル名がセットされていません。";
491                        throw new HybsSystemException( errMsg );
492                }
493
494                // ※ 注意 StringUtil.urlAppend を組み込んでいる意図が不明。一旦削除していますが、注意
495                // 3.8.0.0 (2005/06/07) FileUtil#getPrintWriter を利用。
496        //      out = FileUtil.getPrintWriter( StringUtil.urlAppend( directory,filename ),fileAppend,encode);
497                PrintWriter out = FileUtil.getPrintWriter( new File( directory,filename ),encode,fileAppend );
498
499                return out ;
500        }
501
502        /**
503         * PrintWriter を取得します。
504         *
505         * 引数で指定したOutputStreamを利用して出力します。
506         *
507         * @og.rev 5.5.2.0 (2012/05/01) 新規作成
508         *
509         * @param       os      OutputStreamオブジェクト
510         *
511         * @return      指定したstreamに書き出すPrintWriter
512         */
513        private PrintWriter getPrintWriter( final OutputStream os ) {
514                PrintWriter out = FileUtil.getPrintWriter( os,encode );
515
516                return out ;
517        }
518        
519        /**
520         * チェック分のテーブルモデルを再構成します。
521         *
522         * @og.rev 5.5.5.5 (2012/08/24) 新規作成
523         * @og.rev 5.5.9.1 (2012/12/07) 内部処理変更
524         *
525         * @param       oldTable        コピー元テーブルモデル
526         *
527         * @return      チェックした分だけで再構成したテーブルモデル
528         */
529        private DBTableModel getSelRowsTable( final DBTableModel oldTable ) {
530                if( oldTable == null ) { return null; }         // 5.5.9.1 (2012/12/07) 引数のDBTableModelが null の場合の処理。
531
532                DBTableModel newTable = oldTable.newModel();
533                final int[] rowNo = getParameterRows();
534                final int rowCount = rowNo.length ;
535
536                for( int i=0; i<rowCount; i++ ) {
537                        newTable.addValues( oldTable.getValues(rowNo[i]), i );
538                }
539                return newTable;
540        }
541
542        /**
543         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
544         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
545         *
546         * @og.tag
547         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
548         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
549         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
550         * この tableId 属性を利用して、メモリ空間を分けます。
551         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
552         *
553         * @param       id sessionに登録する時の ID
554         */
555        public void setTableId( final String id ) {
556                tableId = nval( getRequestParameter( id ), tableId );
557        }
558
559        /**
560         * 【TAG】可変長ファイルを作成するときの項目区切り文字をセットします
561         *              (初期値:TableWriter#TAB_SEPARATOR[={@og.value TableWriter#TAB_SEPARATOR}])。
562         *
563         * @og.tag 可変長ファイルを作成するときの項目区切り文字をセットします。
564         * (初期値:TableWriter#TAB_SEPARATOR[={@og.value TableWriter#TAB_SEPARATOR}])。
565         *
566         * @param   separator 項目区切り文字
567         * @see         org.opengion.hayabusa.io.TableWriter#TAB_SEPARATOR
568         */
569        public void setSeparator( final String separator ) {
570                this.separator = nval( getRequestParameter( separator ),this.separator );
571        }
572
573        /**
574         * 【TAG】DBTableModelの出力順(LNSCD など)をセットします。
575         *
576         * @og.tag
577         * Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで
578         * 出力順を設定します。
579         *
580         * @param   hs 出力順 (LNSCD など)
581         */
582        public void setHeaderSequence( final String hs ) {
583                String[] headers = getRequestParameterValues( hs );
584                if( headers != null ) {
585                        StringBuilder buf = new StringBuilder();
586                        for( int i=0; i<headers.length; i++ ) {
587                                if( headers[i] != null ) { buf.append( headers[i] ); }
588                        }
589                        headerSequence = buf.toString();
590                }
591        }
592
593        /**
594         * 【TAG】ファイル保存先ディレクトリ名を指定します。
595         *
596         * @og.tag
597         * この属性で指定されるディレクトリに、ファイルをセーブします。
598         * 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
599         * ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
600         * システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。
601         * fileURL = "{&#064;USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
602         * さらに、各個人ID別のフォルダを作成して、そこにセーブします。
603         *
604         * @og.rev 3.5.4.3 (2004/01/05) 内部処理を、makeFileURL に移動。
605         * @og.rev 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用
606         * @og.rev 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。
607         *
608         * @param       url 保存先ディレクトリ名
609         */
610        public void setFileURL( final String url ) {
611                String furl = nval( getRequestParameter( url ),null );
612                if( furl != null ) {
613                        char ch = furl.charAt( furl.length()-1 );
614                        if( ch != '/' && ch != '\\' ) { furl = furl + "/"; }
615                        fileURL = StringUtil.urlAppend( fileURL,furl );
616                }
617        }
618
619        /**
620         * 【TAG】ファイルを作成するときのファイル名をセットします
621         *              (初期値:FILE_ENCODE[={@og.value org.opengion.hayabusa.common.SystemData#FILE_ENCODE}])。
622         *
623         * @og.tag ファイルを作成するときのファイル名をセットします。
624         * (初期値:システム定数のFILE_ENCODE[={@og.value org.opengion.hayabusa.common.SystemData#FILE_ENCODE}])。
625         *
626         * @param   filename ファイル名
627         * @see         org.opengion.hayabusa.common.SystemData#FILE_ENCODE
628         */
629        public void setFilename( final String filename ) {
630                this.filename = nval( getRequestParameter( filename ),this.filename );
631        }
632
633        /**
634         * 【TAG】EXCELファイルを書き出すときのシート名を設定します。
635         *
636         * @og.tag
637         * EXCELファイルを書き出す時に、シート名を指定します。これにより、複数の形式の
638         * 異なるデータを順次書き出したり(appendモードを併用)することや、シートを指定して
639         * 新規にEXCELを作成することが可能になります。
640         * 初期値は、Sheet1 です。
641         *
642         * @og.rev 3.5.4.2 (2003/12/15) 新規追加
643         *
644         * @param   sheet EXCELファイルのシート名
645         */
646        public void setSheetName( final String sheet ) {
647                sheetName = nval( getRequestParameter( sheet ),sheetName );
648        }
649
650        /**
651         * 【TAG】ファイルを作成するときのファイルエンコーディング名をセットします
652         *              (初期値:FILE_ENCODE[={@og.value org.opengion.hayabusa.common.SystemData#FILE_ENCODE}])。
653         *
654         * @og.tag
655         * "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS"
656         * (初期値:システム定数のFILE_ENCODE[={@og.value org.opengion.hayabusa.common.SystemData#FILE_ENCODE}])。
657         *
658         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
659         * @og.rev 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
660         *
661         * @param   enc ファイルエンコーディング名
662         * @see     <a href="http://www.iana.org/assignments/character-sets">IANA Charset Registry</a>
663         * @see         org.opengion.hayabusa.common.SystemData#FILE_ENCODE
664         */
665        public void setEncode( final String enc ) {
666                encode = nval( getRequestParameter( enc ),encode );
667        }
668
669        /**
670         * 【TAG】実際に書き出すクラス名の略称({@og.doc03Link writerClass TableWriter_**** クラスの ****})を指定します(初期値:Default)。
671         *
672         * @og.tag
673         * 実際に書き出すクラス名(の略称)をセットします。
674         * org.opengion.hayabusa.io.TableWriter インターフェースを継承したサブクラスです。
675         * これは、org.opengion.plugin.io 以下の TableWriter_**** クラスの **** を与えます。
676         * 属性クラス定義の {@link org.opengion.hayabusa.io.TableWriter TableWriter} を参照願います。
677         * {@og.doc03Link writerClass TableWriter_**** クラス}
678         *
679         * ExcelRenderer と、Renderer は、特別な名前で、useRenderer 属性に、"true" をセットするのと同じ効果があります。
680         * 実際は、ExcelRenderer ⇒ Excel 、Renderer  ⇒ Default のクラスが呼ばれます。
681         *
682         * @param   writerClass クラス名(の略称)
683         * @see         org.opengion.hayabusa.io.TableWriter  TableWriterのサブクラス
684         */
685        public void setWriterClass( final String writerClass ) {
686                this.writerClass = nval( getRequestParameter( writerClass ),this.writerClass );
687        }
688
689        /**
690         * 【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])。
691         *
692         * @og.tag DBTableModelのファイルを、追加モードで書き込むかどうかをセットします。
693         *
694         * @param   flag  [true:追加モード/それ以外:新規モード]
695         */
696        public void setFileAppend( final String flag ) {
697                fileAppend = nval( getRequestParameter( flag ),fileAppend );
698        }
699
700        /**
701         * 【廃止】結果をダイレクトにEXCEL起動するかどうか[true/false]を指定します(初期値:false[ファイル])。
702         *
703         * @og.tag 結果をダイレクトに EXCEL ファイルとして出力するかどうかをセットします。
704         *
705         * @param  flag  [true:ダイレクト/それ以外:ファイル]
706         * @deprecated 結果をダイレクトするとエンコード等でおかしな動きをする可能性がある。
707         */
708        @Deprecated public void setDirect( final String flag ) {
709                direct = nval( getRequestParameter( flag ),direct );
710        }
711
712        /**
713         * 【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)。
714         *
715         * @og.tag
716         * 初期値は、圧縮しないです。
717         *
718         * @param  flag ZIPで圧縮する [true:圧縮する/それ以外:しない]
719         */
720        public void setZip( final String flag ) {
721                zip = nval( getRequestParameter( flag ),zip );
722        }
723
724        /**
725         * 【TAG】Content-Disposition (inline:埋め込む/attachment:ダイアログを起動)を指定します(初期値:attachment)。
726         *
727         * @og.tag
728         * Content-Disposition を指定することで、ブラウザにアプリケーションデータを
729         * 埋め込むのか(inline)、セーブ/オープンのダイアログを起動するのか(attachment)
730         * 指定します。
731         * この属性が有効なのは、direct="true" で、zip="false"(初期値)のときのみです。
732         * 値は、inline 、attachment が指定できます。
733         * 初期値は、attachment です。
734         * 注意:動作検証しましたが、inline と attachment で動作に差が現れませんでした。
735         *
736         * @og.rev 3.1.5.0 (2003/04/20) Content-Disposition を外部から指定できるように変更。
737         * @og.rev 3.8.0.9 (2005/10/17) Content-Disposition 初期値変更 inline ⇒ attachment
738         *
739         * @param  pos Content-Disposition [inline/attachment]
740         */
741        public void setDisposition( final String pos ) {
742                disposition = nval( getRequestParameter( pos ),disposition );
743                if( !"inline".equals( disposition ) && !"attachment".equals( disposition ) ) {
744                        String errMsg = "disposition には、inline か attachment 以外は指定できません。"
745                                                + "disposition=[" + disposition + "]" ;
746                        throw new HybsSystemException( errMsg );
747                }
748        }
749
750        /**
751         * 【TAG】EXCEL雛型参照ファイルのディレクトリ名をセットします。
752         *
753         * @og.tag
754         * この属性で指定されるディレクトリに、ファイルをセーブします。
755         * 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
756         * ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
757         * システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。
758         * fileURL = "{&#064;USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
759         * さらに、各個人ID別のフォルダを作成して、そこにセーブします。
760         *
761         * @og.rev 3.5.4.3 (2004/01/05) 新規作成
762         * @og.rev 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用
763         * @og.rev 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。
764         *
765         * @param       url EXCEL雛型参照ファイルのディレクトリ名
766         */
767        public void setRefFileURL( final String url ) {
768                String furl = nval( getRequestParameter( url ),null );
769                if( furl != null ) {
770                        char ch = furl.charAt( furl.length()-1 );
771                        if( ch != '/' && ch != '\\' ) { furl = furl + "/"; }
772                        refFileURL = StringUtil.urlAppend( refFileURL,furl );
773                }
774        }
775
776        /**
777         * 【TAG】EXCEL雛型参考ファイル名をセットします。
778         *
779         * @og.tag
780         * 内部処理的には、雛形ファイルの雛形シートをメモリ上に構築し、
781         * そのシートのセルに、データを追加していきます。
782         * 最後には、雛形シートとして存在しない部分は、すべて削除します。
783         * 雛形シートを使わない場合は、新規シートに追加していくことになります。
784         * appendモードの場合は、オリジナルが雛形ファイルになります。
785         * 雛形ファイルの指定は、無効になります。
786         * ※ 互換性の為、同じ名前の設定は有効です。
787         *
788         * ※ Excel2007形式(XSSF)では、行全体を指定した色や罫線は、
789         * セルとして認識されません。範囲指定で、罫線や色付けを行う必要があります。
790         *
791         * @og.rev 3.5.4.3 (2004/01/05) 新規作成
792         *
793         * @param   filename EXCEL雛型参考ファイル名
794         */
795        public void setRefFilename( final String filename ) {
796                refFilename = nval( getRequestParameter( filename ),refFilename );
797        }
798
799        /**
800         * 【TAG】EXCEL雛型参考ファイルのシート名を設定します。
801         *
802         * @og.tag
803         * EXCELファイルを書き出す時に、雛型として参照するシート名を指定します。
804         * これにより、複数の形式の異なるデータを順次書き出したり(appendモードを併用)する
805         * ことや、シートを指定して新規にEXCELを作成する場合にフォームを設定する事が可能になります。
806         * 初期値は、null(第一シート) です。
807         *
808         * @og.rev 3.5.4.3 (2004/01/05) 新規追加
809         *
810         * @param   sheet EXCEL雛型参考ファイルのシート名
811         */
812        public void setRefSheetName( final String sheet ) {
813                refSheetName = nval( getRequestParameter( sheet ),refSheetName );
814        }
815        
816        /**
817         * 【TAG】追記モード時に、指定シートが存在した場合は上書きします(初期値:false[上書きしない])。
818         *
819         * @og.tag シート上書きを行うかどうか
820         * 
821         * @og.rev 5.9.12.1 (2016/09/09) 追加
822         *
823         * @param   flag  [true:追加モード/それ以外:新規モード]
824         */
825        public void setSheetOverwrite( final String flag ) {
826                sheetOverwrite = nval( getRequestParameter( flag ),sheetOverwrite );
827        }
828        
829        /**
830         * 【TAG】EXCELで、出力処理の最後に、セル内の計算式を再計算させるシート名をカンマ区切りで指定します。
831         *
832         * @og.tag
833         * 通常は利用する必要はありません。
834         * 一覧結果を利用した集計用シートを別に持っているような雛形を利用した出力で利用します。
835         *
836         * @og.rev 5.9.12.1 (2016/09/09) 追加
837         *
838         * @param   sheet 対象シート名(カンマ区切り文字)
839         */
840        public void setRecalcSheetName( final String sheet ) {
841                recalcSheetName = nval( getRequestParameter( sheet ),recalcSheetName );
842        }
843
844        /**
845         * 【TAG】EXCEL出力時のデフォルトフォント名を設定します
846         *              (初期値:TABLE_WRITER_DEFAULT_FONT_NAME[={@og.value org.opengion.hayabusa.common.SystemData#TABLE_WRITER_DEFAULT_FONT_NAME}])。
847         *
848         * @og.tag
849         * これは、EXCEL追加機能として実装されています。
850         *
851         * EXCELファイルを書き出す時に、デフォルトフォント名を指定します。
852         * フォント名は、EXCELのフォント名をそのまま使用してください。
853         * 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontName( String )
854         * に設定されます。
855         * (初期値:システム定数のTABLE_WRITER_DEFAULT_FONT_NAME[={@og.value org.opengion.hayabusa.common.SystemData#TABLE_WRITER_DEFAULT_FONT_NAME}])。
856         *
857         * @og.rev 3.8.5.3 (2006/08/07) 新規追加
858         *
859         * @param   name デフォルトフォント名
860         * @see         org.opengion.hayabusa.common.SystemData#TABLE_WRITER_DEFAULT_FONT_NAME
861         */
862        public void setFontName( final String name ) {
863                fontName = nval( getRequestParameter( name ),fontName );
864        }
865
866        /**
867         * 【TAG】EXCEL出力時のデフォルトフォントポイント数を設定します。
868         *
869         * @og.tag
870         * これは、EXCEL追加機能として実装されています。
871         *
872         * EXCELファイルを書き出す時に、デフォルトポイント数を指定します。
873         * 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontHeightInPoints( short )
874         * に設定されます。
875         * 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_POINTS です。
876         *
877         * @og.rev 3.8.5.3 (2006/08/07) 新規追加
878         *
879         * @param   point デフォルトフォントポイント数
880         */
881        public void setFontPoint( final String point ) {
882                fontPoint = nval( getRequestParameter( point ),fontPoint );
883        }
884
885        /**
886         * 【TAG】行番号情報を、出力する/しない[true/false]を指定します(初期値:true)。
887         *
888         * @og.tag
889         * 通常のフォーマットでは、各行の先頭に行番号を出力します。
890         * これは、#NAME 属性を使用する場合には、必ず出力する必要があります。
891         * (#NAME 属性は、読み取り時には、必須です。)
892         * この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力、
893         * このシステムでは、#NAME 属性が出力されないため、読み込みできません。)
894         * この行番号を出力しないようにできます。
895         * なお、EXCEL 出力には、この設定は適用されません。(暫定対応)
896         * 初期値は、true(出力する) です。
897         *
898         * @og.rev 3.7.0.2 (2005/02/14) 新規追加
899         *
900         * @param   useNo 行番号情報を指定 [true:出力する/false:しない]
901         */
902        public void setUseNumber( final String useNo ) {
903                useNumber = nval( getRequestParameter( useNo ),useNumber );
904        }
905
906        /**
907         * 【TAG】書き込み先ファイルのカラム列を、外部(タグ)より指定します。
908         *
909         * @og.tag
910         * この指定により、書き込むカラムを限定的に使用することが可能です。
911         * カラム名は、検索したDBTableModel上に含まれる名前で指定する必要があります。
912         * 別名で書き込みたい場合は、予めその名前で検索しておく必要があります。
913         *
914         * @og.rev 4.0.0.0 (2005/12/31) 新規作成
915         *
916         * @param   clms 書き込み先ファイルのカラム列(カンマ区切り文字)
917         */
918        public void setColumns( final String clms ) {
919                columns = nval( getRequestParameter( clms ),columns );
920        }
921
922        /**
923         * 【TAG】書込処理でコードリソースのラベル変換を行うかどうかを指定します
924         *              (初期値:USE_TABLE_WRITER_RENDERER[={@og.value org.opengion.hayabusa.common.SystemData#USE_TABLE_WRITER_RENDERER}])。
925         *
926         * @og.tag
927         * コードリソースをそのままの値で出力すると、数字や記号になり何が書かれているのか
928         * 不明になります。
929         * これは、コードリソースをラベルに変換して出力するかどうかを指定します。
930         * 当然、コードはユニークですが、ラベルはユニークになるかどうか保障はされていませんので
931         * TableReader 系で読み込む場合には、リスクが発生します。
932         * また、TableReader 系で読み込む場合にも、ラベルからコードを求める逆変換を行うように、
933         * setUseRenderer メソッドで指定する必要があります。
934         *
935         * 従来は、TableWriter 系に、TableWriter_Renderer 系のクラスを作って対応していましたが、
936         * このメソッドの属性値のフラグで、制御します。
937         * (初期値:システム定数のUSE_TABLE_WRITER_RENDERER[={@og.value org.opengion.hayabusa.common.SystemData#USE_TABLE_WRITER_RENDERER}])。
938         *
939         * @og.rev 5.2.1.0 (2010/10/01) 新規作成
940         *
941         * @param  flag コードリソースのラベル変換を行うかどうか
942         * @see         org.opengion.hayabusa.common.SystemData#USE_TABLE_WRITER_RENDERER
943         */
944        public void setUseRenderer( final String flag ) {
945                useRenderer = nval( getRequestParameter( flag ),useRenderer );
946        }
947
948        /**
949         * 【TAG】(通常は使いません)データの書き込み開始行番号を設定します(初期値:0)。
950         *
951         * @og.tag
952         * TAB区切りテキストやEXCEL等のデータの書き込みの開始行番号を指定します。
953         * 属性名は、行を飛ばす処理ということで、readTable タグと同じ名称です。
954         * ファイルの先頭行が、0行としてカウントしますので、設定値は、読み飛ばす
955         * 件数になります。(1と指定すると、1行読み飛ばし、2行目から読み込みます。)
956         * 行の読み飛ばしと、カラムの読み飛ばし(columns)、refFileURL、refFilename、
957         * refSheetName とともに使用すれば、ある程度のレイアウト設定が可能です。
958         * なお、この機能は、TableWriter_Excel のみに実装します。
959         *
960         * @og.rev 5.7.9.0 (2014/08/08) 新規作成
961         *
962         * @param       count 書き込み開始行番号
963         */
964        public void setSkipRowCount( final String count ) {
965                skipRowCount = nval( getRequestParameter( count ),skipRowCount );
966        }
967
968        /**
969         * 【TAG】チェック行のみを対象にするかを指定します(初期値:true)。
970         *
971         * @og.tag
972         * falseを指定する事で、前画面でチェックした行のみを出力します。
973         * 初期値は全ての行を出力(true)です。
974         * 出力されるファイルの行番号は、1から振りなおされます。
975         *
976         * @og.rev 5.5.5.5 (2012/08/24) 新規作成
977         *
978         * @param   flag 対象にするか指定 [true:全件/false:対象のみ]
979         */
980        public void setSelectedAll( final String flag ) {
981                selectedAll = nval( getRequestParameter( flag ),selectedAll );          // 5.5.9.1 (2012/12/07) バグ対応
982        }
983        
984        /**
985         * 【TAG】事前にファイルを削除するかどうかを指定します(初期値:false)。
986         *
987         * @og.tag
988         * 出力元の DBTableModel が、存在しないか、0件の場合、過去に作成したファイルが
989         * そのまま、残っていると、不要なトラブルのもととなる為、実行前に削除するか
990         * どうかを指定できます。
991         * なお、fileAppend="true"(追加モードで書き込むを指定)時には、データが0件でも
992         * 事前削除は行いません。
993         * 初期値は互換性のため削除しない(false)です。
994         *
995         * @og.rev 5.5.9.1 (2012/12/07) 新規作成
996         *
997         * @param   flag 事前削除するかどうか [true:削除する/false:削除しない]
998         */
999        public void setBeforeDelete( final String flag ) {
1000                beforeDelete = nval( getRequestParameter( flag ),beforeDelete );
1001        }
1002
1003        /**
1004         * WriteTable オブジェクトに渡すパラメータオブジェクトをセットします。
1005         *
1006         * @og.tag
1007         * WriteTableParamTag クラスよりセットされます。
1008         *
1009         * @og.rev 4.0.0.0 (2005/02/28) 新規追加
1010         *
1011         * @param   entry HybsEntryオブジェクト
1012         */
1013        protected void addParam( final HybsEntry entry ) {
1014                if( param == null ) { param = new ArrayList<HybsEntry>(); }
1015                param.add( entry );
1016        }
1017
1018        /**
1019         * シリアライズ用のカスタムシリアライズ書き込みメソッド
1020         *
1021         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
1022         * @serialData 一部のオブジェクトは、シリアライズされません。
1023         *
1024         * @param       strm    ObjectOutputStreamオブジェクト
1025         * @throws IOException  入出力エラーが発生した場合
1026         */
1027        private void writeObject( final ObjectOutputStream strm ) throws IOException {
1028                strm.defaultWriteObject();
1029        }
1030
1031        /**
1032         * シリアライズ用のカスタムシリアライズ読み込みメソッド
1033         *
1034         * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。
1035         *
1036         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
1037         * @serialData 一部のオブジェクトは、シリアライズされません。
1038         *
1039         * @param       strm    ObjectInputStreamオブジェクト
1040         * @see #release2()
1041         * @throws IOException  シリアライズに関する入出力エラーが発生した場合
1042         * @throws ClassNotFoundException       クラスを見つけることができなかった場合
1043         */
1044        private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException {
1045                strm.defaultReadObject();
1046        }
1047
1048        /**
1049         * このオブジェクトの文字列表現を返します。
1050         * 基本的にデバッグ目的に使用します。
1051         *
1052         * @return このクラスの文字列表現
1053         */
1054        @Override
1055        public String toString() {
1056                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
1057                                .println( "VERSION"                     ,VERSION                )
1058                                .println( "BASE_URL"            ,BASE_URL               )
1059                                .println( "separator"           ,separator              )
1060                                .println( "headerSequence"      ,headerSequence )
1061                                .println( "fileURL"                     ,fileURL                )
1062                                .println( "filename"            ,filename               )
1063                                .println( "refFileURL"          ,refFileURL             )
1064                                .println( "refFilename"         ,refFilename    )
1065                                .println( "encode"                      ,encode                 )
1066                                .println( "writerClass"         ,writerClass    )
1067                                .println( "fileAppend"          ,fileAppend             )
1068                                .println( "direct"                      ,direct                 )
1069                                .println( "zip"                         ,zip                    )
1070                                .println( "disposition"         ,disposition    )
1071                                .println( "tableId"                     ,tableId                )
1072                                .println( "sheetName"           ,sheetName              )
1073                                .println( "refSheetName"        ,refSheetName   )
1074                                .println( "useNumber"           ,useNumber              )
1075                                .println( "Other..."    ,getAttributes().getAttribute() )
1076                                .fixForm().toString() ;
1077        }
1078}