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 org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
019import java.io.File;                                                                            // 6.2.0.0 (2015/02/27)
020import java.util.Arrays;                                                                        // 6.8.2.4 (2017/11/20)
021
022import org.opengion.fukurou.util.StringUtil;
023import org.opengion.fukurou.util.FileInfo;                                      // 6.2.4.2 (2015/05/29)
024import org.opengion.fukurou.model.TableModelHelper;                     // 6.2.0.0 (2015/02/27) クラス名変更
025import org.opengion.fukurou.model.EventReader_XLS;                      // 6.2.4.2 (2015/05/29)
026import org.opengion.fukurou.model.EventReader_XLSX;                     // 6.2.4.2 (2015/05/29)
027
028import org.opengion.hayabusa.common.HybsSystemException;
029import org.opengion.hayabusa.io.AbstractTableReader;            // 6.2.0.0 (2015/02/27)
030
031import static org.opengion.fukurou.system.HybsConst.CR ;                // 6.2.2.0 (2015/03/27)
032
033/**
034 * POI による、EXCELバイナリファイルを読み取る実装クラスです。
035 *
036 * ファイル名、シート名を指定して、データを読み取ることが可能です。
037 * 第一カラムが # で始まる行は、コメント行なので、読み飛ばします。
038 * カラム名の指定行で、カラム名が null の場合は、その列は読み飛ばします。
039 *
040 * 入力形式は、openXML形式にも対応しています。
041 * ファイルの内容に応じて、.xlsと.xlsxのどちらで読み取るかは、内部的に
042 * 自動判定されます。
043 *
044 * @og.rev 3.5.4.8 (2004/02/23) 新規作成
045 * @og.rev 4.3.6.7 (2009/05/22) ooxml形式対応
046 * @og.group ファイル入力
047 *
048 * @version  4.0
049 * @author   Kazuhiko Hasegawa
050 * @since    JDK5.0,
051 */
052public class TableReader_Excel extends AbstractTableReader {
053        /** このプログラムのVERSION文字列を設定します。   {@value} */
054        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
055
056        /**
057         * デフォルトコンストラクター
058         *
059         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
060         */
061        public TableReader_Excel() { super(); }         // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
062
063        /**
064         * DBTableModel から 各形式のデータを作成して,BufferedReader より読み取ります。
065         * コメント/空行を除き、最初の行は、必ず項目名が必要です。
066         * それ以降は、コメント/空行を除き、データとして読み込んでいきます。
067         * このメソッドは、EXCEL 読み込み時に使用します。
068         *
069         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
070         * @og.rev 5.1.6.0 (2010/05/01) columns 処理 追加
071         * @og.rev 5.1.6.0 (2010/05/01) skipRowCountの追加
072         * @og.rev 5.1.8.0 (2010/07/01) Exception をきちっと記述(InvalidFormatException)
073         * @og.rev 5.2.1.0 (2010/10/01) setTableColumnValues メソッドを経由して、テーブルにデータをセットする。
074         * @og.rev 5.5.1.2 (2012/04/06) HeaderData を try の上にだし、エラーメッセージを取得できるようにする。
075         * @og.rev 5.5.7.2 (2012/10/09) sheetNos 追加による複数シートのマージ読み取りサポート
076         * @og.rev 5.5.8.2 (2012/11/09) HeaderData に デバッグフラグを渡します。
077         * @og.rev 6.0.2.5 (2014/10/31) debug=true 時に、進捗が見えるようにします。
078         * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
079         * @og.rev 6.2.0.0 (2015/02/27) TableReader クラスの呼び出し元メソッドの共通化(EXCEL,TEXT)。新規
080         * @og.rev 6.2.1.0 (2015/03/13) TableReaderModel を外部からセットします。
081         * @og.rev 6.2.3.0 (2015/05/01) 行読み飛ばし nullSkipClm追加
082         * @og.rev 6.2.4.2 (2015/05/29) POIUtil を使わず、EventReader_XLS、EventReader_XLSX を直接呼び出します。
083         * @og.rev 6.4.1.2 (2016/01/22) setConstData と、setNames は、内部処理が走るため、他の設定が終わってから呼び出す。
084         *
085         * @param   file 読み取り元ファイル名
086         * @param   enc ファイルのエンコード文字列(未使用)
087         */
088        @Override
089        public void readDBTable( final File file , final String enc ) {
090                final boolean isDebug = isDebug();                      // 5.5.7.2 (2012/10/09) デバッグ情報
091
092        //      if( isDebug ) { System.out.println( " Filename=" + file ) ; }
093
094                final TableModelHelper helper = new TableModelHelper() {
095                        private boolean[] useShtNo ;                    // 6.1.0.0 (2014/12/26) 読み取り対象のシート管理
096
097                        /**
098                         * シートの数のイベントが発生します。
099                         *
100                         * 処理の開始前に、シートの数のイベントが発生します。
101                         * これを元に、処理するシート番号の選別が可能です。
102                         * 初期実装は、されていません。
103                         *
104                         * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
105                         * @og.rev 6.2.6.0 (2015/06/19) #csv2ArrayExt(String,int)の戻り値を、文字列配列から数字配列に変更。
106                         * @og.rev 5.9.9.2 (2016/06/17) シート名指定が効果ないため修正
107                         *
108                         * @param   size  シートの数
109                         */
110                        @Override
111                        public void sheetSize( final int size ) {
112                                if( isDebug ) { System.out.println( " sheetSize=" + size ) ; }
113                                // 5.5.7.2 (2012/10/09) 複数シートのマージ読み取り。 sheetNos の指定が優先される。
114                                useShtNo = new boolean[size];                   // シート数だけ、配列を作成する。
115                                if( sheetNos != null && sheetNos.length() > 0 ) {
116                                        Integer[] sheetList = StringUtil.csv2ArrayExt( sheetNos , size-1 );     // 最大シート番号は、シート数-1
117                                        for( int i=0; i<sheetList.length; i++ ) {
118                                                useShtNo[sheetList[i]] = true;  // 読み取り対象のシート番号のみ、ture にセット
119                                        }
120                                }
121                                else if ( sheetName == null || sheetName.length() == 0 ) { //  5.9.9.2 (2016/06/17) sheetNameを見ないと必ず先頭が読み込まれる
122                                        useShtNo[0] = true;                                     // 一番目のシート
123                                }
124                        }
125
126                        /**
127                         * シートの読み取り開始時にイベントが発生します。
128                         *
129                         * 新しいシートの読み取り開始毎に、1回呼ばれます。
130                         * 戻り値が、true の場合は、そのシートの読み取りを継続します。
131                         * false の場合は、そのシートの読み取りは行わず、次のシートまで
132                         * イベントは発行されません。
133                         *
134                         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
135                         * @og.rev 7.3.1.1 (2021/02/25) 現在実行中のシート名をセットする
136                         *
137                         * @param   shtNm  シート名
138                         * @param   shtNo  シート番号(0~)
139                         * @return  true:シートの読み取り処理を継続します/false:このシートは読み取りません。
140                         */
141                        @Override
142                        public boolean startSheet( final String shtNm,final int shtNo ) {
143        //                      if( isDebug ) { System.out.println( " Sheet[" + shtNo + "]=" + shtNm ) ; }
144                                super.startSheet( shtNm , shtNo );              // cnstData の呼び出しの為。無しで動くようにしなければ…
145
146//                              return  useShtNo  != null && useShtNo[shtNo] ||
147//                                              sheetName != null && sheetName.equalsIgnoreCase( shtNm ) ;                              // 6.9.7.0 (2018/05/14) PMD Useless parentheses.
148
149                                final boolean isUseSheet = useShtNo  != null && useShtNo[shtNo] ||
150                                                                        sheetName != null && sheetName.equalsIgnoreCase( shtNm ) ;      // 6.9.7.0 (2018/05/14) PMD Useless parentheses.
151
152                                if( isUseSheet ) { shtName( shtNm ); }  // 7.3.1.1 (2021/02/25)
153
154                                return isUseSheet;
155                        }
156
157                        /**
158                         * カラム名配列がそろった段階で、イベントが発生します。
159                         *
160                         * openGion での標準的な処理は、colNo==0 の時に、val の先頭が、#NAME
161                         * で始まるレコードを、名前配列として認識します。
162                         * #value( String,int,int ) で、この #NAME だけは、継続処理されます。
163                         * その上で、#NAME レコードが終了した時点で、カラム名配列が完成するので
164                         * そこで初めて、このメソッドが呼ばれます。
165                         *
166                         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
167                         * @og.rev 6.1.0.0 (2014/12/26) omitNames 属性を追加
168                         * @og.rev 6.8.2.4 (2017/11/20) isDebug 処理を追加
169                         *
170                         * @param   names  カラム名配列(可変長引数)
171                         * @see         #value( String,int,int )
172                         */
173                        @Override
174                        public void columnNames( final String[] names ) {
175                                if( isDebug ) { System.out.println( " names=" + Arrays.toString( names ) ) ; }
176                                setTableDBColumn( names ) ;
177                        }
178
179                        /**
180                         * #NAME のオリジナルカラム名配列がそろった段階で、イベントが発生します。
181                         *
182                         * @og.rev 7.3.1.3 (2021/03/09) #NAMEのオリジナルを取得できるようにします。
183                         *
184                         * @param   names  カラム名配列
185                         */
186                        @Override
187                        public void originalNames( final String[] names ) {
188                                setOriginalNames( names ) ;
189                        }
190
191                        /**
192                         * row にあるセルのオブジェクト値がそろった段階で、イベントが発生します。
193                         *
194                         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
195                         * @og.rev 6.2.1.0 (2015/03/13) setTableColumnValuesに、行番号を引数に追加
196                         * @og.rev 6.8.2.4 (2017/11/20) isDebug 処理を追加
197                         *
198                         * @param   vals    文字列値の1行分の配列
199                         * @param   rowNo   行番号(0~)
200                         */
201                        @Override
202                        public void values( final String[] vals,final int rowNo ) {
203                                if( isDebug && rowNo % 100 == 0 ) { System.out.println( "   rowNo=" + rowNo ) ; }
204                                setTableColumnValues( vals,rowNo );             // 6.2.1.0 (2015/03/13)
205                        }
206                };
207
208                // 6.4.1.2 (2016/01/22) setConstData と、setNames は、内部処理が走るため、他の設定が終わってから呼び出す。
209                helper.setSkipRowCount( getSkipRowCount() );            // 6.1.0.0 (2014/12/26) 外部からスキップ行数を指定。
210
211                helper.setNullBreakClm( nullBreakClm );                         // 6.2.0.0 (2015/02/27) 外部からnullBreakClmを指定。
212                helper.setNullSkipClm( nullSkipClm );                           // 6.2.3.0 (2015/05/01) 外部からnullSkipClmを指定。
213                helper.setDebug( isDebug );                                                     // 6.2.0.0 (2015/02/27)
214
215                // 6.4.1.2 (2016/01/22) setConstData と、setNames は、内部処理が走るため、他の設定が終わってから呼び出す。
216                helper.setConstData( constKeys , constAdrs );           // 6.1.0.0 (2014/12/26) 外部から固定値情報を指定。
217                helper.setNames( columns , isUseNumber() );                     // 6.1.0.0 (2014/12/26) 外部からカラム名配列を指定。
218
219                // 6.2.4.2 (2015/05/29) POIUtil を使わず、EventReader_XLS、EventReader_XLSX を直接呼び出します。
220                final String SUFIX = FileInfo.getSUFIX( file );
221                if( "xls".equalsIgnoreCase( SUFIX ) ) {
222                        new EventReader_XLS().eventReader( file,helper );
223                }
224                else if( "xlsx".equalsIgnoreCase( SUFIX ) || "xlsm".equalsIgnoreCase( SUFIX ) ) {
225                        new EventReader_XLSX().eventReader( file,helper );
226                }
227                else {
228                        final String errMsg = "拡張子は、xls,xlsx,xlsm にしてください。[" + file + "]" ;
229                        throw new OgRuntimeException( errMsg );
230                }
231
232                // 最後まで、#NAME が見つから無かった場合
233                if( !helper.isNameSet() ) {
234                        final String errMsg = "最後まで、#NAME が見つかりませんでした。"
235                                                        + CR
236                                                        + "ファイル形式が異なるか、もしくは損傷している可能性があります。"
237                                                        + "Class=[Excel], File=[" + file + "]"
238                                                        + CR ;
239                        throw new HybsSystemException( errMsg );
240                }
241
242                if( isDebug ) { System.out.println( "  TableReader End." ) ; }
243        }
244}