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.plugin.io;
017
018import java.io.PrintWriter;
019
020import org.opengion.fukurou.util.StringUtil;
021import org.opengion.hayabusa.db.DBTableModel;
022import org.opengion.hayabusa.io.AbstractTableWriter;
023
024/**
025 * 区切り文字指定(初期値:タブ)ゼロカンマファイルの書き出しクラスです。
026 *
027 * ラベル、名前、データの出力部のみオーバーライドすれば、各種出力フォーマットに合わせた
028 * サブクラスを実現する事が可能です。
029 * ゼロカンマファイルとは、EXCELのゼロサプレス対策として、頭ゼロの文字型データを出力する
030 * 時に、先頭にカンマ(')を付けて、ゼロが削除(見えなくなる)現象を抑止しているファイルです。
031 *
032 * このクラスは、可変長タブ区切り文字ファイルの出力機能を実現しています。
033 *
034 * @og.group ファイル出力
035 *
036 * @version     4.0
037 * @author      Kazuhiko Hasegawa
038 * @since       JDK5.0,
039 */
040public class TableWriter_Default extends AbstractTableWriter {
041        /** このプログラムのVERSION文字列を設定します。 {@value} */
042        private static final String VERSION = "8.5.2.0 (2023/07/14)" ;
043
044        /**
045         * デフォルトコンストラクター
046         *
047         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
048         */
049        public TableWriter_Default() { super(); }               // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
050
051        /**
052         * DBTableModel から 各形式のデータを作成して、PrintWriter に書き出します。
053         * このメソッドは、EXCEL 書き出し時に使用します。
054         *
055         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
056         *
057         * @see #isExcel()
058         */
059        @Override
060        public void writeDBTable() {
061                final String errMsg = "このクラスでは実装されていません。";
062                throw new UnsupportedOperationException( errMsg );
063        }
064
065        /**
066         * DBTableModel から データを作成して、PrintWriter に書き出します。
067         *
068         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
069         * @og.rev 3.5.4.2 (2003/12/15) writer の null チェックを廃止します。
070         * @og.rev 3.5.4.3 (2004/01/05) 引数に PrintWriter を受け取るように変更します。
071         * @og.rev 7.2.6.1 (2020/07/17) H:Header(ヘッダー)属性追加。
072         *
073         * @param       writer  PrintWriterオブジェクト
074         */
075        @Override
076        public void writeDBTable( final PrintWriter writer )  {
077                if( ! createDBColumn() ) { return ; }
078
079                final String headerSequence = getHeaderSequence();
080
081                writeHeader( writer ) ;
082                for( int i=0; i<headerSequence.length(); i++ ) {
083                        switch( headerSequence.charAt( i ) ) {
084                                case 'N':
085                                        writeName( table,writer ) ;
086                                        break;
087                                case 'L':
088                                        writeLabel( table,writer ) ;
089                                        break;
090                                case 'H':                                                                       // 7.2.6.1 (2020/07/17)
091                                        writeLabel2( table,writer ) ;
092                                        break;
093                                case 'S':
094                                        writeSize( table,writer ) ;
095                                        break;
096                                case 'C':
097                                        writeClass( table,writer ) ;
098                                        break;
099                                case '-':
100                                        writeSeparator( table,writer ) ;
101                                        break;
102                                case 'D':
103                                        writeData( table,writer ) ;
104                                        break;
105                                default:
106                                        break;
107                        }
108                }
109        }
110
111        /**
112         * PrintWriter に DBTableModelのテーブル情報を書き込みます。
113         * このクラスでは、データを ダブルコーテーション(")で囲みます。
114         * PrintWriter に DBTableModelのテーブル情報を書き込みます。
115         *
116         * @og.rev 2.0.0.5 (2002/09/30) 先頭が0 でかつ数字タイプ(S9 or R)でない場合に ' を出力するように修正。
117         * @og.rev 2.3.1.2 (2003/01/28) データ出力時に、改行が余分に出される箇所を修正。
118         * @og.rev 3.1.0.0 (2003/03/20) DBColumn から、getDbType() キーを直接取り出す
119         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
120         * @og.rev 3.3.3.1 (2003/07/18) ファイルリード/ライト時に後ろスペースの除去を行います。
121         * @og.rev 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定
122         * @og.rev 3.8.0.1 (2005/06/17) DBTypeが NVAR の場合は、元のUnicodeに戻します。
123         * @og.rev 5.1.6.0 (2010/05/01) DbType の初期値(dbType)を利用する。
124         * @og.rev 5.2.1.0 (2010/10/01) useRenderer 対応
125         * @og.rev 5.2.2.0 (2010/11/01) 改行、ダブルクオート等の処理
126         * @og.rev 5.3.2.0 (2011/02/01) ","を付加する条件が反転しているバグを修正
127         * @og.rev 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加
128         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
129         * @og.rev 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
130         * @og.rev 8.5.2.0 (2023/07/14) 一部の機能廃止による修正(問合・トラブル 0200010980)
131         *
132         * @param       table   DBTableModelオブジェクト
133         * @param       writer  PrintWriterオブジェクト
134         */
135        @Override
136        protected void writeData( final DBTableModel table,final PrintWriter writer ) {
137                final int numberOfRows =        table.getRowCount();
138
139                final String separator = getSeparator();
140                final boolean useRenderer = isUseRenderer();            // 5.2.1.0 (2010/10/01)
141
142                for( int row=0; row<numberOfRows; row++ ) {
143                        if( isUseNumber() ) {
144                                writer.print( row+1 );
145                                writer.print( separator );
146                        }
147
148                        for( int i=0; i<numberOfColumns; i++ ) {
149                                if( i != 0 ) { writer.print( separator ); }
150
151                                final int clm = clmNo[i];
152                                if( clm < 0 ) { continue; }                                     // 6.0.1.2 (2014/08/08) カラム飛ばし
153
154                                String val = table.getValue(row,clm);
155
156                                // 6.2.3.0 (2015/05/01) keyLabelのデータは、先に書き込みます。
157                                if( isKeyLbl[i] ) {
158                                        writer.print( StringUtil.rTrim( val ) );
159                                        writer.print( separator );
160                                }
161
162//                              if( dbType[i] == NVAR ) {                                                                               // 8.5.2.0 (2023/07/14) Delete
163//                                      val = StringUtil.getReplaceEscape( val );                                       // 8.5.2.0 (2023/07/14) Delete
164//                              }                                                                                                                               // 8.5.2.0 (2023/07/14) Delete
165                                // 5.2.1.0 (2010/10/01) useRenderer 対応
166//                              else if( useRenderer ) {                                                                                // 8.5.2.0 (2023/07/14) Modify
167                                if( useRenderer ) {
168                                        // 6.0.4.0 (2014/11/28) データ出力用のレンデラー
169                                        val = dbColumn[clm].getWriteValue( val );
170                                }
171
172                                if( StringUtil.startsChar( val , '0' ) && dbType[i] != NUMBER ) {       // 6.2.0.0 (2015/02/27) 1文字 String.startsWith
173                                        writer.print( "'" );                                    // 開始日などの 00000000 を文字列タイプで渡す
174                                }
175                                writer.print( quotation2( StringUtil.rTrim( val ) ) );  // 5.2.2.0 (2010/11/01) 改行、ダブルクオート等の処理
176                        }
177                        writer.println();
178                }
179        }
180}