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 java.util.Locale; // 6.2.0.0 (2015/02/27) 019import java.util.Date; // 6.2.0.0 (2015/02/27) 020import java.util.concurrent.ConcurrentMap; // 6.4.3.4 (2016/03/11) 021import java.util.concurrent.ConcurrentHashMap; // 6.4.3.1 (2016/02/12) refactoring 022import java.text.DateFormat; // 6.2.0.0 (2015/02/27) 023import java.text.SimpleDateFormat; // 6.2.0.0 (2015/02/27) 024 025import org.apache.poi.ss.usermodel.BuiltinFormats; // 6.2.0.0 (2015/02/27) 026import org.apache.poi.ss.usermodel.DateUtil; // 6.2.0.0 (2015/02/27) 027import org.apache.poi.ss.util.NumberToTextConverter; // 6.2.0.0 (2015/02/27) 028import org.apache.poi.hssf.record.ExtendedFormatRecord; // 6.2.0.0 (2015/02/27) 029import org.apache.poi.hssf.record.FormatRecord; // 6.2.0.0 (2015/02/27) 030import org.apache.poi.hssf.record.NumberRecord; // 6.2.0.0 (2015/02/27) 031import org.apache.poi.xssf.model.StylesTable; // 6.2.0.0 (2015/02/27) 032import org.apache.poi.xssf.usermodel.XSSFCellStyle; // 6.2.0.0 (2015/02/27) 033 034/** 035 * POI による、Excel(xlsx)の読み取りクラスです。 036 * 037 * xlsx形式のEXCELを、イベント方式でテキストデータを読み取ります。 038 * このクラスでは、XSSF(.xlsx)形式のファイルを、TableModelHelper を介したイベントで読み取ります。 039 * TableModelHelperイベントは、openGion形式のファイル読み取りに準拠した方法をサポートします。 040 * ※ openGion形式のEXCELファイルとは、#NAME 列に、カラム名があり、#で始まる 041 * レコードは、コメントとして判断し、読み飛ばす処理の事です。 042 * 043 * @og.rev 6.0.3.0 (2014/11/13) 新規作成 044 * @og.rev 6.2.0.0 (2015/02/27) パッケージ変更(util → model),クラス名変更(ExcelReader_XSSF → EventReader_XLSX) 045 * @og.group ファイル入力 046 * 047 * @version 6.0 048 * @author Kazuhiko Hasegawa 049 * @since JDK7.0, 050 */ 051public final class ExcelStyleFormat { 052 /** このプログラムのVERSION文字列を設定します。 {@value} */ 053 private static final String VERSION = "6.4.3.3 (2016/03/04)" ; 054 055 /** 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) */ 056 private static final String[] DATE_TYPE = { "yyyyMMdd" , "yyyyMMddHHmmss" , "HHmmss" }; 057 /** 6.3.1.0 (2015/06/28) 外部からも使えるように、static化します。 */ 058 private static final DateFormat[] DT_FORMAT = new DateFormat[DATE_TYPE.length]; // 6.4.1.1 (2016/01/16) dtFormat → DT_FORMAT refactoring 059 private final StylesTable stylesTable ; 060 061 // 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 062 // private final List<Integer> extFmtIdx = new ArrayList<>(); // ExtendedFormatRecord のｱﾄﾞﾚｽ(順番) の順番に、FormatIndexを設定する。 063 /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 */ 064 private final ConcurrentMap<Integer,String> fmtStrMap = new ConcurrentHashMap<>(); // FormatIndex をキーに、Format文字列 を管理 065 /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 */ 066 private final ConcurrentMap<Integer,Integer> extFmtIdxMap = new ConcurrentHashMap<>(); // ExtendedFormatRecord のｱﾄﾞﾚｽ(順番) をキーに、FormatIndexを設定する。 067 private int extFmtCnt ; 068 069 /** 070 * XSL系 コンストラクター 071 * 072 * XSL 処理では、HSSFListener のイベント処理のうち、NumberRecord の値取得に 073 * 必要な内部処理を、実行します。 074 * 具体的には、ExtendedFormatRecord レコードから、FormatIndex と 並び順を 075 * 管理するMapと、FormatRecord レコードから、IndexCode と フォーマット文字列を 076 * 管理するMap を作成し、NumberRecordレコードの XFIndex から、ExtendedFormatRecord を 077 * 経由して、FormatRecord のフォーマット文字列 を取得し、日付フォーマットの場合は、 078 * 日付文字列に、それ以外は、数字文字列に変換する手助けを行います。 079 * 080 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 081 */ 082 public ExcelStyleFormat() { 083 stylesTable = null; 084 } 085 086 /** 087 * XSLX系 コンストラクター 088 * 089 * StylesTable は、日付型をはじめとする、EXCELのスタイルのフォーマットを管理しています。 090 * XSLX形式のEXCELをパースする場合に、このコンストラクタを使用して、StylesTableオブジェクトを 091 * 設定します。 092 * 093 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 094 * 095 * @param styles StylesTableオブジェクト 096 */ 097 public ExcelStyleFormat( final StylesTable styles ) { 098 stylesTable = styles; 099 } 100 101 /** 102 * XSL系 ExtendedFormatRecordレコードの設定。 103 * 104 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 105 * 106 * @param extFmtRec ExtendedFormatRecordレコード 107 */ 108 public void addExtFmtRec( final ExtendedFormatRecord extFmtRec ) { 109 final short fmtIdx = extFmtRec.getFormatIndex(); 110 final short xfType = extFmtRec.getXFType(); 111 // Listに ｱﾄﾞﾚｽ(順番) の順番に、FormatIndexを設定する。 112 // extFmtIdx.add( Integer.valueOf( fmtIdx ) ); 113 114 // タイプを判別して、ｱﾄﾞﾚｽ(順番)をキーに、Mapに登録することで、データ件数を削減します。 115 if( xfType == ExtendedFormatRecord.XF_CELL ) { 116 // ｱﾄﾞﾚｽ(順番) FormatIndex 117 // 2.0.0 (2024/01/12) PMD 7.0.0 UnnecessaryBoxing 118// extFmtIdxMap.put( Integer.valueOf( extFmtCnt ),Integer.valueOf( fmtIdx ) ); 119 extFmtIdxMap.put( extFmtCnt , (int)fmtIdx ); 120 // System.out.println( "fmtIdx=[" + fmtIdx + "] , xfType=[" + xfType + "] , CNT=" + extFmtCnt ); 121 } 122 extFmtCnt++; 123 } 124 125 /** 126 * XSL系 FormatRecordレコードの設定。 127 * 128 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 129 * 130 * @param fmtRec FormatRecordレコード 131 */ 132 public void addFmtRec( final FormatRecord fmtRec ) { 133 final int idxc = fmtRec.getIndexCode(); 134 final String fmt = fmtRec.getFormatString(); 135 136 // IndexCode をキーに、Format文字列を登録する。 137 // 2.0.0 (2024/01/12) PMD 7.0.0 UnnecessaryBoxing 138// fmtStrMap.put( Integer.valueOf( idxc ) , fmt ); 139 fmtStrMap.put( idxc , fmt ); 140 // System.out.println( "fmtRec=[" + idxc + "], fmt=[" + fmt + "]" ); 141 } 142 143 /** 144 * XSLX系 セルスタイル文字列(スタイル番号)から、データフォーマットを取得します。 145 * 146 * StylesTable は、日付型をはじめとする、EXCELのスタイルのフォーマットを管理しています。 147 * XSLX形式のEXCELのフォーマット文字列を取得する場合に、使用します。 148 * 149 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 150 * 151 * @param cellStyleStr セルスタイル文字列(スタイル番号) 152 * @param val endElement時の値文字列 153 * @return 日付データか、数値データかを判別した結果の文字列 154 */ 155 public String getNumberValue( final String cellStyleStr , final String val ) { 156 String fmtStr = null; 157 158 if( stylesTable != null && cellStyleStr != null && !cellStyleStr.isEmpty() ) { 159 final int stIdx = Integer.parseInt( cellStyleStr ); 160 final XSSFCellStyle style = stylesTable.getStyleAt( stIdx ); 161 fmtStr = style.getDataFormatString(); 162 163 // 必要かどうか不明。テスト時は、ユーザー定義フォーマットも、上記処理で取得できていた。 164 if( fmtStr == null ) { 165 final int fmtIdx = style.getDataFormat(); 166 fmtStr = BuiltinFormats.getBuiltinFormat( fmtIdx ); 167 } 168 169 // if( fmtStr != null ) { 170 // System.out.println( "style=[" + cellStyleStr + "], stIdx=[" + stIdx + "], fmtStr=[" + fmtStr + "]" ); 171 // } 172 } 173 174 return getNumberValue( fmtStr , Double.parseDouble( val ) ) ; 175 } 176 177 /** 178 * XSL系 Numberレコードから、日付データか、数値データかを判別して返します。 179 * 180 * 日付フォーマットの判定処理を #isDateFormat(String) で行い、日付の場合は、 181 * 各タイプ(日付、日時、時刻)に応じた、文字列を返します。 182 * 日付フォーマットでない場合は、数字化文字列を返します。 183 * 184 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 185 * 186 * @param numrec NumberRecordレコード 187 * @return 日付データか、数値データかを判別した結果の文字列 188 */ 189 public String getNumberValue( final NumberRecord numrec ) { 190 final int xfIdx = numrec.getXFIndex(); // extFmtCnt の事 191 // 2.0.0 (2024/01/12) PMD 7.0.0 UnnecessaryBoxing 192// final int fmtIdx = extFmtIdxMap.get( Integer.valueOf( xfIdx ) ); 193 final int fmtIdx = extFmtIdxMap.get( xfIdx ); 194 195 // final String fmtStr = fmtIdx < HSSFDataFormat.getNumberOfBuiltinBuiltinFormats() 196 // ? HSSFDataFormat.getBuiltinFormat( (short)fmtIdx ) 197 // : fmtStrMap.get( Integer.valueOf( fmtIdx ) ); 198 199 final String fmtStr = fmtIdx < BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX 200 ? BuiltinFormats.getBuiltinFormat( fmtIdx ) 201 // 2.0.0 (2024/01/12) PMD 7.0.0 UnnecessaryBoxing 202// : fmtStrMap.get( Integer.valueOf( fmtIdx ) ); 203 : fmtStrMap.get( fmtIdx ); 204 205 // if( fmtStr != null ) { 206 // System.out.println( "xfIdx=[" + xfIdx + "], fmtIdx=[" + fmtIdx + "], fmtStr=[" + fmtStr + "]" ); 207 // } 208 209 return getNumberValue( fmtStr , numrec.getValue() ) ; 210 } 211 212 /** 213 * フォーマット情報と値から、日付データか、数値データかを判別して返します。 214 * 215 * 日付フォーマットの判定処理を #isDateFormat(String) で行い、日付の場合は、 216 * 各タイプ(日付、日時、時刻)に応じた、文字列を返します。 217 * 日付フォーマットでない場合は、数字文字列を返します。 218 * 219 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 220 * @og.rev 6.3.1.0 (2015/06/28) 外部からも使えるように、static化します。 221 * 222 * @param fmtStr フォーマット情報 223 * @param val Numberレコードのデータ 224 * @return 日付データか、数値データかを判別した結果の文字列 225 */ 226 public static String getNumberValue( final String fmtStr , final double val ) { 227 return isDateFormat( fmtStr ) 228 ? dateFormat( val ) // 日付 229 : NumberToTextConverter.toText( val ) ; // 数字 230 } 231 232 /** 233 * フォーマット文字列から、日付型フォーマットかどうかの判定を行います。 234 * 235 * ここでは、日本式のフォーマットや、ユーザー定義の日付フォーマットでも、 236 * ある程度判定できるように、処理しています。 237 * 以下の文字列を含む場合は、true を返し、それ以外は、false です。 238 * "年","月","日","yy","y/m","m/d","h:m" 239 * ただし、General(標準) は、除外しています。 240 * 241 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 242 * @og.rev 6.3.1.0 (2015/06/28) 外部からも使えるように、static化します。 243 * @og.rev 6.4.3.3 (2016/03/04) PMD refactoring. These nested if statements could be combined 244 * 245 * @param fmt フォーマット文字列 246 * @return 判定結果 [true:日付型/false:それ以外] 247 */ 248 private static boolean isDateFormat( final String fmt ) { 249 return fmt != null && !fmt.isEmpty() && !"General".equalsIgnoreCase( fmt ) && 250 ( fmt.contains( "年" ) || fmt.contains( "月" ) || fmt.contains( "日" ) || 251 fmt.contains( "yy" ) || fmt.contains( "y/m" ) || fmt.contains( "m/d" ) || 252 fmt.contains( "h:m" ) ) ; 253 } 254 255 /** 256 * 日付型の値を、最適なフォーマットで変換して返します。 257 * 258 * 日付データは、(DATE=0,DATETIME=1,TIME=2) に分類できます。 259 * DATE とは、日付のみの状態で、引数の val は、整数に変換できます。 260 * その場合、"yyyyMMdd" フォーマットで変換します。 261 * DATETIME とは、日付＋時刻なので、"yyyyMMddHHmmss" に変換します。 262 * TIME は、日付情報を持っていないため、"HHmmss" に変換します。 263 * 264 * @og.rev 6.2.0.0 (2015/02/27) 日付型の処理(DATE=0,DATETIME=1,TIME=2) 265 * @og.rev 6.3.1.0 (2015/06/28) 外部からも使えるように、static化します。 266 * 267 * @param val 日付型の値 268 * @return 日付型の変換結果 269 */ 270 public static String dateFormat( final double val ) { 271 int dtType = 0; // 日付型の処理(DATE=0,DATETIME=1,TIME=2) 272 if( val < 1.0d ) { // 日付部が無い → TIME=2 273 dtType = 2; 274 } 275 // 6.3.9.0 (2015/11/06) Avoid if (x != y) ..; else ..; (PMD) 276 else if( Double.compare( val , Math.floor( val ) ) == 0 ) { // 整数(Long 相当) → DATE=0 277 dtType = 0; 278 } 279 else { // 整数でない → DATETIME=1 280 dtType = 1; 281 } 282 283 DateFormat dtfmt = DT_FORMAT[dtType]; // 各タイプ別にキャッシュしている。 284 if( dtfmt == null ) { 285 dtfmt = new SimpleDateFormat( DATE_TYPE[dtType] , Locale.JAPAN ); // 初めての場合は新規作成 286 DT_FORMAT[dtType] = dtfmt; 287 } 288 289 final Date dt = DateUtil.getJavaDate( val ); 290 return dtfmt.format( dt ); 291 } 292}