/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.plugin.io;

import java.io.File;                                                                            // 6.2.0.0 (2015/02/27)

import org.opengion.fukurou.model.POIUtil;                                      // 6.1.0.0 (2014/12/26) イベント方式
import org.opengion.fukurou.model.TextConverter;                        // 6.3.1.0 (2015/06/28)
import org.opengion.fukurou.util.StringUtil;                            // 7.2.6.0 (2020/06/30)

import org.opengion.hayabusa.io.AbstractTableReader;            // 6.2.0.0 (2015/02/27)

/**
 * POI による、Word,PoworPoint,Excel,Textのファイルを読み取る実装クラスです。
 *
 * ファイル名、シート名を指定して、データを読み取ることが可能です。
 * 入力形式は、openXML形式にも対応しています。
 *
 * POIUtil#extractor(File)を使用して、行分割しますので、第一カラムが # で始まる行も
 * 読み取り対象にします。
 * カラム名は、TEXT 一つだけになります。
 * 通常のTableReader の各種機能は、使用できませんので、ご注意ください。
 *
 * ※ 6.3.1.0 (2015/06/28) カラムに、CMNT属性も追加。これは、位置情報になる為、
 *    対訳や、差分チェック時に使用する予定です。
 *
 * @og.rev 6.2.3.0 (2015/05/01) 新規作成
 * @og.group ファイル入力
 *
 * @version  6.2
 * @author   Kazuhiko Hasegawa
 * @since    JDK8.0,
 */
public class TableReader_POI extends AbstractTableReader {
        /** このプログラムのVERSION文字列を設定します。   {@value} */
        private static final String VERSION = "7.2.6.0 (2020/06/30)" ;

        // 8.5.4.2 (2024/01/12) PMD 7.0.0 UseShortArrayInitializer
//      private static final String[] POI_CLMS = new String[] { "TEXT","CMNT" };        // 7.2.6.0 (2020/06/30)
        private static final String[] POI_CLMS = { "TEXT","CMNT" };                                     // 7.2.6.0 (2020/06/30)

        /**
         * デフォルトコンストラクター
         *
         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
         */
        public TableReader_POI() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。

        /**
         * DBTableModel から 各形式のデータを作成して、BufferedReader より読み取ります。
         * コメント/空行を除き、最初の行は、必ず項目名が必要です。
         * それ以降は、コメント/空行を除き、データとして読み込んでいきます。
         * このメソッドは、EXCEL 読み込み時に使用します。
         *
         * @og.rev 6.2.3.0 (2015/05/01) 新規作成
         * @og.rev 6.2.4.2 (2015/05/29) POIUtil#extractor → textReader に変更
         * @og.rev 6.3.1.0 (2015/06/28) TextConverterに、引数(cmnt)を追加
         * @og.rev 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。
         * @og.rev 7.2.6.0 (2020/06/30) columns でカラム指定できるようにする。
         *
         * @param   file 読み取り元ファイル
         * @param   enc ファイルのエンコード文字列
         */
        @Override
        public void readDBTable( final File file , final String enc ) {
                // 7.2.6.0 (2020/06/30) columns でカラム指定できるようにする。
                final String[] clms = StringUtil.isNull( columns )
                                                                ? POI_CLMS
                                                                : StringUtil.csv2Array( columns );
                final int clmSize = clms.length;
                setTableDBColumn( clms ) ;

                final TextConverter<String,String> conv = new TextConverter<String,String>() {
                        private int cnt ;               // 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。

                        /**
                         * 入力文字列を、変換します。
                         *
                         * @param       val  入力文字列
                         * @param       cmnt コメント
                         * @return      変換文字列(変換されない場合は、null)
                         */
                        @Override
                        public String change( final String val,final String cmnt ) {
                                if( val != null && !val.isEmpty() ) {
//                                      final String[] vals = new String[] { val , cmnt } ;             // 7.2.6.0 (2020/06/30)
                                        final String[] vals = new String[clmSize];
                                        vals[0] = val;
                                        vals[1] = cmnt;
                                        setTableColumnValues( vals,cnt++ );
                                }
                                return null;            // いづれにしても変換しない。
                        }
                };

//              setTableDBColumn( new String[] { "TEXT","CMNT" } ) ;    // 6.3.1.0 (2015/06/28)
                POIUtil.textReader( file , conv );
        }
}