    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;
    022
    023/**
    024 * CSV形式ダブルクォートゼロカンマファイル(CSV)形式書き込みクラスです。
    025 *
    026 * DefaultTableWriter を継承していますので，ラベル，名前，データの出力部のみ
    027 * オーバーライドして，可変長CSV形式ファイルの出力機能を実現しています。
    028 *
    029 * @og.group ファイル出力
    030 *
    031 * @version  4.0
    032 * @author       Kazuhiko Hasegawa
    033 * @since    JDK5.0,
    034 */
    035public class TableWriter_CSV extends TableWriter_Default {
    036        /** このプログラムのVERSION文字列を設定します。   {@value} */
    037        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
    038
    039        /**
    040         * デフォルトコンストラクター
    041         *
    042         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    043         */
    044        public TableWriter_CSV() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    045
    046        /**
    047         * DBTableModel から データを作成して,PrintWriter に書き出します。
    048         *
    049         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
    050         * @og.rev 3.5.4.3 (2004/01/05) 引数に PrintWriter を受け取るように変更します。
    051         *
    052         * @param       writer PrintWriterオブジェクト
    053         */
    054        @Override
    055        public void writeDBTable( final PrintWriter writer )  {
    056                super.setSeparator( CSV_SEPARATOR );    // 3.5.6.0 (2004/06/18)
    057                super.writeDBTable( writer );
    058        }
    059
    060        /**
    061         * PrintWriter に DBTableModelのテーブル情報を書き込みます。
    062         * このクラスでは，データを ダブルコーテーション(")で囲みます。
    063         * PrintWriter に DBTableModelのテーブル情報を書き込みます。
    064         *
    065         * @og.rev 2.0.0.1 (2002/09/20) 先頭が0 でかつ数字タイプ(S9)でない場合に ' を出力するように修正
    066         * @og.rev 2.0.0.5 (2002/09/30) 先頭が0 でかつ数字タイプ(S9 or R)でない場合に ' を出力するように修正。
    067         * @og.rev 2.3.1.2 (2003/01/28) データ出力時に、改行が余分に出される箇所を修正。
    068         * @og.rev 3.1.0.0 (2003/03/20) DBColumn から、getDbType() キーを直接取り出す
    069         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
    070         * @og.rev 3.7.0.2 (2005/02/14) 行番号情報を、出力する(true)/しない(false)を指定
    071         * @og.rev 3.8.0.1 (2005/06/17) DBTypeが NVAR の場合は、元のUnicodeに戻します。
    072         * @og.rev 5.1.6.0 (2010/05/01) DbType の初期値(dbType)を利用する。
    073         * @og.rev 5.2.1.0 (2010/10/01) useRenderer 対応
    074         * @og.rev 5.6.9.4 (2013/10/31) 数字型でない場合の先頭が 0 の時
    075         * @og.rev 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加
    076         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
    077         *
    078         * @param       table  DBTableModelオブジェクト
    079         * @param       writer PrintWriterオブジェクト
    080         */
    081        @Override
    082        protected void writeData( final DBTableModel table,final PrintWriter writer ) {
    083                final int numberOfRows =        table.getRowCount();
    084                final boolean useNumber = isUseNumber();
    085                final boolean useRenderer = isUseRenderer();    // 5.2.1.0 (2010/10/01)
    086
    087                for( int row=0; row<numberOfRows; row++ ) {
    088                        if( useNumber ) {
    089                                writer.print( quotation( String.valueOf( row+1 ) ) );
    090                                writer.print( CSV_SEPARATOR );
    091                        }
    092
    093                        for( int i=0; i<numberOfColumns; i++ ) {
    094                                if( i != 0 ) { writer.print( CSV_SEPARATOR ); }
    095                                final int clm = clmNo[i];
    096                                if( clm < 0 ) { continue; }                     // 6.0.1.2 (2014/08/08) カラム飛ばし
    097
    098                                String val = table.getValue(row,clm);
    099                                if( dbType[i] == NVAR ) {
    100                                        val = StringUtil.getReplaceEscape( val );
    101                                }
    102                                // 5.2.1.0 (2010/10/01) useRenderer 対応
    103                                else if( useRenderer ) {
    104                                        // 6.0.4.0 (2014/11/28) データ出力用のレンデラー
    105                                        val = dbColumn[clm].getWriteValue( val );
    106                                }
    107
    108                                // 開始日などの 00000000 を文字列タイプで渡す
    109                                // 5.6.9.4 (2013/10/31) 数字型でない場合の先頭が 0 の時(dbType[i] != NUMBER) 追加
    110                                if( StringUtil.startsChar( val , '0' ) && dbType[i] != NUMBER ) {               // 6.2.0.0 (2015/02/27) １文字 String.startsWith
    111                                                writer.print( quotation( "'" + val ) );
    112                                }
    113                                else {
    114                                        writer.print( quotation( val ) );
    115                                }
    116                        }
    117                        writer.println();
    118                }
    119        }
    120
    121        /**
    122         * データを書き込む場合の,区切り文字をセットします。
    123         * このクラスでは，CSV 固定の為,区切り文字のセットは無効になります。
    124         *
    125         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
    126         *
    127         * @param       sprt 区切り文字
    128         */
    129        @Override
    130        public void setSeparator( final String sprt ) {
    131                super.setSeparator( CSV_SEPARATOR ) ;   // 3.5.6.0 (2004/06/18)
    132        }
    133}