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