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 = "7.2.6.1 (2020/07/17)" ;
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         * @see #isExcel()
057         */
058        @Override
059        public void writeDBTable() {
060                final String errMsg = "このクラスでは実装されていません。";
061                throw new UnsupportedOperationException( errMsg );
062        }
063
064        /**
065         * DBTableModel から データを作成して,PrintWriter に書き出します。
066         *
067         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
068         * @og.rev 3.5.4.2 (2003/12/15) writer の null チェックを廃止します。
069         * @og.rev 3.5.4.3 (2004/01/05) 引数に PrintWriter を受け取るように変更します。
070         * @og.rev 7.2.6.1 (2020/07/17) H:Header(ヘッダー)属性追加。
071         *
072         * @param       writer PrintWriterオブジェクト
073         */
074        @Override
075        public void writeDBTable( final PrintWriter writer )  {
076                if( ! createDBColumn() ) { return ; }
077
078                final String headerSequence = getHeaderSequence();
079
080                writeHeader( writer ) ;
081                for( int i=0; i<headerSequence.length(); i++ ) {
082                        switch( headerSequence.charAt( i ) ) {
083                                case 'N':
084                                        writeName( table,writer ) ;
085                                        break;
086                                case 'L':
087                                        writeLabel( table,writer ) ;
088                                        break;
089                                case 'H':                                                               // 7.2.6.1 (2020/07/17)
090                                        writeLabel2( table,writer ) ;
091                                        break;
092                                case 'S':
093                                        writeSize( table,writer ) ;
094                                        break;
095                                case 'C':
096                                        writeClass( table,writer ) ;
097                                        break;
098                                case '-':
099                                        writeSeparator( table,writer ) ;
100                                        break;
101                                case 'D':
102                                        writeData( table,writer ) ;
103                                        break;
104                                default:
105                                        break;
106                        }
107                }
108        }
109
110        /**
111         * PrintWriter に DBTableModelのテーブル情報を書き込みます。
112         * このクラスでは,データを ダブルコーテーション(")で囲みます。
113         * PrintWriter に DBTableModelのテーブル情報を書き込みます。
114         *
115         * @og.rev 2.0.0.5 (2002/09/30) 先頭が0 でかつ数字タイプ(S9 or R)でない場合に ' を出力するように修正。
116         * @og.rev 2.3.1.2 (2003/01/28) データ出力時に、改行が余分に出される箇所を修正。
117         * @og.rev 3.1.0.0 (2003/03/20) DBColumn から、getDbType() キーを直接取り出す
118         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
119         * @og.rev 3.3.3.1 (2003/07/18) ファイルリード/ライト時に後ろスペースの除去を行います。
120         * @og.rev 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定
121         * @og.rev 3.8.0.1 (2005/06/17) DBTypeが NVAR の場合は、元のUnicodeに戻します。
122         * @og.rev 5.1.6.0 (2010/05/01) DbType の初期値(dbType)を利用する。
123         * @og.rev 5.2.1.0 (2010/10/01) useRenderer 対応
124         * @og.rev 5.2.2.0 (2010/11/01) 改行、ダブルクオート等の処理
125         * @og.rev 5.3.2.0 (2011/02/01) ","を付加する条件が反転しているバグを修正
126         * @og.rev 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加
127         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
128         * @og.rev 6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
129         *
130         * @param       table  DBTableModelオブジェクト
131         * @param       writer PrintWriterオブジェクト
132         */
133        @Override
134        protected void writeData( final DBTableModel table,final PrintWriter writer ) {
135                final int numberOfRows =        table.getRowCount();
136
137                final String separator = getSeparator();
138                final boolean useRenderer = isUseRenderer();    // 5.2.1.0 (2010/10/01)
139
140                for( int row=0; row<numberOfRows; row++ ) {
141                        if( isUseNumber() ) {
142                                writer.print( row+1 );
143                                writer.print( separator );
144                        }
145
146                        for( int i=0; i<numberOfColumns; i++ ) {
147                                if( i != 0 ) { writer.print( separator ); }
148
149                                final int clm = clmNo[i];
150                                if( clm < 0 ) { continue; }                     // 6.0.1.2 (2014/08/08) カラム飛ばし
151
152                                String val = table.getValue(row,clm);
153
154                                // 6.2.3.0 (2015/05/01) keyLabelのデータは、先に書き込みます。
155                                if( isKeyLbl[i] ) {
156                                        writer.print( StringUtil.rTrim( val ) );
157                                        writer.print( separator );
158                                }
159
160                                if( dbType[i] == NVAR ) {
161                                        val = StringUtil.getReplaceEscape( val );
162                                }
163                                // 5.2.1.0 (2010/10/01) useRenderer 対応
164                                else if( useRenderer ) {
165                                        // 6.0.4.0 (2014/11/28) データ出力用のレンデラー
166                                        val = dbColumn[clm].getWriteValue( val );
167                                }
168
169                                if( StringUtil.startsChar( val , '0' ) && dbType[i] != NUMBER ) {               // 6.2.0.0 (2015/02/27) 1文字 String.startsWith
170                                                writer.print( "'" );            // 開始日などの 00000000 を文字列タイプで渡す
171                                }
172                                writer.print( quotation2( StringUtil.rTrim( val ) ) );  // 5.2.2.0 (2010/11/01) 改行、ダブルクオート等の処理
173                        }
174                        writer.println();
175                }
176        }
177}