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.hayabusa.resource; 017 018import org.opengion.fukurou.util.StringUtil ; 019import org.opengion.hayabusa.common.HybsSystemException; // 6.4.7.0 (2016/06/03) 020 021import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE; // 6.1.0.0 (2014/12/26) refactoring 022import static org.opengion.fukurou.system.HybsConst.CR ; // 6.1.0.0 (2014/12/26) 023 024import java.text.MessageFormat; 025import java.util.Arrays; // 6.4.7.0 (2016/06/03) 026 027/** 028 * systemId , lang に対応したラベルデータを作成します。 029 * 030 * ラベルデータは、項目(CLM)に対して、各種ラベル情報を持っています。 031 * 従来のラベルは、表示名称として、一種類しか持っていませんでしたが、 032 * ラベルデータは、3種類の名称と、1種類の概要を持っています。 033 * 034 * label : 名称(長) 従来のラベルと同じで定義された文字そのものです。 035 * shortLabel : 名称(HTML短) 概要説明をバルーン表示する短い名称です。 036 * longLabel : 名称(HTML長) 概要説明をバルーン表示する長い名称です。 037 * description : 概要説明 カラムの説明やバルーンに使用します。 038 * 039 * 名称(HTML長)は、従来の表示名称にあたります。これは、一般的なラベルとして 040 * 使用されます。名称(HTML短)は、テーブル一覧のヘッダーの様に、特殊なケースで、 041 * 簡略化された名称を使用するときに利用されます。この切り替えは、自動で判断されます。 042 * 名称(HTML短)に、なにも設定されていない場合は、名称(HTML長)が自動的に使用されますので 043 * 初期データ移行時には、そのまま、通常時もテーブルヘッダー時も同じ文字列が 044 * 使用されます。 045 * ただし、一覧表示のうち、EXCEL出力などのデータには、名称(長)が使用されます。 046 * これは、名称(HTML短)や名称(HTML長)は、Tips表示を行う為のHTML構文を採用している為 047 * テキスト等に出力するには不適切だからです。また、EXCEL等のツールでは、ラベル名が 048 * 長くてもセル幅等で調整できる為、簡略化された名称よりも正式名称で出力します。 049 * 050 * ラベルデータを作成する場合は、同一ラベルで、作成区分(KBSAKU)違いの場合は、 051 * 最も大きな作成区分を持つコードを使用します。 052 * 作成区分(KBSAKU)は、0:システム予約、1:アプリ設定、2:ユーザー設定 という具合に 053 * カスタマイズの度合いに応じて大きな数字を割り当てることで、キー情報を上書き修正 054 * することが可能になります。(削除することは出来ません。) 055 * 056 * @og.rev 4.0.0.0 (2004/12/31) 新規作成 057 * @og.group リソース管理 058 * 059 * @version 4.0 060 * @author Kazuhiko Hasegawa 061 * @since JDK5.0, 062 */ 063public final class LabelData implements LabelInterface { 064 065 /** 内部データのカラム番号 {@value} */ 066 public static final int CLM = 0 ; 067 /** 内部データのカラム番号 {@value} */ 068 public static final int SNAME = 1 ; 069 /** 内部データのカラム番号 {@value} */ 070 public static final int LNAME = 2 ; 071 /** 内部データのカラム番号 {@value} */ 072 public static final int DESCRIPTION = 3 ; 073 /** 内部データのカラム数 {@value} */ 074 public static final int DATA_SIZE = 4 ; 075 076 /** リソース読み込みのために一時利用 4.3.5.7 (2009/03/22) */ 077 /* default */ static final int FG_LOAD = 4 ; 078 /** FGLOAD の読み込み済み設定用のUNIQ 6.3.1.1 (2015/07/10) */ 079 /* default */ static final int UNIQ = 5 ; 080 /** FGLOAD の読み込み済み設定用のSYSTEM_ID 6.3.1.1 (2015/07/10) */ 081 /* default */ static final int SYSTEM_ID = 6 ; 082 083 private final String key ; // 項目 084 private final String label ; // 名称(長) 085 private final String shortLabel ; // 名称(HTML短) 086 private final String longLabel ; // 名称(HTML長) 087 private final String description ; // 概要説明 088 private final boolean official ; // リソースDBから作成されたかどうか 089// private final boolean isFormat ; // メッセージフォーマット対象かどうか 4.0.0.0 (2007/10/17) 7.1.0.1 (2020/02/07) 長,短,概要などあるため、直前にチェック 090 private final String rawShortLabel; // 名称(未変換短) 4.3.8.0 (2009/08/01) 091// private final boolean isFormatDesc; // 概要がフォーマット対象か 4.3.7.6 (2009/07/15) 7.1.0.1 (2020/02/07) 未使用 092 private final String rawLongLabel; // 名称(未変換長) 5.6.8.2 (2013/09/20) 093 094 /** 095 * null LabelData オブジェクトを作成します。 096 * このオブジェクトは、DBリソース上に存在しない場合に使用される 097 * null 情報を表す、LabelData オブジェクトです。 098 * 099 * @og.rev 5.6.8.2 (2013/09/20) rawLongLabel対応 100 * @og.rev 5.7.3.0 (2014/02/07) public に格上げします。 101 * @og.rev 7.0.1.5 (2018/12/10) 名前とラベルだけ異なるLabelDataオブジェクトを作成します。 102 * 103 * @param inkey キー情報 104 */ 105 public LabelData( final String inkey ) { 106 this( inkey,inkey ); 107// key = inkey.intern() ; 108// label = key ; // 名称(長) 109// shortLabel = key ; // 名称(HTML短) 110// longLabel = key ; // 名称(HTML長) 111// description = "" ; // 概要説明 112// official = false; // 非正式 113// isFormat = false; // 非フォーマット 4.0.0.0 (2007/10/17) 114// rawShortLabel = key; // 名称(未変換短) 4.3.8.0 (2009/08/01) 115// isFormatDesc = false; // 概要フォーマット 4.3.7.6 (2009/07/15) 116// rawLongLabel = key; // 名称(未変換長)5.6.8.2 (2013/09/20) 117 } 118 119 /** 120 * 名前とラベルだけ異なるLabelDataオブジェクトを作成します。 121 * 122 * これは、ラベルを簡易的に利用する場合に使用する、LabelData オブジェクトです。 123 * 124 * @og.rev 7.0.1.5 (2018/12/10) 名前とラベルだけ異なるLabelDataオブジェクトを作成します。 125 * @og.rev 7.1.0.1 (2020/02/07) isFormat、isFormatDescは、長,短,概要などあるため、直前にチェックするので廃止。 126 * 127 * @param inkey キー情報 128 * @param inLbl ラベル 129 */ 130 public LabelData( final String inkey,final String inLbl ) { 131 key = inkey.intern() ; 132 label = inLbl ; // 名称(長) 133 shortLabel = inLbl ; // 名称(HTML短) 134 longLabel = inLbl ; // 名称(HTML長) 135 description = "" ; // 概要説明 136 official = false; // 非正式 137// isFormat = false; // 非フォーマット 4.0.0.0 (2007/10/17) 7.1.0.1 (2020/02/07) 廃止 138 rawShortLabel = inLbl; // 名称(未変換短) 4.3.8.0 (2009/08/01) 139// isFormatDesc = false; // 概要フォーマット 4.3.7.6 (2009/07/15) 7.1.0.1 (2020/02/07) 廃止 140 rawLongLabel = inLbl; // 名称(未変換長)5.6.8.2 (2013/09/20) 141 } 142 143 /** 144 * 配列文字列のデータを元に、LabelDataオブジェクトを構築します。 145 * このコンストラクタは、他のパッケージから呼び出せないように、 146 * パッケージプライベートにしておきます。 147 * このコンストラクタは、DBリソースファイルを想定しています。 148 * 149 * @og.rev 5.4.0.1 (2011/11/01) SNAME、概要説明、rawShortLabel 関係の処理を修正 150 * @og.rev 5.6.8.2 (2013/09/20) rawLongLabel対応 151 * @og.rev 6.2.2.0 (2015/03/27) BRと\nを相互に変換する処理を追加 152 * @og.rev 6.2.2.3 (2015/04/10) htmlフィルターに、BR→改行処理機能を追加。 153 * @og.rev 6.3.9.0 (2015/11/06) StringUtil.yenN2br は、null を返しません。 154 * @og.rev 7.1.0.1 (2020/02/07) isFormat、isFormatDescは、長,短,概要などあるため、直前にチェックするので廃止。 155 * 156 * @param data CLM,SNAME,LNAME,DESCRIPTION 157 */ 158 LabelData( final String[] data ) { 159 key = data[CLM].intern() ; // 項目 160 label = StringUtil.yenN2br( data[LNAME] ) ; // 6.2.2.3 (2015/04/10) 名称(HTML長) 161 description = StringUtil.yenN2br( data[DESCRIPTION] ) ; // 6.2.2.3 (2015/04/10) 概要説明 162 official = true; // 正式 163// isFormat = label.indexOf( '{' ) >= 0 ; // 4.0.0.0 (2007/10/17) 164 String title = null; 165 166 rawLongLabel = label; // 名称(未変換長)5.6.8.2 (2013/09/20) 167 if( description.isEmpty() ) { // 6.3.9.0 (2015/11/06) StringUtil.yenN2br は、null を返しません。 168// isFormatDesc = false; 169 // 5.4.0.1 (2011/11/01) title と label が間違っている。(SNAME が存在する場合) 170 title = StringUtil.htmlFilter( label,true ) ; // 6.2.2.0 (2015/03/27) 171 172 // 概要説明がない場合は、そのままラベルを使用する。 173 longLabel = label; 174 } 175 else { 176// isFormatDesc = description.indexOf( '{' ) >= 0 ; // 5.1.8.0 (2010/07/01) nullポインタの参照外し対策 177 title = StringUtil.htmlFilter( description,true ) ; // 6.2.2.0 (2015/03/27) 178 179 // 概要説明がある場合は、ツールチップにDESCRIPTIONを表示する。 180 longLabel = "<span title=\"" 181 + title 182 + "\">" 183 + label 184 + "</span>" ; 185 } 186 187 final String sname = data[SNAME]; // 名称(HTML短) 188 if( sname == null || sname.isEmpty() ) { 189 // SNAME がない場合は、longLabel を使用する。 190 shortLabel = longLabel; 191 rawShortLabel = label; // 5.4.0.1 (2011/11/01) longLabel を使うと、ツールチップが加味されるため。 192 } 193 else { 194 // SNAME が存在する場合、ツールチップにdescriptionかlabelを使用する。 195 shortLabel = "<span title=\"" 196 + title 197 + "\">" 198 + sname 199 + "</span>" ; 200 rawShortLabel = sname; // 4.3.8.0 (2009/08/01) 201 } 202 } 203 204 /** 205 * ラベルオブジェクトのキーを返します。 206 * 207 * @return ラベルオブジェクトのキー 208 */ 209 public String getKey() { return key; } 210 211 /** 212 * ラベルオブジェクトの名称を返します。 213 * これは、DB上の LNAME(名称(長))に該当します。 214 * 215 * @return ラベルオブジェクトの名称(短) 216 */ 217 public String getLabel() { return label; } 218 219 /** 220 * ラベルオブジェクトの名称(短)を返します。 221 * 概要説明がない場合でかつDB上のSNAMEが未設定の場合は、 222 * LNAME が返されます。SNAMEが設定されている場合は、 223 * ツールチップにLNAME が表示されます。 224 * 概要説明が存在する場合は、ツールチップに概要説明が 225 * 表示されます。 226 * 227 * @return ラベルオブジェクトの名称(短) 228 */ 229 public String getShortLabel() { return shortLabel; } 230 231 /** 232 * ラベルオブジェクトの名称(長)を返します。 233 * 概要説明が存在する場合は、ツールチップに概要説明が 234 * 表示されます。 235 * 236 * @return ラベルオブジェクトの名称(長) 237 * @see #getLongLabel( String ) 238 */ 239 public String getLongLabel() { return longLabel; } 240 241 /** 242 * ラベルインターフェースの名称(長)を返します。 243 * ツールチップに表示するタイトル属性(概要説明)を置き換えます。 244 * null の場合は、既存のgetLongLabel()を返します。 245 * 246 * @og.rev 6.2.2.0 (2015/03/27) BRと\nを相互に変換する処理を追加 247 * @og.rev 6.2.2.3 (2015/04/10) htmlフィルターに、BR→改行処理機能を追加。 248 * 249 * @param title ツールチップに表示するタイトル属性 250 * 251 * @return ラベルインターフェースの名称(長) 252 * @see #getLongLabel() 253 */ 254 public String getLongLabel( final String title ) { 255 final String tipsLabel ; 256 if( title == null ) { 257 tipsLabel = longLabel; 258 } 259 else { 260 tipsLabel = "<span title=\"" 261 + StringUtil.htmlFilter( title,true ) // 6.2.2.3 (2015/04/10) 262 + "\">" 263 + label 264 + "</span>" ; 265 } 266 return tipsLabel ; 267 } 268 269 /** 270 * ラベルインターフェースの引数付きメッセージを返します。 271 * メッセージの引数部分に、文字列配列を適用して、MessageFormat 272 * で変換した結果を返します。(MessageData でのみ有効です。) 273 * 274 * @og.rev 4.0.0.0 (2007/10/17) メッセージリソース統合に伴い、MessageDataより移行 275 * @og.rev 4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理 276 * @og.rev 5.0.0.2 (2009/09/15) サニタイジング処理をやめる 277 * @og.rev 6.4.3.4 (2016/03/11) ラベル {n} が存在しない場合は、引数を連結せず、元のラベルを返す。 278 * @og.rev 6.4.5.0 (2016/04/08) リソースから作成された場合は、引数を連結せず、そうでない場合は連結します。 279 * @og.rev 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。 280 * @og.rev 7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。 281 * @og.rev 7.1.0.1 (2020/02/07) isFormat、isFormatDescは、長,短,概要などあるため、直前にチェックするので廃止。 282 * 283 * @param lbl メッセージを作成する元となるラベル文字列 284 * @param vals メッセージ引数の文字列配列(可変長引数) 285 * 286 * @return ラベルインターフェースの引数付きメッセージ 287 */ 288// public String getMessage( final String... vals ) { // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。 289 private String getMessage( final String lbl , final String[] vals ) { 290 final String rtn ; 291 292 final String[] args = ( vals == null ) ? new String[0] : vals ; 293 final boolean isFormat = lbl != null && lbl.indexOf( '{' ) >= 0 ; // 7.1.0.1 (2020/02/07) 294 if( isFormat ) { 295 // 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。 296 try { 297// rtn = MessageFormat.format( label,(Object[])args ); 298 rtn = MessageFormat.format( lbl,(Object[])args ); 299 } 300 catch( final IllegalArgumentException ex ) { 301 final String errMsg = "MessageFormatエラー:" 302 + " Key [" + key + "]" 303// + " Pattern [" + label + "]" 304 + " Pattern [" + lbl + "]" 305 + " Arguments [" + Arrays.toString( (Object[])args ) + "]" ; 306 throw new HybsSystemException( errMsg,ex ); 307 } 308 } 309 else { 310 // 6.4.5.0 (2016/04/08) リソースから作成された場合は、引数を連結せず、そうでない場合は連結します。 311 if( official ) { 312// rtn = label ; // 6.4.3.4 (2016/03/11) 313 rtn = lbl ; // 6.4.3.4 (2016/03/11) 314 } 315 else { 316 final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE ) 317// .append( label ); 318 .append( lbl ); 319 for( final String val : args ) { 320// if( val != null && ! val.equals( label ) ) { 321 if( val != null && ! val.equals( lbl ) ) { 322 buf.append( ' ' ).append( val ); // 6.0.2.5 (2014/10/31) char を append する。 323 } 324 } 325 rtn = buf.toString(); 326 } 327 } 328 return rtn ; 329 } 330 331 /** 332 * ラベルインターフェースの引数付きメッセージを返します。 333 * メッセージの引数部分に、文字列配列を適用して、MessageFormat 334 * で変換した結果を返します。(MessageData でのみ有効です。) 335 * 336 * @og.rev 4.0.0.0 (2007/10/17) メッセージリソース統合に伴い、MessageDataより移行 337 * @og.rev 4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理 338 * @og.rev 5.0.0.2 (2009/09/15) サニタイジング処理をやめる 339 * @og.rev 6.4.3.4 (2016/03/11) ラベル {n} が存在しない場合は、引数を連結せず、元のラベルを返す。 340 * @og.rev 6.4.5.0 (2016/04/08) リソースから作成された場合は、引数を連結せず、そうでない場合は連結します。 341 * @og.rev 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。 342 * @og.rev 7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。 343 * 344 * @param vals メッセージ引数の文字列配列(可変長引数) 345 * 346 * @return ラベルインターフェースの引数付きメッセージ 347 */ 348 public String getMessage( final String... vals ) { // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。 349 return getMessage( label,vals ); 350 351// final String rtn ; 352// 353// final String[] args = ( vals == null ) ? new String[0] : vals ; 354// if( isFormat ) { 355// // 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。 356// try { 357// rtn = MessageFormat.format( label,(Object[])args ); 358// } 359// catch( final IllegalArgumentException ex ) { 360// final String errMsg = "MessageFormatエラー:" 361// + " Key [" + key + "]" 362// + " Pattern [" + label + "]" 363// + " Arguments [" + Arrays.toString( (Object[])args ) + "]" ; 364// throw new HybsSystemException( errMsg,ex ); 365// } 366// } 367// else { 368// // 6.4.5.0 (2016/04/08) リソースから作成された場合は、引数を連結せず、そうでない場合は連結します。 369// if( official ) { 370// rtn = label ; // 6.4.3.4 (2016/03/11) 371// } 372// else { 373// final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE ) 374// .append( label ); 375// for( final String val : args ) { 376// if( val != null && ! val.equals( label ) ) { 377// buf.append( ' ' ).append( val ); // 6.0.2.5 (2014/10/31) char を append する。 378// } 379// } 380// rtn = buf.toString(); 381// } 382// } 383// return rtn ; 384 } 385 386 /** 387 * ラベルオブジェクトの概要説明を返します。 388 * 概要説明が存在する場合は、ラベルのツールチップに 389 * 概要説明が表示されます。 390 * 391 * @return ラベルオブジェクトの概要説明 392 */ 393 public String getDescription() { return description; } 394 395 /** 396 * ラベルオブジェクトの概要説明を返します。 397 * このメソッドでは{0},{1}...をパラメータで置換します。 398 * 399 * @og.rev 4.3.7.6 (2009/07/15) 新規作成 400 * @og.rev 4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理 401 * @og.rev 5.0.0.2 (2009/09/15) サニタイジング処理をやめる 402 * @og.rev 5.4.0.1 (2011/11/01) {}が存在しない場合は単に概要を出力 403 * @og.rev 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。 404 * @og.rev 7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。 405 * 406 * @param vals メッセージ引数の文字列配列(可変長引数) 407 * 408 * @return ラベルオブジェクトの概要説明 409 */ 410 public String getDescription( final String... vals ) { // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。 411 return getMessage( description,vals ); 412 413// final String rtn ; 414// 415// // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。 416// final String[] args = ( vals == null ) ? new String[0] : vals ; 417// if( isFormatDesc ) { 418// // 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。 419// try { 420// rtn = MessageFormat.format( description,(Object[])args ); 421// } 422// catch( final IllegalArgumentException ex ) { 423// final String errMsg = "MessageFormatエラー:" 424// + " Key [" + key + "]" 425// + " Pattern [" + description + "]" 426// + " Arguments [" + Arrays.toString( (Object[])args ) + "]" ; 427// throw new HybsSystemException( errMsg,ex ); 428// } 429// } 430// else { 431// // 5.4.0.1 (2011/11/01) {}が存在しない場合は単に概要を出力 ・・・ なら、直接セットに変更 432// rtn = description; 433// } 434// return rtn ; 435 } 436 437 /** 438 * ラベルオブジェクトの名称(未変換短)を返します。 439 * このメソッドでは{0},{1}...をパラメータで置換します。 440 * 441 * @og.rev 7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。 442 * 443 * @param vals メッセージ引数の文字列配列(可変長引数) 444 * 445 * @return ラベルインターフェースの名前(短) 446 */ 447 public String getShortMessage( final String... vals ) { 448 return getMessage( rawShortLabel,vals ); 449 } 450 451 /** 452 * リソースDBから作成されたかどうかを返します。 453 * 正式な場合は、true / リソースになく、独自に作成された場合は、false になります。 454 * 455 * @return リソースDBから作成されたかどうか 456 */ 457 public boolean isOfficial() { return official; } 458 459 /** 460 * ラベルオブジェクトの名称(長)をそのままの形で返します。 461 * (discription等を付けない) 462 * 463 * @og.rev 5.6.8.2 (2009/08/01) 追加 464 * 465 * @return ラベルオブジェクトの名称(長)そのままの状態 466 */ 467 public String getRawLongLabel() { return rawLongLabel; } 468 469 /** 470 * ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。 471 * SNAMEが未設定の場合は、LNAME が返されます。 472 * 473 * @og.rev 4.3.8.0 (2009/08/01) 追加 474 * 475 * @return ラベルオブジェクトの名称(短)にspanタグを付けない状態 476 */ 477 public String getRawShortLabel() { return rawShortLabel; } 478 479 /** 480 * オブジェクトの識別子として,詳細なユーザー情報を返します。 481 * 482 * @return 詳細なユーザー情報 483 * @og.rtnNotNull 484 */ 485 @Override 486 public String toString() { 487 final StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE ) 488 .append( "CLM :" ).append( key ) 489 .append( " SNAME :" ).append( shortLabel ) 490 .append( " LNAME :" ).append( longLabel ) 491 .append( " DESCRIPTION :" ).append( description ).append( CR ); 492 return rtn.toString(); 493 } 494}