    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.fukurou.model;
    017
    018import org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
    019import org.opengion.fukurou.util.StringUtil;    // 6.2.0.0 (2015/02/27)
    020import org.opengion.fukurou.util.FileInfo;              // 6.2.0.0 (2015/02/27)
    021
    022import java.util.List;
    023import java.util.ArrayList;
    024import java.util.Map;                                                   // 6.1.0.0 (2014/12/26) ConstData を Mapで管理
    025import java.util.HashMap;                                               // 6.1.0.0 (2014/12/26) ConstData を Mapで管理
    026import java.util.Arrays;                                                // 6.2.0.0 (2015/02/27)
    027import java.io.File;                                                    // 6.2.0.0 (2015/02/27)
    028
    029/**
    030 * EXCELやテキストファイルを、イベント方式に準拠して、読み込み処理を行います。
    031 * TableModelHelperイベントは、openGion形式のファイル読み取りに準拠した方法をサポートします。
    032 * ※ openGion形式のEXCEL/テキストファイルとは、#NAME 列に、カラム名があり、#で始まる
    033 *    レコードは、コメントとして判断し、読み飛ばす処理の事です。
    034 *
    035 * このイベントクラスは、サブクラスを作成し、EXCEL関連の EventReader_XLS、EventReader_XLSX
    036 * クラスや、EventReader_TEXT などのテキスト関連のクラスで、eventReader メソッドの引数に指定します。
    037 * EventReader_XLS と、EventReader_XLSX は、対象のEXCEL形式が異なりますが、実際は、
    038 * POIUtil#eventReader( String , TableModelHelper ) を使用すれば、拡張子に応じて使用するクラスを
    039 * 選択します。
    040 *
    041 * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    042 * @og.rev 6.2.0.0 (2015/02/27) パッケージ変更(util → model),クラス名変更(ExcelReaderEvent → TableModelHelper)
    043 * @og.group ファイル入力
    044 *
    045 * @version  6.0
    046 * @author   Kazuhiko Hasegawa
    047 * @since    JDK7.0,
    048 */
    049public class TableModelHelper {
    050        private int             nowRowNo        = -1;           // 現在の行番号
    051        private boolean isColSkip       ;                       // カラムスキップ中かどうか(true:スキップ中)
    052        private boolean isNowName       ;                       // カラム名配列の収集中かどうか(true:収集中)
    053        private boolean isReadBreak     ;                       // 読み取り処理を途中で中止するかどうか(true:中止)
    054        private String  nullBreakClm;                   // データがnullまたはゼロ文字列の場合に、Sheet読み取りを停止
    055        private String  nullSkipClm     ;                       // 6.2.3.0 (2015/05/01) 行読み飛ばし nullSkipClm追加
    056
    057        private int             skipRowCnt      ;                       // 読み飛ばす行数(読み飛ばし中でも ContDataは取得する)
    058        private int             nBrkClmNo = -1;                 // nullBreakClmの列番号
    059        private int             nSkpClmNo = -1;                 // 6.2.3.0 (2015/05/01) nullSkipClmの列番号
    060
    061        private int              clmSize        = -1 ;          // カラムサイズ(-1は未設定)
    062        private String[] names          ;                       // カラム名配列
    063        private String[] vals           ;                       // 値の文字列配列(１行分)
    064        private boolean useVals         ;                       // 値配列に設定されたか？
    065
    066        private List<Integer> colList   ;               // カラム番号:name が null かゼロ文字列の場合は、飛ばします。
    067        private List<String>  nmsList   ;               // カラム番号に対応したカラム名配列
    068
    069        private ConstData       cnstData        ;
    070
    071        private boolean         useDebug        ;               // 6.2.0.0 (2015/02/27) デバッグ情報の出力するかどうか。新規追加
    072
    073        /**
    074         * デフォルトコンストラクター
    075         *
    076         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    077         */
    078        public TableModelHelper() { super(); }          // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    079
    080        /**
    081         * ファイルの読み取り開始時にイベントが発生します。
    082         *
    083         * 新しいファイルの読み取り開始毎に、１回呼ばれます。
    084         * 戻り値が、true の場合は、そのファイルの読み取りを継続します。
    085         * false の場合は、そのファイルの読み取りは行われません。
    086         * 初期実装では、固定値設定処理を行っていますので、オーバーライドする場合は、
    087         * super.startFile(String,int) してください。
    088         * 初期実装では、true を返します。
    089         *
    090         * @og.rev 6.2.0.0 (2015/02/27) 新規作成
    091         *
    092         * @param   file  読み取りファイル
    093         * @return  読取継続するか [true:継続/false:読取らない]
    094         */
    095        public boolean startFile( final File file ) {
    096                if( useDebug ) { System.out.println( "startFile=[" + file + "]" ); }
    097                // ファイル属性を設定する。
    098                if( cnstData != null ) { cnstData.putConstFile( file ); }
    099                return true;
    100        }
    101
    102        /**
    103         * ファイルの読み取り終了時にイベントが発生します。
    104         *
    105         * 初期実装では、固定値設定処理を行っていますので、オーバーライドする場合は、
    106         * super.endFile(File) してください。
    107         *
    108         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    109         * @og.rev 6.1.0.0 (2014/12/26) シートブレイク処理追加
    110         *
    111         * @param   file  読み取りファイル
    112         */
    113        public void endFile( final File file ) {
    114                if( useDebug ) { System.out.println( "endFile=[" + file + "]" ); }
    115                isReadBreak = false;                    // 読み取り再開
    116                endRow();                                               // 行終了処理
    117                if( cnstData != null ) { cnstData.clearValsMap( ConstData.END_FILE ); }
    118        }
    119
    120        /**
    121         * シートの読み取り開始時にイベントが発生します。
    122         *
    123         * ※ EXCEL関係以外の読み取りでは、このイベントは発生しません。
    124         *
    125         * 新しいシートの読み取り開始毎に、１回呼ばれます。
    126         * 戻り値が、true の場合は、そのシートの読み取りを継続します。
    127         * false の場合は、そのシートの読み取りは行わず、次のシートまで
    128         * イベントは発行されません。
    129         * 初期実装では、固定値設定処理を行っていますので、オーバーライドする場合は、
    130         * super.startSheet(String,int) してください。
    131         * 初期実装では、true を返します。
    132         *
    133         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    134         *
    135         * @param   shtNm  シート名
    136         * @param   shtNo  シート番号(0～)
    137         * @return  読取継続するか [true:継続/false:読取らない]
    138         */
    139        public boolean startSheet( final String shtNm,final int shtNo ) {
    140                if( useDebug ) { System.out.println( "startSheet=[" + shtNm + "], No=[" + shtNo + "]" ); }
    141                // シート名を設定する。
    142                if( cnstData != null ) { cnstData.putConstSheet( shtNm ); }
    143                return true;
    144        }
    145
    146        /**
    147         * シートの読み取り終了時にイベントが発生します。
    148         *
    149         * ※ EXCEL関係以外の読み取りでは、このイベントは発生しません。
    150         *
    151         * #columnNames( String[] ) や、#values( String[] ,int ) などは、行の処理が完了した時点で
    152         * イベントが呼ばれるため、一番最後のレコードの終了条件が判りません。
    153         * そこで、このイベントを呼ぶことで、シートの終了(=最終行の終了)処理を行うことができます。
    154         *
    155         * 引数のシート番号は、参考情報で、#startSheet( String,int ) で呼ばれたシート番号と
    156         * 比較できるようにしています。
    157         * 初期実装では、固定値設定処理を行っていますので、オーバーライドする場合は、
    158         * super.endSheet(int) してください。
    159         *
    160         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    161         * @og.rev 6.1.0.0 (2014/12/26) シートブレイク処理追加
    162         *
    163         * @param   shtNo  シート番号(0～)
    164         */
    165        public void endSheet( final int shtNo ) {
    166                if( useDebug ) { System.out.println( "endSheet No=[" + shtNo + "]" ); }
    167                isReadBreak = false;                    // 読み取り再開
    168                endRow();                                               // 行終了処理
    169                if( cnstData != null ) { cnstData.clearValsMap( ConstData.END_SHEET ); }
    170        }
    171
    172        /**
    173         * 読み取り状態の時に、rowNo にある行データを引数にイベントが発生します。
    174         *
    175         * ※ 主に、行データの読み込み処理で使用されるメソッドです。
    176         *    このメソッドは、EventReader#eventReader( String , TableModelHelper )メソッドの
    177         *    処理の過程で、設定されます。
    178         *    このメソッドから、各種イベントが発行されます。
    179         *
    180         * 行データをセパレータで分解したのち、value( String ,int ,int ) メソッドを呼びます。
    181         * ただし、行データが、null、空文字列、#で始まる場合は、呼ばれません。
    182         *
    183         * @og.rev 6.2.0.0 (2015/02/27) 新規作成
    184         * @og.rev 6.2.1.0 (2015/03/13) 先頭に、'0 が含まれる場合のセミコロンや、前後のダブルクオートは削除
    185         * @og.rev 6.2.5.0 (2015/06/05) デバック時に１行単位に出力するのを止めます。
    186         *
    187         * @param   line        行データ
    188         * @param   rowNo       行番号(0～)
    189         * @param   sepa        セパレータ
    190         */
    191        protected void value( final String line,final int rowNo,final char sepa ) {
    192                nowRowNo = rowNo;       // 現在行の設定
    193
    194                // 値が存在する場合のみ、処理する。
    195                if( line!=null && !line.isEmpty()  ) {
    196                        // 6.2.5.0 (2015/06/05) デバック時に１行単位に出力するのを止めます。
    197        //              if( useDebug ) { System.out.println( "rowNo[" + rowNo + "], line=[" + line + "]" ); }
    198
    199                        // 先頭カラムのコメント判断と、#NAME列判断
    200                        if( line.charAt(0)=='#' ) {
    201                                // 互換性の問題。#NAME は、大文字小文字両方対応できないといけない。( 5 == "#NAME".length() の事)
    202                                if( clmSize <= 0 && line.length() >= 5 && "#NAME".equalsIgnoreCase( line.substring( 0,5 ) ) ) {
    203
    204                                        colList = new ArrayList<>() ;           // 初期化
    205                                        nmsList = new ArrayList<>() ;           // 初期化
    206                                        final String[] tmpNm = StringUtil.csv2Array( line ,sepa );
    207                                        for( int colNo=1; colNo<tmpNm.length; colNo++ ) {       // #NAME を無視(colNo=1～)
    208                                                final String nm = tmpNm[colNo];
    209                                                // #NAME 設定も、null や、ゼロ文字列の場合は、登録しない。(一番上の if で対処)
    210                                                if( nm != null && !nm.isEmpty() ) {
    211                                                        colList.add( Integer.valueOf( colNo ) );
    212                                                        nmsList.add( nm );
    213                                                }
    214                                        }
    215                                        isNowName = true;
    216                                }
    217                        }
    218                        // clmSize > 0 は、#NAME が設定済みという意味
    219                        else if( clmSize > 0 && skipRowCnt <= rowNo ) {         // skipRowCnt は、値セットだけ影響する。
    220                                final String[] tmpVals = StringUtil.csv2Array( line ,sepa );
    221        //                      if( cnstData != null ) { tmpVals = cnstData.getConstVals( tmpVals ); }
    222        //                      int min = Math.min( clmSize,tmpVals.length );
    223
    224                                for( int i=0; i<clmSize; i++ ) {
    225                                        final int indx = colList.get( i );                      // カラム番号の位置が 値配列の配列番号
    226                                        if( indx >= 0 && indx < tmpVals.length ) {
    227                                                vals[i] = StringUtil.csvOutQuote( tmpVals[indx] );              // 6.2.1.0 (2015/03/13)
    228                                        }
    229                                }
    230                                useVals = true;
    231        //                      values( vals , rowNo );                                                 // イベント発行(現在行)
    232                        }
    233
    234                        endRow();                               // 行末処理実行。名前設定処理が走ります。
    235                }
    236        }
    237
    238        /**
    239         * 読み取り状態の時に、rowNo,colNo にあるセルの値を引数にイベントが発生します。
    240         *
    241         * ※ 主に、EXCEL関係の読み取り処理で使用されるメソッドです。
    242         *    このメソッドは、EventReader#eventReader( String , TableModelHelper )メソッドの
    243         *    処理の過程で、設定されます。
    244         *    このメソッドから、各種イベントが発行されます。
    245         *
    246         * 戻り値が、true の場合は、その行の読み取りを継続します。
    247         * false の場合は、その行の読み取りは行わず、次の行まで
    248         * イベントは発行されません。
    249         *
    250         * openGion での標準的な処理は、colNo==0 の時に、val の先頭が、# で
    251         * 始まる場合は、その行はスキップします。
    252         * ここでの return は、#isSkip( int ) と逆になりますので、ご注意ください。
    253         * 初期実装では、#NAME処理、行スキップ、行終了処理等を実行します。
    254         * オーバーライドする場合は、super.value(String,int,int) してください。
    255         *
    256         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    257         * @og.rev 6.2.2.0 (2015/03/27) 先頭に、'0 が含まれる場合のセミコロンや、前後のダブルクオートは削除
    258         * @og.rev 6.2.3.0 (2015/05/01) 行読み飛ばし nullSkipClm追加
    259         *
    260         * @param   val     文字列値
    261         * @param   rowNo   行番号(0～)
    262         * @param   colNo   列番号(0～)
    263         * @return  読み取りするかどうか(true:読み取りする/false:読み取りしない)
    264         * @see         #isSkip( int )
    265         */
    266        protected boolean value( final String val,final int rowNo,final int colNo ) {
    267        //      if( useDebug ) { System.out.println( "R[" + rowNo + "," + colNo + "]=" + val ); }
    268
    269                // 値が存在する場合のみ、処理する。
    270                if( val!=null && val.length()>0 ) {
    271                        // 行番号が異なった場合は、行の終了処理を実行する。
    272                        if( nowRowNo != rowNo ) {
    273                                endRow();                                                                       // 行終了処理
    274                                nowRowNo = rowNo;                                                       // 現在行の設定
    275                        }
    276
    277                        // 固定文字の設定なので、コメントもスキップも無関係
    278                        if( cnstData != null ) { cnstData.putConstValue( val,rowNo,colNo ); }
    279
    280                        // 先頭カラムのコメント判断と、#NAME列判断
    281                        if( colNo==0 && val.charAt(0)=='#' ) {
    282                                if( "#NAME".equalsIgnoreCase( val ) && clmSize <= 0 ) { // clmSize <= 0 は、#NAME未設定という意味
    283                                        isNowName = true ;
    284                                        colList = new ArrayList<>() ;           // 初期化
    285                                        nmsList = new ArrayList<>() ;           // 初期化
    286                                }
    287                                isColSkip = !isNowName;                                         // #NAME の場合は、false(SKIPしない)
    288                        }
    289                        else if( isNowName ) {                                                  // #NAME処理中
    290                                // #NAME 設定も、null や、ゼロ文字列の場合は、登録しない。(一番上の if で対処)
    291                                colList.add( Integer.valueOf( colNo ) );
    292                                nmsList.add( val );
    293                        }
    294                        // 6.2.3.0 (2015/05/01) 行読み飛ばし nullSkipClm追加
    295                        else if( nSkpClmNo >= 0 && StringUtil.isNull( vals[nSkpClmNo] ) ) {             // nullSkipClm 処理
    296                                isColSkip = true;       // Skip する
    297                        }
    298                        // clmSize > 0 は、#NAME が設定済みという意味
    299                        else if( clmSize > 0 && skipRowCnt <= rowNo ) {                                         // skipRowCnt は、値セットだけ影響する。
    300                                final int indx = colList.indexOf( Integer.valueOf( colNo ) );   // カラム番号の位置が 値配列の配列番号
    301                                if( indx >= 0 ) {
    302                                        vals[indx] = StringUtil.csvOutQuote( val );                                     // 6.2.2.0 (2015/03/27)
    303                                        useVals = true;
    304                                }
    305                        }
    306                }
    307
    308                return !isColSkip;
    309        }
    310
    311        /**
    312         * rowNo を元に、この行をスキップするかどうか判定のイベントが発生します。
    313         *
    314         * ※ EXCEL関係の列毎にイベントが発生する場合の列処理をスキップするのが目的です。
    315         *    行単位に読み込む場合や、行のループに入れても、意味はありません。
    316         *    引数から、行のループに入れてしまいそうですが、行列のループに入れてください。
    317         *
    318         * ※ 主に、EXCEL関係の読み取り処理で使用されるメソッドです。
    319         *    このメソッドは、EventReader#eventReader( String , TableModelHelper )メソッドの
    320         *    処理の過程で、設定されます。
    321         *    このメソッドから、各種イベントが発行されます。
    322         *
    323         * 戻り値が、true の場合は、その行の読み取りをスキップします。
    324         * false の場合は、読み取り処理を継続します。
    325         * スキップ中は、行に関するイベントは発行されません。
    326         *
    327         * 値(val)を求める前に、行情報を入手し、スキップ中の現在行と同じ場合に、スキップ(=true)と判定します。
    328         * スキップ中かどうかは、#value( String,int,int ) で、判定します。
    329         * 初期実装では、スキップ中 かつ 現在行と同じ行の場合、または、シートブレーク中の場合に、true を返します。
    330         *
    331         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    332         * @og.rev 6.1.0.0 (2014/12/26) シートブレイク処理追加
    333         *
    334         * @param   rowNo   行番号(0～)
    335         * @return  スキップするかどうか(true:スキップする/false:スキップしない)
    336         * @see         #value( String,int,int )
    337         */
    338        protected boolean isSkip( final int rowNo ) {
    339                return isColSkip && nowRowNo == rowNo || isReadBreak ;
    340        }
    341
    342        /**
    343         * 行の終了時に実行されます。
    344         *
    345         * ここでは、rowNo がブレークするか、シート終了時に呼ぶことで、
    346         * 一番最後の行の処理を行います。
    347         *
    348         * #NAME 処理中の場合(isNowName == true) は、カラム名配列を作成して、
    349         * columnNames イベントを呼び出します。
    350         * 値配列が設定されている場合(useVals == true) は、values イベントを
    351         * 呼び出します。
    352         * #NAME 処理が完了している場合は、値配列の初期化を行います。
    353         * そのうえで、スキップの解除(isColSkip = false)と行データ
    354         * 未設定(useVals = false)に、初期化します。
    355         *
    356         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    357         * @og.rev 6.2.2.0 (2015/03/27) Overflow処理は、Tag側に戻す。
    358         * @og.rev 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
    359         *
    360         * @see         #columnNames( String[] )
    361         * @see         #values( String[],int )
    362         */
    363        private void endRow() {
    364                if( isNowName ) {                                                               // #NAME 処理中の場合
    365                        // 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
    366                        if( colList == null ) {
    367                                final String errMsg = "#value(String,int,char) または#value(String,int,int) を先に実行しておいてください。" ;
    368                                throw new OgRuntimeException( errMsg );
    369                        }
    370
    371                        clmSize = colList.size();
    372                        names   = nmsList.toArray( new String[clmSize] );
    373                        if( nullBreakClm != null ) {
    374                                for( int i=0; i<clmSize; i++ ) {
    375                                        if( nullBreakClm.equalsIgnoreCase( names[i] ) ) {
    376                                                nBrkClmNo = i;
    377                                                break;
    378                                        }
    379                                }
    380                        }
    381                        // 6.2.3.0 (2015/05/01) 行読み飛ばし nullSkipClm追加
    382                        if( nullSkipClm != null ) {
    383                                for( int i=0; i<clmSize; i++ ) {
    384                                        if( nullSkipClm.equalsIgnoreCase( names[i] ) ) {
    385                                                nSkpClmNo = i;
    386                                                break;
    387                                        }
    388                                }
    389                        }
    390
    391                        if( cnstData != null ) { cnstData.setColumns( names ); }
    392                        columnNames( names.clone() );                           // イベント
    393                        isNowName = false;
    394                        nmsList   = null ;              // 不要
    395                }
    396                else if( useVals ) {                                                    // 値配列が設定されている場合
    397                        if( nBrkClmNo >= 0 && StringUtil.isNull( vals[nBrkClmNo] ) ) {          // nullBreakClm 処理
    398                                isReadBreak = true;                                                                                             // ReadBreak する。
    399                        }
    400                        else {
    401                                if( cnstData != null ) { vals = cnstData.getConstVals( vals ); }
    402                                values( vals , nowRowNo );                                      // イベント発行(現在行)
    403                        }
    404                }
    405
    406                if( clmSize > 0 ) {                                                             // clmSize > 0 は、#NAME が設定済みという意味
    407                        vals = new String[clmSize];                                     // 値配列の初期化
    408                }
    409
    410                isColSkip = false;                                              // スキップの解除
    411                useVals   = false;                                              // 行データ未設定にする。
    412        }
    413
    414        /**
    415         * シート数のイベントが発生します。
    416         *
    417         * ※ EXCEL関係以外の読み取りでは、このイベントは発生しません。
    418         *
    419         * 処理の開始前に、シート数のイベントが発生します。
    420         * これを元に、処理するシート番号の選別が可能です。
    421         *
    422         * @og.rev 6.1.0.0 (2014/12/26) シートの数のイベント
    423         *
    424         * @param   size  シート数
    425         */
    426        public void sheetSize( final int size ) {
    427                if( useDebug ) { System.out.println( "sheetSize=[" + size + "]" ); }
    428        }
    429
    430        /**
    431         * カラム名配列がそろった段階で、イベントが発生します。
    432         *
    433         * openGion での標準的な処理は、colNo==0 の時に、val の先頭が、#NAME
    434         * で始まるレコードを、名前配列として認識します。
    435         * #value( String,int,int ) で、この #NAME だけは、継続処理されます。
    436         * その上で、#NAME レコードが終了した時点で、カラム名配列が完成するので
    437         * そこで初めて、このメソッドが呼ばれます。(EXCEL関係の場合)
    438         *
    439         * 外部から設定する、#setNames( String , boolean ) 時も同様に呼ばれます。
    440         *
    441         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    442         *
    443         * @param   names  カラム名配列
    444         * @see         #value( String,int,int )
    445         * @see         #setNames( String , boolean )
    446         */
    447        public void columnNames( final String[] names ) {
    448                if( useDebug ) { System.out.println( "columnNames=[" + Arrays.toString(names) + "]" ); }
    449        }
    450
    451        /**
    452         * row にあるセルのオブジェクト値がそろった段階で、イベントが発生します。
    453         *
    454         * 初期実装は、何もありません。
    455         *
    456         * @og.rev 6.0.3.0 (2014/11/13) 新規作成
    457         *
    458         * @param   vals    文字列値の１行分の配列
    459         * @param   rowNo   行番号(0～)
    460         */
    461        public void values( final String[] vals,final int rowNo ) {
    462                if( useDebug ) { System.out.println( "values[" + rowNo + "]=[" + Arrays.toString(vals) + "]" ); }
    463        }
    464
    465        /**
    466         * 外部からCSV形式のカラム名文字列を設定します。
    467         *
    468         * ※ イベント処理実行前の初期化処理です。
    469         *
    470         * カラム名配列を、#NAME で始まるレコードではなく、外部から指定します。
    471         * ここで設定した場合、#columnNames( String[] )イベントも発生します。
    472         * null か、長さゼロのカラム名は、設定されません。
    473         *
    474         * @og.rev 6.1.0.0 (2014/12/26) カラム名配列設定の対応
    475         *
    476         * @param   clms  CSV形式のカラム名文字列
    477         * @param       useNumber       行番号情報 [true:使用している/false:していない]
    478         * @see         #columnNames( String[] )
    479         */
    480        public void setNames( final String clms , final boolean useNumber ) {
    481                if( clms != null && clms.length() > 0 ) {
    482                        if( useDebug ) { System.out.println( "setNames=[" + clms + "]" ); }
    483
    484                        colList = new ArrayList<>() ;   // 初期化
    485                        nmsList = new ArrayList<>() ;           // 初期化
    486
    487                        final String[] nms = StringUtil.csv2Array( clms );
    488                        final int adrs = useNumber ? 1:0 ;      // useNumber =true の場合は、１件目(No)は読み飛ばす。
    489                        for( int i=0; i<nms.length; i++ ) {
    490                                // null か、長さゼロのカラム名は、設定されません。
    491                                final String nm = nms[i];
    492                                if( nm != null && nm.length() > 0 ) {
    493                                        colList.add( Integer.valueOf( i+adrs ) );
    494                                        nmsList.add( nm );
    495                                }
    496                        }
    497
    498                        isNowName = true;               // 名前設定中
    499                        useVals   = false;              // データ未設定
    500                        endRow();                               // 行末処理実行。名前設定処理が走ります。
    501
    502                }
    503        }
    504
    505        /**
    506         * カラム名配列が、設定されたかどうか、返します。
    507         *
    508         * カラム名配列は、#NAME で始まるレコードか、#setNames( String,boolean )メソッドを
    509         * 使用して、外部から指定します。
    510         * カラム名配列が未設定の場合は、データもセットできないので、処理の最後の判定に使います。
    511         *
    512         * @og.rev 6.1.0.0 (2014/12/26) カラム名配列設定の対応
    513         *
    514         * @return      カラム名配列が、設定されたかどうか(true:設定済み/false:未設定)
    515         * @see         #setNames( String,boolean )
    516         */
    517        public boolean isNameSet() {
    518                return clmSize > 0;                     // clmSize > 0 は、#NAME が設定済みという意味
    519        }
    520
    521        /**
    522         * 以降のデータを読み飛ばすかどうかを指定します(初期値:false)。
    523         *
    524         * データを読み込む途中で、それ以降のデータを読み込む必要がなくなった場合に、
    525         * true に設定すると、以降のデータを今のシート/ファイルが終了するまで、スキップします。
    526         * 例えば、読み込むべき必須カラムで判定する、nullBreakClm 機能を実現できます。
    527         * 初期値は、false:読み飛ばさない です。
    528         *
    529         * @og.rev 6.1.0.0 (2014/12/26) シートブレイク処理追加
    530         *
    531         * @param   flag  以降のデータを読み飛ばすかどうか [true:読み飛ばす/false:読み飛ばさない]
    532         * @see         #isSkip( int )
    533         */
    534        public void setReadBreak( final boolean flag ) {
    535                isReadBreak = flag ;
    536        }
    537
    538        /**
    539         * 先頭データの読み飛ばし件数を設定します。
    540         *
    541         * ※ イベント処理実行前の初期化処理です。
    542         *
    543         * データの読み始めの行を指定します。
    544         * シート/ファイルの先頭行が、０行としてカウントしますので、設定値は、読み飛ばす
    545         * 件数になります。(１と指定すると、１件読み飛ばし、２件目から読み込みます。)
    546         * 読み飛ばしは、コメント行などは、無視しますので、実際の行数分読み飛ばします。
    547         * ＃NAME属性や、columns 属性は、読み飛ばし中でも処理対象行になります。
    548         *
    549         * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    550         *
    551         * @param       count 読み始めの初期値(0なら、読み飛ばしなし)
    552         */
    553        public void setSkipRowCount( final int count ) {
    554                skipRowCnt = count;
    555        }
    556
    557        /**
    558         * ここに指定されたカラム列に NULL/ゼロ文字列 が現れた時点でSheetの読み取りを中止します。
    559         *
    560         * これは、指定のカラムは必須という事を条件に、そのレコードだけを読み取る処理を行います。
    561         * 複数Sheetの場合は、次のSheetを読みます。
    562         * Sheetが存在しない場合(通常のテキスト等)では、読み取り処理の終了になります。
    563         *
    564         * @og.rev 6.2.0.0 (2015/02/27) 新規追加
    565         *
    566         * @param   clm カラム列
    567         */
    568        public void setNullBreakClm( final String clm ) {
    569                nullBreakClm = clm;
    570        }
    571
    572        /**
    573         * ここに指定されたカラム列に NULL が現れたレコードは読み飛ばします。
    574         *
    575         * 例えば、更新対象カラムで、null の場合は、何もしない、などのケースで使用できます。
    576         * 複数カラムの場合は、AND条件やOR条件などが、考えられるため、
    577         * カラムを一つにまとめて、指定してください。
    578         *
    579         * @og.rev 6.2.3.0 (2015/05/01) 行読み飛ばし nullSkipClm追加
    580         *
    581         * @param   clm カラム列
    582         */
    583        public void setNullSkipClm( final String clm ) {
    584                nullSkipClm = clm;
    585        }
    586
    587        /**
    588         * 固定値となるカラム名(CSV形式)と、固定値となるアドレス(行-列,行-列...) or(A1,B3...)を設定します。
    589         *
    590         * ※ イベント処理実行前の初期化処理です。
    591         *
    592         * アドレスは、EXCEL上の行-列か、EXCEL列のA1,B3 などの形式を、CSV形式で指定します。
    593         * 行列は、EXCELオブジェクトに準拠するため、０から始まる整数です。
    594         * 0-0 ⇒ A1 , 1-0 ⇒ A2 , 0-1 ⇒ B1 になります。
    595         * これにより、シートの一か所に書かれている情報を、DBTableModel のカラムに固定値として
    596         * 設定することができます。
    597         * 例として、DB定義書で、テーブル名をシートの全レコードに設定したい場合などに使います。
    598         *
    599         * 5.7.6.3 (2014/05/23) より、
    600         *   ①EXCEL表記に準拠した、A1,A2,B1 の記述も処理できるように対応します。
    601         *     なお、A1,A2,B1 の記述は、必ず、英字1文字＋数字 にしてください。(A～Zまで)
    602         *     EXCEL2007形式で列数が拡張されていますが、列数は制限しています。
    603         *   ②処理中のEXCELシート名をカラムに割り当てるために、"SHEET" という記号に対応します。
    604         * 6.2.0.0 (2015/02/27) より、
    605         *   ③EXCEL以外では、"FILE","NAME","SUFIX" が使えます。(EXCEL時にも使えます。)
    606         *     NAME は、ファイル名から拡張子を取り除いた文字列になります。(AAA/BBB/CCC.xls → CCC)
    607         * 例えば、sheetConstKeys="CLM,LANG,NAME" とし、sheetConstAdrs="0-0,A2,SHEET" とすると、
    608         * NAMEカラムには、シート名を読み込むことができます。
    609         * これは、内部処理の簡素化のためです。
    610         *
    611         * ちなみに、EXCELのセルに、シート名を表示させる場合の関数は、下記の様になります。
    612         * =RIGHT(CELL("filename",$A$1),LEN(CELL("filename",$A$1))-FIND("]",CELL("filename",$A$1)))
    613         *
    614         * @og.rev 5.5.8.2 (2012/11/09) 新規追加
    615         * @og.rev 5.7.6.3 (2014/05/23) EXCEL表記(A2,B1等)の対応と、特殊記号(SHEET)の対応
    616         * @og.rev 6.1.0.0 (2014/12/26) カラム名配列設定の対応
    617         *
    618         * @param       constKeys       固定値となるカラム名(CSV形式)
    619         * @param       constAdrs       固定値となるアドレス(行-列,行-列...) or(A1,B3...)
    620         */
    621        public void setConstData( final String constKeys,final String constAdrs ) {
    622                if( constKeys != null && !constKeys.isEmpty() && constAdrs != null && !constAdrs.isEmpty() ) {
    623                        cnstData = new ConstData( constKeys,constAdrs );
    624                        // setNames( String , boolean ) と、このメソッドの呼び出し順に影響がないようにするため。
    625                        if( names != null ) { cnstData.setColumns( names ); }
    626                }
    627        }
    628
    629        /**
    630         * デバッグ情報を出力するかどうか[true:する/false:しない]を指定します。
    631         *
    632         * EXCELなどを読み取る場合、シートマージで読み取ると、エラー時の行番号が、連番になるため、
    633         * どのシートなのか、判らなくなります。
    634         * そこで、どうしてもわからなくなった場合に備えて、デバッグ情報を出力できるようにします。
    635         * 通常は使用しませんので、設定を無視します。
    636         * 初期値は、false:デバッグ情報を出力しない です。
    637         *
    638         * @og.rev 6.2.0.0 (2015/02/27) デバッグ情報の出力するかどうか。新規追加
    639         *
    640         * @param       useDebug        デバッグ出力するか [true:する/false:しない]
    641         */
    642        public void setDebug( final boolean useDebug ) {
    643                this.useDebug = useDebug;
    644        }
    645
    646        /**
    647         * デバッグ情報を出力するかどうか[true:する/false:しない]を取得します。
    648         *
    649         * EXCELなどを読み取る場合、シートマージで読み取ると、エラー時の行番号が、連番になるため、
    650         * どのシートなのか、判らなくなります。
    651         * そこで、どうしてもわからなくなった場合に備えて、デバッグ情報を出力できるようにします。
    652         *
    653         * @og.rev 6.2.0.0 (2015/02/27) デバッグ情報の出力するかどうか。新規追加
    654         *
    655         * @return      デバッグ出力 [true:する/false:しない]
    656         */
    657        protected boolean isDebug() {
    658                return useDebug ;
    659        }
    660
    661        /**
    662         * EXCELファイルの所定の位置から、固定値を取り出す処理を管理します。
    663         *
    664         * この固定値の取出しは、内部処理に、非常に依存しているため、今は、
    665         * TableModelHelper クラスに含めていますが、将来的には、分ける予定です。
    666         *
    667         * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    668         * @og.rev 6.2.0.0 (2015/02/27) 特殊記号(FILE,NAME,SUFIX)追加
    669         *
    670         * @version  6.0
    671         * @author   Kazuhiko Hasegawa
    672         * @since    JDK7.0,
    673         */
    674        private static final class ConstData {
    675                /** 内部情報のクリア方法の指定 {@value} */
    676                public static final int END_FILE  = 1 ;
    677                /** 内部情報のクリア方法の指定 {@value} */
    678                public static final int END_SHEET = 2 ;
    679
    680                // 6.2.0.0 (2015/02/27) 特殊記号処理 追加 (SHEET,FILE,NAME,SUFIX)
    681                private static final String KEYS = ",SHEET,FILE,NAME,SUFIX,";
    682
    683                // ①cnstMap は、cnstKey をキーに、拾ってきた値を持っています。(Sheet毎のトランザクション)
    684                private final Map<String,String> cnstMap   = new HashMap<>();                   // 6.1.0.0 (2014/12/26) Mapで管理
    685                // ②rowcolMap は、rowcol をキーに、アドレスを持っています。
    686                private final Map<String,Integer> rowcolMap = new HashMap<>();          // 6.1.0.0 (2014/12/26) Mapで管理
    687                // ③valsMap は、アドレス をキーに、拾ってきた値を持っています。(Sheet毎のトランザクション)
    688                private final Map<Integer,String> valsMap   = new HashMap<>();          // 6.1.0.0 (2014/12/26) Mapで管理
    689
    690                private final int maxRow  ;             // 6.4.9.1 (2016/08/05) final化。最大値持っておき、判定処理を早める。
    691
    692                // ※ rowcolMap を使用する為、必ず #setColumns( String... ) の実行後に行います。
    693                private boolean isNameSet ;
    694                private File    tmpFile   ;
    695                private String  tmpShtNm  ;
    696
    697                /**
    698                 * 固定値となるカラム名(CSV形式)と、固定値となるアドレス(行-列,行-列...) or(A1,B3...)を設定します。
    699                 *
    700                 * アドレスは、EXCEL上の行-列か、EXCEL列のA1,B3 などの形式を、CSV形式で指定します。
    701                 * 行列は、EXCELオブジェクトに準拠するため、０から始まる整数です。
    702                 * 0-0 ⇒ A1 , 1-0 ⇒ A2 , 0-1 ⇒ B1 になります。
    703                 * これにより、シートの一か所に書かれている情報を、DBTableModel のカラムに固定値として
    704                 * 設定することができます。
    705                 * 例として、DB定義書で、テーブル名をシートの全レコードに設定したい場合などに使います。
    706                 *
    707                 * 5.7.6.3 (2014/05/23) より、
    708                 *   ①EXCEL表記に準拠した、A1,A2,B1 の記述も処理できるように対応します。
    709                 *     なお、A1,A2,B1 の記述は、必ず、英字1文字＋数字 にしてください。(A～Zまで)
    710                 *     EXCEL2007形式で列数が拡張されていますが、列数は制限しています。
    711                 *   ②処理中のEXCELシート名をカラムに割り当てるために、"SHEET" という記号に対応します。
    712                 * 6.2.0.0 (2015/02/27) より、
    713                 *   ③EXCEL以外では、"FILE","NAME","SUFIX" が使えます。
    714                 *     NAME は、ファイル名から拡張子を取り除いた文字列になります。(AAA/BBB/CCC.xls → CCC)
    715                 * 例えば、sheetConstKeys="CLM,LANG,SHT" とし、sheetConstAdrs="0-0,A2,SHEET" とすると、
    716                 * SHTカラムには、シート名を読み込むことができます。
    717                 * これは、内部処理の簡素化のためです。
    718                 *
    719                 * ちなみに、EXCELのセルに、シート名を表示させる場合の関数は、下記の様になります。
    720                 * =RIGHT(CELL("filename",$A$1),LEN(CELL("filename",$A$1))-FIND("]",CELL("filename",$A$1)))
    721                 *
    722                 * @og.rev 5.5.8.2 (2012/11/09) 新規追加
    723                 * @og.rev 5.7.6.3 (2014/05/23) EXCEL表記(A2,B1等)の対応と、特殊記号(SHEET)の対応
    724                 * @og.rev 6.1.0.0 (2014/12/26) カラム名配列設定の対応
    725                 * @og.rev 6.2.0.0 (2015/02/27) 特殊記号(FILE,NAME,SUFIX)の追加対応
    726                 * @og.rev 6.4.9.1 (2016/08/05) maxRowをfinal化します。
    727                 *
    728                 * @param       constKeys       固定値となるカラム名(CSV形式)
    729                 * @param       constAdrs       固定値となるアドレス(行-列,行-列...) or(A1,B3...)
    730                 */
    731                ConstData( final String constKeys,final String constAdrs ) {
    732                        final String[] cnstKeys = constKeys.split( "," );
    733                        final String[] row_col  = constAdrs.split( "," );
    734
    735                        if( cnstKeys.length != row_col.length ) {
    736                                final String errMsg = "キーに対するアドレスの個数が不一致です。Keys=[" + constKeys + "]"
    737                                                        + " , Adrs=[" + constAdrs + "]" ;
    738                                throw new OgRuntimeException( errMsg );
    739                        }
    740
    741                        int tmpRow = -1;                                                                // 6.4.9.1 (2016/08/05)
    742                        // 初期の カラムとアドレス(キーワード)の関連付け
    743                        for( int j=0; j<cnstKeys.length; j++ ) {
    744                                final String cnstKey = cnstKeys[j].trim();      // 前後の不要なスペースを削除
    745                                if( !cnstKey.isEmpty() ) {
    746                                        String rowcol = row_col[j].trim();              // 前後の不要なスペースを削除
    747                                        if( !rowcol.isEmpty() ) {
    748                                                // 5.7.6.3 (2014/05/23) EXCEL表記(A2,B1等)の対応と、特殊記号(SHEET)の対応
    749                                                final int sep = rowcol.indexOf( '-' );
    750                                                if( sep > 0 ) {
    751                                                        final int row = Integer.parseInt( rowcol.substring( 0,sep ) );
    752                        //                              int col = Integer.parseInt( rowcol.substring( sep+1 ) );
    753                                                        if( tmpRow < row ) { tmpRow = row; }    // 6.4.9.1 (2016/08/05)
    754                        //                              rowcol = String.valueOf( (char)('A' + col) ) + String.valueOf( row + 1 ) ;      // row-col 形式なので、不要
    755                                                }
    756                                                // 6.2.0.0 (2015/02/27) 特殊記号(SHEET,FILE,NAME,SUFIX)の追加対応
    757                                                else if( !KEYS.contains( ',' + rowcol + ',' ) ) {
    758                                                        final int row = Integer.parseInt( rowcol.substring( 1 ) ) -1;           // C6 の場合、rowは、6-1=5
    759                                                        final int col = rowcol.charAt(0) - 'A' ;                                                        // C6 の場合、colは、'C'-'A'=2
    760                                                        if( tmpRow < row ) { tmpRow = row; }    // 6.4.9.1 (2016/08/05)
    761                                                        rowcol = row + "-" + col ;
    762                                                }
    763                                                cnstMap.put( cnstKey , rowcol );                // 6.1.0.0 (2014/12/26) cnstMap に行列情報を設定する
    764                                        }
    765                                }
    766                        }
    767                        maxRow = tmpRow;
    768                }
    769
    770                /**
    771                 * カラム名配列を元に、固定値カラムのアドレスを求めます。
    772                 * カラム名配列は、順番に、指定する必要があります。
    773                 *
    774                 * @og.rev 6.1.0.0 (2014/12/26) カラム名配列設定の対応
    775                 *
    776                 * @param       names   カラム列配列(可変長引数)
    777                 */
    778                /* default */ void setColumns( final String... names ) {
    779                        // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。
    780                        if( names != null && names.length > 0 ) {
    781                                // 5.5.8.2 (2012/11/09) 固定値取得用の cnstIndx の設定を行う。
    782                                for( int i=0; i<names.length; i++ ) {
    783                                        final String rowcol = cnstMap.get( names[i] );          // cnstKey があれば、rowcol が取得できるはず
    784                                        if( rowcol != null ) {
    785                                                rowcolMap.put( rowcol , Integer.valueOf( i ) );
    786                                        }
    787                                }
    788                                isNameSet = true;                       // 名前設定がされないと、FILEやSHEET キーワードが使えない。
    789
    790                                if( tmpFile  != null ) { putConstFile(  tmpFile  ); }
    791                                if( tmpShtNm != null ) { putConstSheet( tmpShtNm ); }
    792                        }
    793                }
    794
    795                /**
    796                 * 読み取り時に、rowNo,colNo にあるセルの値を、固定値となるカラム名に関連付けます。
    797                 *
    798                 * イベントモデルでは、固定値の指定アドレス(rowNo,colNo)をピンポイントで取得することが
    799                 * できないため、イベント発生毎に、チェックする必要があります。
    800                 * そのため、固定値を使用すると、処理速度が低下します。
    801                 *
    802                 * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    803                 *
    804                 * @param   val     文字列値(null またはゼロ文字列は、不可)
    805                 * @param   rowNo   行番号(0～)
    806                 * @param   colNo   列番号(0～)
    807                 */
    808                /* default */ void putConstValue( final String val,final int rowNo,final int colNo ) {
    809                        if( rowNo <= maxRow ) {
    810                                final String rowcol = rowNo + "-" + colNo ;
    811                                final Integer adrs = rowcolMap.get( rowcol );
    812                                if( adrs != null ) {
    813                                        valsMap.put( adrs,val );
    814                                }
    815                        }
    816                }
    817
    818                /**
    819                 * ファイル系特殊記号(FILE,NAME,SUFIX)を指定します。
    820                 *
    821                 * ../AAA/BBB/CCC.XLS というファイルオブジェクトに対して、
    822                 *   FILE    : CCC.XLS ファイル名
    823                 *   NAME    : CCC     拡張子なしのファイル名
    824                 *   SUFIX   : xls     ピリオド無しの拡張子(小文字に統一)
    825                 *
    826                 * これは、新しいファイルの読み取り開始時に、設定します。
    827                 *
    828                 * ※ rowcolMap を使用する為、必ず #setColumns( String... ) の実行後に行います。
    829                 *
    830                 * @og.rev 6.2.0.0 (2015/02/27) 新規作成
    831                 *
    832                 * @param   filNm  指定ファイル
    833                 */
    834                /* default */ void putConstFile( final File filNm ) {
    835                        if( filNm != null ) {
    836                                tmpFile = filNm;                // 名前設定がされるまで、一時保管する。(順番があるので呼ばれればセットしておく)
    837                                if( isNameSet ) {               // 名前設定がされないと、FILEやSHEET キーワードが使えない。
    838                                        final FileInfo info = new FileInfo( filNm );
    839
    840                                        for( final String key : FileInfo.KEY_LIST ) {
    841                                                final Integer adrs = rowcolMap.get( key );
    842                                                if( adrs != null ) {
    843                                                        final String val = info.getValue( key );
    844                                                        if( val != null ) {
    845                                                                valsMap.put( adrs,val );
    846                                                        }
    847                                                }
    848                                        }
    849                                }
    850                        }
    851                }
    852
    853                /**
    854                 * シート名を外部から指定します。
    855                 * アドレス指定の特殊系として、"SHEET" 文字列を指定できます。
    856                 * これは、新しいシートの読み取り開始時に、設定します。
    857                 *
    858                 * ※ rowcolMap を使用する為、必ず #setColumns( String... ) の実行後に行います。
    859                 *
    860                 * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    861                 *
    862                 * @param       shtNm   シート名
    863                 */
    864                /* default */ void putConstSheet( final String shtNm ) {
    865                        if( shtNm != null ) {
    866                                tmpShtNm = shtNm;               // 名前設定がされるまで、一時保管する。
    867                                if( isNameSet ) {               // 名前設定がされないと、FILEやSHEET キーワードが使えない。
    868                                        final Integer adrs = rowcolMap.get( "SHEET" );
    869                                        if( adrs != null ) {
    870                                                valsMap.put( adrs,shtNm );
    871                                        }
    872                                }
    873                        }
    874                }
    875
    876                /**
    877                 * 内部の valsMap を初期化します。
    878                 * 固定値の読み取りは、シートごとに行います。
    879                 * 新しいシートにデータが設定されていない場合、前のシートの値が残ります。
    880                 * ここでは、シート呼出しごとに、毎回クリアします。
    881                 * 引数に応じて、クリアする範囲を限定します。
    882                 * END_FILE 時は、すべてクリア。END_SHEET 時は、ファイル情報は残します。
    883                 *
    884                 * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    885                 *
    886                 * @param   type 内部情報のクリア方法の指定(END_FILE or END_SHEET)
    887                 */
    888                /* default */ void clearValsMap( final int type ) {
    889                        valsMap.clear();
    890                        if( type == END_SHEET ) { putConstFile( tmpFile ); }    // 全削除後にファイル情報を再設定
    891                }
    892
    893                /**
    894                 * 値配列のデータに、固定値を設定します。
    895                 * 引数の文字列配列に、固定値を設定しますので、配列オブジェクト自体を更新します。
    896                 *
    897                 * @og.rev 6.1.0.0 (2014/12/26) Excel関係改善
    898                 * @og.rev 6.4.3.4 (2016/03/11) forループを、forEach メソッドに置き換えます。
    899                 *
    900                 * @param   vals    文字列値の１行分の配列
    901                 * @return  固定値を設定された１行分の文字列配列
    902                 */
    903                /* default */ String[] getConstVals( final String[] vals ) {
    904                        if( vals != null && vals.length > 0 ) {
    905                                // 6.4.3.4 (2016/03/11) forループを、forEach メソッドに置き換えます。
    906                                valsMap.forEach( (k,v) -> {
    907                                                        if( k < vals.length ) { vals[k] = v; }
    908                                } );
    909                        }
    910                        return vals ;
    911                }
    912        }
    913}