    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.BufferedReader;
    019import java.io.File;
    020import java.io.FileInputStream;
    021import java.io.IOException;
    022import java.io.InputStream;
    023import java.text.DecimalFormat;
    024import java.text.NumberFormat;
    025
    026import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
    027import org.apache.poi.ss.usermodel.Cell;
    028import org.apache.poi.ss.usermodel.DateUtil;
    029import org.apache.poi.ss.usermodel.RichTextString;
    030import org.apache.poi.ss.usermodel.Row;
    031import org.apache.poi.ss.usermodel.Sheet;
    032import org.apache.poi.ss.usermodel.Workbook;
    033import org.apache.poi.ss.usermodel.WorkbookFactory;
    034import org.apache.poi.ss.usermodel.CreationHelper;
    035import org.apache.poi.ss.usermodel.FormulaEvaluator;
    036import org.opengion.fukurou.model.EventReader_XLS;
    037import org.opengion.fukurou.model.EventReader_XLSX;
    038import org.opengion.fukurou.model.TableModelHelper;
    039import org.opengion.fukurou.util.Closer;
    040import org.opengion.fukurou.util.FileInfo;
    041import org.opengion.fukurou.util.StringUtil;
    042import org.opengion.fukurou.util.HybsDateUtil;
    043import org.opengion.hayabusa.common.HybsSystem;
    044import org.opengion.hayabusa.common.HybsSystemException;
    045import org.opengion.hayabusa.db.DBTableModelUtil;
    046
    047/**
    048 * POI による、EXCELバイナリファイルを読み取る実装クラスです。
    049 *
    050 * ファイル名、シート名を指定して、データを読み取ることが可能です。
    051 * 第一カラムが # で始まる行は、コメント行なので、読み飛ばします。
    052 * カラム名の指定行で、カラム名が null の場合は、その列は読み飛ばします。
    053 *
    054 * 入力形式は、openXML形式にも対応しています。
    055 * ファイルの内容に応じて、.xlsと.xlsxのどちらで読み取るかは、内部的に
    056 * 自動判定されます。
    057 *
    058 * @og.rev 3.5.4.8 (2004/02/23) 新規作成
    059 * @og.rev 4.3.6.7 (2009/05/22) ooxml形式対応
    060 * @og.rev 5.9.0.0 (2015/09/04) EventReaderを利用する対応
    061 * @og.group ファイル入力
    062 *
    063 * @version  4.0
    064 * @author   Kazuhiko Hasegawa
    065 * @since    JDK5.0,
    066 */
    067public class TableReader_Excel extends TableReader_Default {
    068        //* このプログラムのVERSION文字列を設定します。   {@value} */
    069        private static final String VERSION = "5.5.8.2 (2012/11/09)" ;
    070
    071        private String  filename                = null;         // 3.5.4.3 (2004/01/05)
    072        private String  sheetName               = null;         // 3.5.4.2 (2003/12/15)
    073        private String  sheetNos                = null;         // 5.5.7.2 (2012/10/09)
    074
    075        private String  constKeys               = null;         // 5.5.8.2 (2012/11/09) 固定値となるカラム名(CSV形式)
    076        private String  constAdrs               = null;         // 5.5.8.2 (2012/11/09) 固定値となるアドレス(行-列,行-列,・・・)
    077        private String  nullBreakClm    = null;         // 5.5.8.2 (2012/11/09) 取込み条件/Sheet BREAK条件
    078
    079        /**
    080         * DBTableModel から 各形式のデータを作成して,BufferedReader より読み取ります。
    081         * コメント/空行を除き、最初の行は、必ず項目名が必要です。
    082         * それ以降は、コメント/空行を除き、データとして読み込んでいきます。
    083         * このメソッドは、EXCEL 読み込み時に使用します。
    084         *
    085         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
    086         * @og.rev 5.1.6.0 (2010/05/01) columns 処理 追加
    087         * @og.rev 5.1.6.0 (2010/05/01) skipRowCountの追加
    088         * @og.rev 5.1.8.0 (2010/07/01) Exception をきちっと記述(InvalidFormatException)
    089         * @og.rev 5.2.1.0 (2010/10/01) setTableColumnValues メソッドを経由して、テーブルにデータをセットする。
    090         * @og.rev 5.5.1.2 (2012/04/06) HeaderData を try の上にだし、エラーメッセージを取得できるようにする。
    091         * @og.rev 5.5.7.2 (2012/10/09) sheetNos 追加による複数シートのマージ読み取りサポート
    092         * @og.rev 5.5.8.2 (2012/11/09) HeaderData に デバッグフラグを渡します。
    093         * @og.rev 5.9.0.0 (2015/09/04) EventReader利用のため、ロジックをV6風に書き換えます
    094         *
    095         * @see #isExcel()
    096         */
    097        @Override
    098/*
    099        public void readDBTable() {
    100                InputStream  in = null;
    101                HeaderData data = null;         // 5.5.1.2 (2012/04/06)
    102                try {
    103                        boolean isDebug = isDebug();                    // 5.5.7.2 (2012/10/09) デバッグ情報
    104
    105                        if( isDebug ) { System.out.println( " Filename=" + filename ) ; }
    106
    107                        in = new FileInputStream(filename);
    108
    109                        Workbook wb = WorkbookFactory.create(in);
    110                        Sheet[] sheets ;                                                                        // 5.5.7.2 (2012/10/09) 配列に変更
    111
    112                        if( isDebug ) { wb = ExcelUtil.activeWorkbook( wb ); }          // デバッグモード時には、エクセルのアクティブセル領域のみにシュリンクを行う
    113
    114                        // 5.5.7.2 (2012/10/09) 複数シートのマージ読み取り。 sheetNos の指定が優先される。
    115                        if( sheetNos != null && sheetNos.length() > 0 ) {
    116                                String[] sheetList = StringUtil.csv2ArrayExt( sheetNos , wb.getNumberOfSheets()-1 );    // 最大シート番号は、シート数-1
    117                                sheets = new Sheet[sheetList.length];
    118                                for( int i=0; i<sheetList.length; i++ ) {
    119                                        sheets[i] = wb.getSheetAt( Integer.parseInt( sheetList[i] ) );
    120                                }
    121                        }
    122                        else if( sheetName != null && sheetName.length() > 0 ) {
    123                                Sheet sheet = wb.getSheet( sheetName );
    124                                if( sheet == null ) {
    125                                        String errMsg = "対応するシートが存在しません。 Sheet=[" + sheetName + "]" ;
    126                                        throw new HybsSystemException( errMsg );
    127                                }
    128                                sheets = new Sheet[] { sheet };
    129                        }
    130                        else {
    131                                Sheet sheet = wb.getSheetAt(0);
    132                                sheets = new Sheet[] { sheet };
    133                        }
    134
    135                        boolean  nameNoSet = true;
    136                        table = DBTableModelUtil.newDBTable();
    137
    138                        int numberOfRows = 0;
    139                        data = new HeaderData();                                // 5.5.1.2 (2012/04/06)
    140
    141                        data.setDebug( isDebug );                               // 5.5.8.2 (2012/11/09)
    142
    143                        // 5.1.6.0 (2010/05/01) columns 処理
    144                        data.setUseNumber( isUseNumber() );
    145
    146                        // 5.5.8.2 (2012/11/09) 固定値となるカラム名(CSV形式)とアドレス(行-列,行-列,・・・)を設定
    147                        data.setSheetConstData( constKeys,constAdrs );
    148
    149                        int nullBreakClmAdrs = -1;                                              // 5.5.8.2 (2012/11/09) nullBreakClm の DBTableModel上のアドレス。-1 は、未使用
    150                        if( data.setColumns( columns ) ) {
    151                                nameNoSet = false;
    152                                table.init( data.getColumnSize() );
    153                                setTableDBColumn( data.getNames() ) ;
    154                                nullBreakClmAdrs = table.getColumnNo( nullBreakClm, false );    // 5.5.8.2 (2012/11/09) カラム番号取得。存在しなければ -1 を返す。
    155                        }
    156
    157                        int skip = getSkipRowCount();                                   // 5.1.6.0 (2010/05/01)
    158                        // 5.5.7.2 (2012/10/09) 複数シートのマージ読み取り。
    159                        for( int i=0; i<sheets.length; i++ ) {                       // 5.5.7.2 (2012/10/09) シート配列を処理します。
    160                                Sheet sheet = sheets[i] ;                                       // 5.5.7.2 (2012/10/09)
    161
    162                                data.setSheetConstValues( sheet );                              // 5.5.8.2 (2012/11/09) シート単位に固定カラムの値をキャッシュする。
    163
    164                                int nFirstRow = sheet.getFirstRowNum();
    165                                if( nFirstRow < skip ) { nFirstRow = skip; } // 5.1.6.0 (2010/05/01)
    166                                int nLastRow  = sheet.getLastRowNum();
    167                                if( isDebug ) {         // 5.5.7.2 (2012/10/09) デバッグ情報
    168                                        System.out.println( " Debug: 行連番=" + numberOfRows + " : Sheet= " + sheet.getSheetName() + " , 開始=" + nFirstRow + " , 終了=" + nLastRow );
    169                                }
    170                                for( int nIndexRow = nFirstRow; nIndexRow <= nLastRow; nIndexRow++) {
    171        //                              HSSFRow oRow = sheet.getRow(nIndexRow);
    172                                        Row oRow = sheet.getRow(nIndexRow);
    173                                        if( data.isSkip( oRow ) ) { continue; }
    174                                        if( nameNoSet ) {
    175                                                nameNoSet = false;
    176                                                table.init( data.getColumnSize() );
    177                                                setTableDBColumn( data.getNames() ) ;
    178                                                nullBreakClmAdrs = table.getColumnNo( nullBreakClm, false );    // 5.5.8.2 (2012/11/09) カラム番号取得。存在しなければ -1 を返す。
    179                                        }
    180
    181                                        if( numberOfRows < getMaxRowCount() ) {
    182                                                String[] tblData = data.row2Array( oRow );                      // 5.5.8.2 (2012/11/09) nullBreakClm の判定のため、一旦配列に受ける。
    183                                                if( nullBreakClmAdrs >= 0 && ( tblData[nullBreakClmAdrs] == null || tblData[nullBreakClmAdrs].isEmpty() ) ) {
    184                                                        break;          // nullBreakClm が null の場合は、そのSheet処理を中止する。
    185                                                }
    186                                                setTableColumnValues( tblData );                                        // 5.5.8.2 (2012/11/09)
    187                                                numberOfRows ++ ;
    188                                        }
    189                                        else {
    190                                                table.setOverflow( true );
    191                                        }
    192                                }
    193
    194                                // 最後まで、#NAME が見つから無かった場合
    195                                if( nameNoSet ) {
    196                                        String errMsg = "最後まで、#NAME が見つかりませんでした。"
    197                                                                        + HybsSystem.CR
    198                                                                        + "ファイルが空か、もしくは損傷している可能性があります。"
    199                                                                        + HybsSystem.CR ;
    200                                        throw new HybsSystemException( errMsg );
    201                                }
    202                        }
    203                }
    204                catch ( IOException ex ) {
    205                        String errMsg = "ファイル読込みエラー[" + filename + "]"  ;
    206                        if( data != null ) { errMsg = errMsg + data.getLastCellMsg(); }         // 5.5.1.2 (2012/04/06)
    207                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
    208                }
    209                // 5.1.8.0 (2010/07/01) Exception をきちっと記述
    210                catch (InvalidFormatException ex) {
    211                        String errMsg = "ファイル形式エラー[" + filename + "]"  ;
    212                        if( data != null ) { errMsg = errMsg + data.getLastCellMsg(); }         // 5.5.1.2 (2012/04/06)
    213                        throw new HybsSystemException( errMsg,ex );
    214                }
    215                finally {
    216                        Closer.ioClose( in );           // 4.0.0 (2006/01/31) close 処理時の IOException を無視
    217                }
    218        }
    219*/
    220
    221        public void readDBTable() {
    222                boolean isDebug = isDebug();                    // 5.5.7.2 (2012/10/09) デバッグ情報
    223                table = DBTableModelUtil.newDBTable();
    224
    225                final TableModelHelper helper = new TableModelHelper() {
    226                        private boolean[] useShtNo;                     // 6.1.0.0 (2014/12/26) 読み取り対象のシート管理
    227
    228                        /**
    229                         * シートの数のイベントが発生します。
    230                         *
    231                         * 処理の開始前に、シートの数のイベントが発生します。
    232                         * これを元に、処理するシート番号の選別が可能です。
    233                         * 初期実装は、されていません。
    234                         *
    235                         * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    236                         * @og.rev 6.2.6.0 (2015/06/19) #csv2ArrayExt(String,int)の戻り値を、文字列配列から数字配列に変更。
    237                         *
    238                         * @param   size  シートの数
    239                         */
    240                        @Override
    241                        public void sheetSize( final int size ) {
    242                                if( isDebug() ) { System.out.println( " sheetSize=" + size ) ; }
    243                                // 5.5.7.2 (2012/10/09) 複数シートのマージ読み取り。 sheetNos の指定が優先される。
    244                                useShtNo = new boolean[size];                   // シート数だけ、配列を作成する。
    245                                if( sheetNos != null && sheetNos.length() > 0 ) {
    246                                        Integer[] sheetList = StringUtil.csv2ArrayExt2( sheetNos , size-1 );    // 最大シート番号は、シート数-1
    247                                        for( int i=0; i<sheetList.length; i++ ) {
    248                                                useShtNo[sheetList[i]] = true;  // 読み取り対象のシート番号のみ、ture にセット
    249                                        }
    250                                }
    251                                else {
    252                                        useShtNo[0] = true;                                     // 一番目のシート
    253                                }
    254                        }
    255
    256                        /**
    257                         * シートの読み取り開始時にイベントが発生します。
    258                         *
    259                         * 新しいシートの読み取り開始毎に、１回呼ばれます。
    260                         * 戻り値が、true の場合は、そのシートの読み取りを継続します。
    261                         * false の場合は、そのシートの読み取りは行わず、次のシートまで
    262                         * イベントは発行されません。
    263                         *
    264                         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    265                         *
    266                         * @param   shtNm  シート名
    267                         * @param   shtNo  シート番号(0～)
    268                         * @return  true:シートの読み取り処理を継続します/false:このシートは読み取りません。
    269                         */
    270                        @Override
    271                        public boolean startSheet( final String shtNm,final int shtNo ) {
    272        //                      if( isDebug ) { System.out.println( " Sheet[" + shtNo + "]=" + shtNm ) ; }
    273                                super.startSheet( shtNm , shtNo );              // cnstData の呼び出しの為。無しで動くようにしなければ…
    274
    275                                return  ( useShtNo != null && useShtNo[shtNo] ) ||
    276                                                ( sheetName != null && sheetName.equalsIgnoreCase( shtNm ) ) ;
    277                        }
    278
    279                        /**
    280                         * カラム名配列がそろった段階で、イベントが発生します。
    281                         *
    282                         * openGion での標準的な処理は、colNo==0 の時に、val の先頭が、#NAME
    283                         * で始まるレコードを、名前配列として認識します。
    284                         * #value( String,int,int ) で、この #NAME だけは、継続処理されます。
    285                         * その上で、#NAME レコードが終了した時点で、カラム名配列が完成するので
    286                         * そこで初めて、このメソッドが呼ばれます。
    287                         *
    288                         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    289                         * @og.rev 6.1.0.0 (2014/12/26) omitNames 属性を追加
    290                         *
    291                         * @param   names  カラム名配列(可変長引数)
    292                         * @see         #value( String,int,int )
    293                         */
    294                        @Override
    295                        public void columnNames( final String[] names ) {
    296                                setTableDBColumn( names ) ;
    297                        }
    298
    299                        /**
    300                         * row にあるセルのオブジェクト値がそろった段階で、イベントが発生します。
    301                         *
    302                         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    303                         * @og.rev 6.2.1.0 (2015/03/13) setTableColumnValuesに、行番号を引数に追加
    304                         *
    305                         * @param   vals    文字列値の１行分の配列
    306                         * @param   rowNo   行番号(0～)
    307                         */
    308                        @Override
    309                        public void values( final String[] vals,final int rowNo ) {
    310        //                      if( isDebug && rowNo % 100 == 0 ) { System.out.println( "   rowNo=" + rowNo ) ; }
    311                                setTableColumnValues( vals );           // 6.2.1.0 (2015/03/13)
    312                        }
    313                };
    314
    315                helper.setDebug( isDebug );
    316                helper.setConstData( constKeys , constAdrs );           // 外部から固定値情報を指定。
    317                helper.setNames( columns , isUseNumber() );                     // 外部からカラム名配列を指定。
    318                helper.setSkipRowCount( getSkipRowCount() );            // 外部からスキップ行数を指定。
    319                helper.setNullBreakClm( nullBreakClm );                         // 外部からnullBreakClmを指定。
    320//              helper.setNullSkipClm( nullSkipClm );                           // 外部からnullSkipClmを指定。 V5未対応
    321
    322                File file = new File(filename);
    323
    324                // 6.2.4.2 (2015/05/29) POIUtil を使わず、EventReader_XLS、EventReader_XLSX を直接呼び出します。
    325                final String SUFIX = FileInfo.getSUFIX( file );
    326                if( "xls".equalsIgnoreCase( SUFIX ) ) {
    327                        new EventReader_XLS().eventReader( file,helper );
    328                }
    329                else if( "xlsx".equalsIgnoreCase( SUFIX ) || "xlsm".equalsIgnoreCase( SUFIX ) ) {
    330                        new EventReader_XLSX().eventReader( file,helper );
    331                }
    332                else {
    333                        final String errMsg = "拡張子は、xls,xlsx,xlsm にしてください。[" + file + "]" ;
    334                        throw new RuntimeException( errMsg );
    335                }
    336
    337                // 最後まで、#NAME が見つから無かった場合
    338                if( !helper.isNameSet() ) {
    339                        final String errMsg = "最後まで、#NAME が見つかりませんでした。"
    340                                                        + "ファイル形式が異なるか、もしくは損傷している可能性があります。"
    341                                                        + "Class=[Excel], File=[" + file + "]";
    342                        throw new HybsSystemException( errMsg );
    343                }
    344
    345                if( isDebug ) { System.out.println( "  TableReader End." ) ; }
    346        }
    347
    348        /**
    349         * DBTableModel から 各形式のデータを作成して,BufferedReader より読み取ります。
    350         * コメント/空行を除き、最初の行は、必ず項目名が必要です。
    351         * それ以降は、コメント/空行を除き、データとして読み込んでいきます。
    352         *
    353         * @og.rev 3.5.4.3 (2004/01/05) 引数に、BufferedReader を受け取る要に変更します。
    354         * @og.rev 4.0.0.0 (2006/09/31) UnsupportedOperationException を発行します。
    355         *
    356         * @param   reader 各形式のデータ(使用していません)
    357         */
    358        @Override
    359        public void readDBTable( final BufferedReader reader ) {
    360                String errMsg = "このクラスでは実装されていません。";
    361                throw new UnsupportedOperationException( errMsg );
    362        }
    363
    364        /**
    365         * DBTableModelのデータとしてEXCELファイルを読み込むときのシート名を設定します。
    366         * これにより、複数の形式の異なるデータを順次読み込むことや、シートを指定して
    367         * 読み取ることが可能になります。
    368         * sheetNos と sheetName が同時に指定された場合は、sheetNos が優先されます。エラーにはならないのでご注意ください。
    369         * のでご注意ください。
    370         *
    371         * @og.rev 3.5.4.2 (2003/12/15) 新規追加
    372         *
    373         * @param   sheetName シート名
    374         */
    375        @Override
    376        public void setSheetName( final String sheetName ) {
    377                this.sheetName = sheetName;
    378        }
    379
    380        /**
    381         * EXCELファイルを読み込むときのシート番号を指定します(初期値:0)。
    382         *
    383         * EXCEL読み込み時に複数シートをマージして取り込みます。
    384         * シート番号は、0 から始まる数字で表します。
    385         * ヘッダーは、最初のシートのカラム位置に合わせます。（ヘッダータイトルの自動認識はありません。）
    386         * よって、指定するシートは、すべて同一レイアウトでないと取り込み時にカラムのずれが発生します。
    387         *
    388         * シート番号の指定は、カンマ区切りで、複数指定できます。また、N-M の様にハイフンで繋げることで、
    389         * N 番から、M 番のシート範囲を一括指定可能です。また、"*" による、全シート指定が可能です。
    390         * これらの組み合わせも可能です。（ 0,1,3,5-8,10-* ）
    391         * ただし、"*" に関しては例外的に、一文字だけで、すべてのシートを表すか、N-* を最後に指定するかの
    392         * どちらかです。途中には、"*" は、現れません。
    393         * シート番号は、重複(1,1,2,2)、逆転(3,2,1) での指定が可能です。これは、その指定順で、読み込まれます。
    394         * sheetNos と sheetName が同時に指定された場合は、sheetNos が優先されます。エラーにはならないのでご注意ください。
    395         * このメソッドは、isExcel() == true の場合のみ利用されます。
    396         *
    397         * 初期値は、0（第一シート） です。
    398         *
    399         * ※ このクラスでは実装されていません。
    400         *
    401         * @og.rev 5.5.7.2 (2012/10/09) 新規追加
    402         *
    403         * @param   sheetNos EXCELファイルのシート番号（0から始まる）
    404         * @see         #setSheetName( String )
    405         */
    406        @Override
    407        public void setSheetNos( final String sheetNos ) {
    408                this.sheetNos = sheetNos;
    409        }
    410
    411        /**
    412         * EXCELファイルを読み込むときのシート単位の固定値を設定するためのカラム名とアドレスを指定します。
    413         * カラム名は、カンマ区切りで指定します。
    414         * 対応するアドレスを、EXCEL上の行-列を０から始まる整数でカンマ区切りで指定します。
    415         * これにより、シートの一か所に書かれている情報を、DBTableModel のカラムに固定値として
    416         * 設定することができます。
    417         * 例として、DB定義書で、テーブル名をシートの全レコードに設定したい場合などに使います。
    418         * このメソッドは、isExcel() == true の場合のみ利用されます。
    419         *
    420         * @og.rev 5.5.8.2 (2012/11/09) 新規追加
    421         *
    422         * @param   constKeys 固定値となるカラム名(CSV形式)
    423         * @param   constAdrs 固定値となるアドレス(行-列,行-列,・・・)
    424         */
    425        @Override
    426        public void setSheetConstData( final String constKeys,final String constAdrs ) {
    427                this.constKeys = constKeys;
    428                this.constAdrs = constAdrs;
    429        }
    430
    431        /**
    432         * ここに指定されたカラム列に NULL が現れた時点で読み取りを中止します。
    433         *
    434         * これは、指定のカラムは必須という事を条件に、そのレコードだけを読み取る処理を行います。
    435         * 複数Sheetの場合は、次のSheetを読みます。
    436         * 現時点では、Excel の場合のみ有効です。
    437         *
    438         * @og.rev 5.5.8.2 (2012/11/09) 新規追加
    439         *
    440         * @param   clm カラム列
    441         */
    442        @Override
    443        public void setNullBreakClm( final String clm ) {
    444                nullBreakClm = clm;
    445        }
    446
    447        /**
    448         * このクラスが、EXCEL対応機能を持っているかどうかを返します。
    449         *
    450         * EXCEL対応機能とは、シート名のセット、読み込み元ファイルの
    451         * Fileオブジェクト取得などの、特殊機能です。
    452         * 本来は、インターフェースを分けるべきと考えますが、taglib クラス等の
    453         * 関係があり、問い合わせによる条件分岐で対応します。
    454         *
    455         * @og.rev 3.5.4.3 (2004/01/05) 新規追加
    456         *
    457         * @return      EXCEL対応機能を持っているかどうか(常にtrue)
    458         */
    459        @Override
    460        public boolean isExcel() {
    461                return true;
    462        }
    463
    464        /**
    465         * 読み取り元ファイル名をセットします。(DIR + Filename)
    466         * これは、EXCEL追加機能として実装されています。
    467         *
    468         * @og.rev 3.5.4.3 (2004/01/05) 新規作成
    469         *
    470         * @param   filename 読み取り元ファイル名
    471         */
    472        @Override
    473        public void setFilename( final String filename ) {
    474                this.filename = filename;
    475                if( filename == null ) {
    476                        String errMsg = "ファイル名が指定されていません。" ;
    477                        throw new HybsSystemException( errMsg );
    478                }
    479        }
    480}
    481
    482/**
    483 * EXCEL ネイティブのデータを処理する ローカルクラスです。
    484 * このクラスでは、コメント行のスキップ判定、ヘッダー部のカラム名取得、
    485 * 行情報(Row)から、カラムの配列の取得などを行います。
    486 *
    487 * @og.rev 3.5.4.8 (2004/02/23) 新規追加
    488 * @og.group ファイル入力
    489 *
    490 * @version  4.0
    491 * @author   儲
    492 * @since    JDK5.0,
    493 */
    494class HeaderData {
    495        private String[] names ;
    496        private int[]    index; // 4.3.4.0 (2008/12/01) POI3.2対応
    497        private int              columnSize = 0;
    498        private boolean  nameNoSet = true;
    499        private boolean  useNumber = true;
    500        private boolean  isDebug   = false;             // 5.5.8.2 (2012/11/09)
    501
    502        private String[] orgNames ;                     // 5.5.1.2 (2012/04/06) オリジナルのカラム名
    503        private Cell     lastCell = null;       // 5.5.1.2 (2012/04/06) 最後に実行しているセルを保持(エラー時に使用する。)
    504
    505        // 5.5.8.2 (2012/11/09) 固定値のカラム名、DBTableModelのアドレス、Sheetの行-列番号
    506        private int              cnstLen = 0;           // 初期値=0 の場合は、固定値を使わないという事。
    507        private String[] cnstKeys ;
    508        private int[]    cnstIndx ;
    509        private int[]    cnstRowNo;
    510        private int[]    cnstClmNo;
    511        private String[] cnstVals ;                     // Sheet単位の固定値のキャッシュ(シートの最初に値を取得して保持しておく)
    512
    513        /**
    514         * デバッグ情報を、出力するかどうか[true/false]を指定します(初期値:false)。
    515         *
    516         * 初期値は、false(出力しない) です。
    517         *
    518         * @og.rev 5.5.8.2 (2012/11/09) 新規作成
    519         *
    520         * @param       isDebug デバッグ情報 [true:出力する/false:出力しない]
    521         */
    522        void setDebug( final boolean isDebug ) {
    523                this.isDebug = isDebug ;
    524        }
    525
    526        /**
    527         * 行番号情報を、使用しているかどうか[true/false]を指定します(初期値:true)。
    528         *
    529         * 初期値は、true(使用する) です。
    530         *
    531         * @og.rev 5.1.6.0 (2010/05/01) 新規作成
    532         *
    533         * @param       useNumber       行番号情報 [true:使用している/false:していない]
    534         */
    535        void setUseNumber( final boolean useNumber ) {
    536                this.useNumber = useNumber ;
    537        }
    538
    539        /**
    540         * 固定値となるカラム名(CSV形式)と、constAdrs 固定値となるアドレス(行-列,行-列,・・・)を設定します。
    541         *
    542         * アドレスは、EXCEL上の行-列をカンマ区切りで指定します。
    543         * 行列は、EXCELオブジェクトに準拠するため、０から始まる整数です。
    544         * 0-0 ⇒ A1 , 1-0 ⇒ A2 , 0-1 ⇒ B1 になります。
    545         * これにより、シートの一か所に書かれている情報を、DBTableModel のカラムに固定値として
    546         * 設定することができます。
    547         * 例として、DB定義書で、テーブル名をシートの全レコードに設定したい場合などに使います。
    548         * このメソッドは、isExcel() == true の場合のみ利用されます。
    549         *
    550         * 5.7.6.3 (2014/05/23) より、
    551         *   ①EXCEL表記に準拠した、A1,A2,B1 の記述も処理できるように対応します。
    552         *     なお、A1,A2,B1 の記述は、必ず、英字1文字＋数字 にしてください。(A～Zまで)
    553         *   ②処理中のEXCELシート名をカラムに割り当てるために、"SHEET" という記号に対応します。
    554         * 例えば、sheetConstKeys="CLM,LANG,NAME" とし、sheetConstAdrs="0-0,A2,SHEET" とすると、
    555         * NAMEカラムには、シート名を読み込むことができます。
    556         * これは、内部処理の簡素化のためです。
    557         *
    558         * ちなみに、EXCELのセルに、シート名を表示させる場合の関数は、下記の様になります。
    559         * =RIGHT(CELL("filename",$A$1),LEN(CELL("filename",$A$1))-FIND("]",CELL("filename",$A$1)))
    560         *
    561         * @param       constKeys       固定値となるカラム名(CSV形式)
    562         * @param       constAdrs       固定値となるアドレス(行-列,行-列,・・・)
    563         *
    564         * @og.rev 5.5.8.2 (2012/11/09) 新規追加
    565         * @og.rev 5.7.6.3 (2014/05/23) EXCEL表記(A2,B1等)の対応と、特殊記号(SHEET)の対応
    566         */
    567        void setSheetConstData( final String constKeys,final String constAdrs ) {
    568                if( constKeys == null || constKeys.isEmpty() ) {
    569                        return ;
    570                }
    571
    572                cnstKeys  = constKeys.split( "," );
    573                cnstLen   = cnstKeys.length;
    574                cnstIndx  = new int[cnstLen];
    575                cnstRowNo = new int[cnstLen];
    576                cnstClmNo = new int[cnstLen];
    577
    578                String[] row_col = constAdrs.split( "," ) ;
    579                cnstRowNo = new int[cnstLen];
    580                cnstClmNo = new int[cnstLen];
    581                for( int j=0; j<cnstLen; j++ ) {
    582                        cnstKeys[j] = cnstKeys[j].trim();               // 前後の不要なスペースを削除
    583                        String rowcol = row_col[j].trim();              // 前後の不要なスペースを削除
    584
    585                        // 5.7.6.3 (2014/05/23) EXCEL表記(A2,B1等)の対応と、特殊記号(SHEET)の対応
    586                        int sep = rowcol.indexOf( '-' );
    587                        if( sep > 0 ) {
    588                                cnstRowNo[j] = Integer.parseInt( rowcol.substring( 0,sep ) );
    589                                cnstClmNo[j] = Integer.parseInt( rowcol.substring( sep+1 ) );
    590                        }
    591                        else {
    592                                if( "SHEET".equalsIgnoreCase( rowcol ) ) {              // "SHEET" 時は、cnstRowNo をマイナスにしておきます。
    593                                        cnstRowNo[j] = -1 ;
    594                                        cnstClmNo[j] = -1 ;
    595                                }
    596                                else if( rowcol.length() >= 2 ) {
    597                                        cnstRowNo[j] = Integer.parseInt( rowcol.substring( 1 ) ) -1;    // C6 の場合、RowNoは、6-1=5
    598                                        cnstClmNo[j] = rowcol.charAt(0) - 'A' ;                                                 // C6 の場合、'C'-'A'=2
    599                                }
    600                        }
    601
    602                        if( isDebug ) {
    603                                System.out.println( " Debug: constKey=" + cnstKeys[j] + " : RowNo=" + cnstRowNo[j] + " , ClmNo=" + cnstClmNo[j] );
    604                        }
    605                }
    606        }
    607
    608        /**
    609         * カラム名を外部から指定します。
    610         * カラム名が、NULL でなければ、＃NAME より、こちらが優先されます。
    611         * カラム名は、順番に、指定する必要があります。
    612         *
    613         * @og.rev 5.1.6.0 (2010/05/01) 新規作成
    614         * @og.rev 5.5.8.2 (2012/11/09) 固定値取得用の cnstIndx の設定を行う。
    615         *
    616         * @param       columns EXCELのカラム列(CSV形式)
    617         *
    618         * @return true:処理実施/false:無処理
    619         */
    620        boolean setColumns( final String columns ) {
    621                if( columns != null && columns.length() > 0 ) {
    622                        names = StringUtil.csv2Array( columns );
    623                        columnSize = names.length ;
    624                        index = new int[columnSize];
    625                        int adrs = useNumber ? 1:0 ;    // useNumber =true の場合は、１件目(No)は読み飛ばす。
    626                        // 5.5.8.2 (2012/11/09) 固定値取得用の cnstIndx の設定を行う。
    627                        for( int i=0; i<columnSize; i++ ) {
    628                                index[i] = adrs++;
    629                                for( int j=0; j<cnstLen; j++ ) {
    630                                        if( names[i].equalsIgnoreCase( cnstKeys[j] ) ) {
    631                                                cnstIndx[j] = index[i];
    632                                        }
    633                                }
    634                        }
    635                        nameNoSet = false;
    636
    637                        return true;
    638                }
    639                return false;
    640        }
    641
    642        /**
    643         * EXCEL ネイティブのデータを処理する ローカルクラスです。
    644         * このクラスでは、コメント行のスキップ判定、ヘッダー部のカラム名取得、
    645         * 行情報(Row)から、カラムの配列の取得などを行います。
    646         *
    647         * @og.rev 4.3.4.0 (2008/12/01) POI3.2対応
    648         *
    649         * @param oRow Row EXCELの行オブジェクト
    650         *
    651         * @return true:コメント行/false:通常行
    652         */
    653        boolean isSkip( Row oRow ) {
    654                if( oRow == null ) { return true; }
    655
    656                int nFirstCell = oRow.getFirstCellNum();
    657                Cell oCell = oRow.getCell(nFirstCell);
    658                String strText =  getValue( oCell );
    659                if( strText != null && strText.length() > 0 ) {
    660                        if( nameNoSet ) {
    661                                if( "#Name".equalsIgnoreCase( strText ) ) {
    662                                        makeNames( oRow );
    663                                        nameNoSet = false;
    664                                        return true;
    665                                }
    666                                else if( strText.charAt( 0 ) == '#' ) {
    667                                        return true;
    668                                }
    669                                else {
    670                                        String errMsg = "#NAME が見つかる前にデータが見つかりました。"
    671                                                                        + HybsSystem.CR
    672                                                                        + "可能性として、ファイルが、ネイティブExcelでない事が考えられます。"
    673                                                                        + HybsSystem.CR ;
    674                                        throw new HybsSystemException( errMsg );
    675                                }
    676                        }
    677                        else {
    678                                if( strText.charAt( 0 ) == '#' ) {
    679                                        return true;
    680                                }
    681                        }
    682                }
    683
    684                return nameNoSet ;
    685        }
    686
    687        /**
    688         * EXCEL ネイティブの行情報(Row)からカラム名情報を取得します。
    689         *
    690         * @og.rev 4.3.4.0 (2008/12/01) POI3.2対応
    691         * @og.rev 5.1.6.0 (2010/05/01) useNumber(行番号情報を、使用している(true)/していない(false)を指定)
    692         * @og.rev 5.1.6.0 (2010/05/01) useNumber(行番号情報を、使用している(true)/していない(false)を指定)
    693         * @og.rev 5.5.1.2 (2012/04/06) オリジナルのカラム名を取得
    694         * @og.rev 5.5.8.2 (2012/11/09) 固定値取得用の cnstIndx の設定を行う。
    695         *
    696         * @param oRow Row EXCELの行オブジェクト
    697         */
    698        private void makeNames( final Row oRow ) {
    699                // 先頭カラムは、#NAME 属性行であるかどうかを、useNumber で判定しておく。
    700                short nFirstCell = (short)( useNumber ? 1:0 );
    701                short nLastCell  = oRow.getLastCellNum();
    702
    703                orgNames = new String[nLastCell+1];             // 5.5.1.2 (2012/04/06) オリジナルのカラム名を取得
    704
    705                int maxCnt = nLastCell - nFirstCell;
    706                String[] names2 = new String[maxCnt];
    707                int[]    index2 = new int[maxCnt];
    708
    709                // 先頭カラムは、#NAME 属性行である。++ で、一つ進めている。
    710                // 先頭カラムは、#NAME 属性行であるかどうかを、useNumber で判定しておく。
    711                for( int nIndexCell = nFirstCell; nIndexCell <= nLastCell; nIndexCell++) {
    712                        Cell oCell = oRow.getCell(nIndexCell);
    713                        String strText = getValue( oCell );
    714
    715                        orgNames[nIndexCell] = strText;         // 5.5.1.2 (2012/04/06) オリジナルのカラム名を取得
    716
    717                        // #NAME 行が、ゼロ文字列の場合は、読み飛ばす。
    718                        if( strText != null && strText.length() > 0 ) {
    719                                names2[columnSize] = strText;
    720                                index2[columnSize] = nIndexCell;
    721                                columnSize++;
    722                        }
    723                }
    724
    725                // #NAME を使用しない場合：no欄が存在しないケース
    726                if( maxCnt == columnSize ) {
    727                        names = names2;
    728                        index = index2;
    729                }
    730                else {
    731                        names = new String[columnSize];
    732                        index = new int[columnSize];
    733                        System.arraycopy(names2, 0, names, 0, columnSize);
    734                        System.arraycopy(index2, 0, index, 0, columnSize);
    735                }
    736
    737                // 5.5.8.2 (2012/11/09) 固定値取得用の cnstIndx の設定を行う。
    738                if( cnstLen > 0 ) {
    739                        for( int i=0; i<columnSize; i++ ) {
    740                                for( int j=0; j<cnstLen; j++ ) {
    741                                        if( names[i].equalsIgnoreCase( cnstKeys[j] ) ) {
    742                                                cnstIndx[j] = index[i];
    743                                        }
    744                                }
    745                        }
    746                }
    747        }
    748
    749        /**
    750         * カラム名情報を返します。
    751         * ここでは、内部配列をそのまま返します。
    752         *
    753         * @return String[] カラム列配列情報
    754         */
    755        String[] getNames() {
    756                return names;
    757        }
    758
    759        /**
    760         * カラムサイズを返します。
    761         *
    762         * @return      カラムサイズ
    763         */
    764        int getColumnSize() {
    765                return columnSize;
    766        }
    767
    768        /**
    769         * Sheet単位の固定値のキャッシュ(シートの最初に値を取得して保持しておく)を設定します。
    770         * これは、シートチェンジの最初に一度呼び出しておくことで、それ以降の列取得時に
    771         * 固定値を利用することで処理速度向上を目指します。
    772         *
    773         * "SHEET" が指定された場合は、cnstRowNo[j]=-1 が設定されている。
    774         *
    775         * @og.rev 5.5.8.2 (2012/11/09) 新規作成
    776         * @og.rev 5.7.6.3 (2014/05/23) 特殊記号(SHEET)の対応
    777         *
    778         * @param sheet Sheet EXCELのSheetオブジェクト
    779         */
    780        void setSheetConstValues( final Sheet sheet ) {
    781                cnstVals = new String[cnstLen];
    782                for( int j=0; j<cnstLen; j++ ) {
    783                        // 5.7.6.3 (2014/05/23) 特殊記号(SHEET)の対応
    784                        if( cnstRowNo[j] < 0 ) {
    785                                cnstVals[j] = sheet.getSheetName() ;
    786                        }
    787                        else {
    788                                Row  oRow  = sheet.getRow( cnstRowNo[j] );
    789                                Cell oCell = oRow.getCell( cnstClmNo[j] );
    790                                cnstVals[j] = getValue( oCell );
    791                        }
    792
    793                        if( isDebug ) {
    794                                System.out.println( " Debug: Sheet=" + sheet.getSheetName() + " : RowNo=" + cnstRowNo[j] + " , ClmNo=" + cnstClmNo[j] + " , " + cnstKeys[j] + "=" + cnstVals[j] );
    795                        }
    796                }
    797        }
    798
    799        /**
    800         * カラム名情報を返します。
    801         *
    802         * @og.rev 5.5.8.2 (2012/11/09) 固定値の設定を行う。
    803         *
    804         * @param oRow Row EXCELの行オブジェクト
    805         *
    806         * @return String[] カラム列配列情報
    807         */
    808        String[] row2Array( final Row oRow ) {
    809                if( nameNoSet ) {
    810                        String errMsg = "#NAME が見つかる前にデータが見つかりました。";
    811                        throw new HybsSystemException( errMsg );
    812                }
    813
    814                String[] data = new String[columnSize];
    815                for( int i=0;i<columnSize; i++ ) {
    816                        Cell oCell = oRow.getCell( index[i] );
    817                        data[i] = getValue( oCell );
    818                }
    819
    820                // 5.5.8.2 (2012/11/09) 固定値の設定を行う。
    821                for( int j=0; j<cnstLen; j++ ) {
    822                        data[cnstIndx[j]] = cnstVals[j];
    823                }
    824                return data;
    825        }
    826
    827        /**
    828         * セルオブジェクト(Cell)から値を取り出します。
    829         *
    830         * @og.rev 3.8.5.3 (2006/08/07) 取り出し方法を少し修正
    831         * @og.rev 5.5.1.2 (2012/04/06) フォーマットセルを実行して、その結果を再帰的に処理する。
    832         *
    833         * @param oCell Cell EXCELのセルオブジェクト
    834         *
    835         * @return      セルの値
    836         */
    837        private String getValue( final Cell oCell ) {
    838                lastCell = oCell;       // 5.5.1.2 (2012/04/06) 今から実行するセルを取得しておきます。
    839
    840                if( oCell == null ) { return null; }
    841
    842                String strText = "";
    843                RichTextString richText;
    844                int nCellType = oCell.getCellType();
    845                switch(nCellType) {
    846                        case Cell.CELL_TYPE_NUMERIC:
    847                                        strText = getNumericTypeString( oCell );
    848                                        break;
    849                        case Cell.CELL_TYPE_STRING:
    850        // POI3.0               strText = oCell.getStringCellValue();
    851                                        richText = oCell.getRichStringCellValue();
    852                                        if( richText != null ) {
    853                                                strText = richText.getString();
    854                                        }
    855                                        break;
    856                        case Cell.CELL_TYPE_FORMULA:
    857        // POI3.0               strText = oCell.getStringCellValue();
    858                                        // 5.5.1.2 (2012/04/06) フォーマットセルを実行して、その結果を再帰的に処理する。
    859                                        Workbook wb = oCell.getSheet().getWorkbook();
    860                                        CreationHelper crateHelper = wb.getCreationHelper();
    861                                        FormulaEvaluator evaluator = crateHelper.createFormulaEvaluator();
    862
    863                                        try {
    864                                                strText = getValue(evaluator.evaluateInCell(oCell));
    865                                        }
    866                                        catch ( Throwable th ) {
    867                                                String errMsg = "セルフォーマットが解析できません。[" + oCell.getCellFormula() + "]"
    868                                                                        + getLastCellMsg();
    869                                                throw new HybsSystemException( errMsg,th );
    870                                        }
    871                                        break;
    872                        case Cell.CELL_TYPE_BOOLEAN:
    873                                        strText = String.valueOf(oCell.getBooleanCellValue());
    874                                        break;
    875                        case Cell.CELL_TYPE_BLANK :
    876                        case Cell.CELL_TYPE_ERROR:
    877                                        break;
    878                        default :
    879                                break;
    880                }
    881                return strText.trim();
    882        }
    883
    884        /**
    885         * セル値が数字の場合に、数字か日付かを判断して、対応する文字列を返します。
    886         *
    887         * @og.rev 3.8.5.3 (2006/08/07) 新規追加
    888         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
    889         *
    890         * @param oCell Cell
    891         *
    892         * @return      数字の場合は、文字列に変換した結果を、日付の場合は、"yyyyMMddHHmmss" 形式で返します。
    893         */
    894        private String getNumericTypeString( final Cell oCell ) {
    895                final String strText ;
    896
    897                double dd = oCell.getNumericCellValue() ;
    898                if( DateUtil.isCellDateFormatted( oCell ) ) {
    899                        strText = HybsDateUtil.getDate( DateUtil.getJavaDate( dd ).getTime() , "yyyyMMddHHmmss" );      // 5.5.7.2 (2012/10/09) HybsDateUtil を利用
    900                }
    901                else {
    902                        NumberFormat numFormat = NumberFormat.getInstance();
    903                        if( numFormat instanceof DecimalFormat ) {
    904                                ((DecimalFormat)numFormat).applyPattern( "#.####" );
    905                        }
    906                        strText = numFormat.format( dd );
    907                }
    908                return strText ;
    909        }
    910
    911        /**
    912         * 最後に実行しているセル情報を返します。
    913         *
    914         * エラー発生時に、どのセルでエラーが発生したかの情報を取得できるようにします。
    915         *
    916         * @og.rev 5.5.1.2 (2012/04/06) 新規追加
    917         * @og.rev 5.5.8.2 (2012/11/09) エラー情報に、シート名も追加
    918         *
    919         * @return      最後に実行しているセル情報の文字列
    920         */
    921        String getLastCellMsg() {
    922                String lastMsg = null;
    923
    924                if( lastCell != null ) {
    925                        int rowNo = lastCell.getRowIndex();
    926                        int celNo = lastCell.getColumnIndex();
    927                        int no = lastCell.getColumnIndex();
    928                        String shtNm = lastCell.getSheet().getSheetName();
    929
    930
    931                        lastMsg = "Sheet=" + shtNm + ", Row=" + rowNo + ", Cel=" + celNo ;
    932                        if( orgNames != null && orgNames.length < no ) {
    933                                lastMsg = lastMsg + ", NAME=" + orgNames[no] ;
    934                        }
    935                }
    936                return lastMsg;
    937        }
    938}