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.db; 017 018import org.opengion.fukurou.system.HybsConst ; // 6.1.0.0 (2014/12/26) 019import org.opengion.fukurou.util.ErrorMessage; 020import org.opengion.fukurou.db.Transaction; 021import org.opengion.hayabusa.common.HybsSystemException; 022import org.opengion.hayabusa.resource.ResourceManager; 023 024import java.util.Locale; 025import java.util.Map; 026import java.util.LinkedHashMap ; 027import java.util.concurrent.ConcurrentMap; // 6.4.3.3 (2016/03/04) 028import java.util.concurrent.ConcurrentHashMap; // 6.4.3.1 (2016/02/12) refactoring 029import java.util.Collections; // 6.4.3.1 (2016/02/12) refactoring 030 031/** 032 * AbstractTableFilter は、TableUpda インターフェースを継承した、DBTableModel 処理用の 033 * Abstract実装クラスです。 034 * 035 * @og.rev 5.5.2.6 (2012/05/25) protected変数をprivateに変更。インターフェースにメソッド追加 036 * @og.rev 6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更。 037 * 038 * @version 0.9.0 2000/10/17 039 * @author Kazuhiko Hasegawa 040 * @since JDK1.1, 041 */ 042public abstract class AbstractTableFilter implements TableFilter { 043 /** システムの改行コードを設定します。*/ 044 protected static final String CR = HybsConst.CR; // 6.1.0.0 (2014/12/26) refactoring 045 /** StringBilderなどの初期値を設定します。 {@value} */ 046 protected static final int BUFFER_MIDDLE = HybsConst.BUFFER_MIDDLE; // 6.1.0.0 (2014/12/26) refactoring 047 048 // 5.5.2.6 (2012/05/25) protected変数をprivateに変更。インターフェースにメソッド追加 049 private DBTableModel table ; 050 private String modifyType ; 051 private int[] rowNo ; 052 private boolean useDebug ; // 6.0.2.5 (2014/10/31) refactoring メソッドと同じなので名称変更 053 private Transaction tran ; // 5.1.9.0 (2010/08/01) 追加 054 private String sql ; // 4.2.4.0 (2008/06/23) 055 private String dbid ; // 4.2.4.0 (2008/06/23) 056 private ResourceManager resource ; // 4.3.7.4 (2009/07/01) 057 058 private int errCode = ErrorMessage.OK; 059 private ErrorMessage errMessage ; 060 061 /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 */ 062 private final ConcurrentMap<String,String> keyValMap = new ConcurrentHashMap<>(); 063 064 // 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。 065 // 6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更 066 /** 6.4.3.1 (2016/02/12) Collections.synchronizedMap で同期処理を行います。 */ 067 private final Map<String,String> keysMap = Collections.synchronizedMap( new LinkedHashMap<>() ) ; 068 069 // 6.0.2.3 (2014/10/10) plugin.table.TableFilter_XXXX から移動 070 /** 各種定数 */ 071 protected static final String XML_START_TAG = "<?xml version='1.0' encoding='UTF-8'?>" + CR + "<ROWSET tableName='xxx'>"; 072 /** 各種定数 {@value} */ 073 protected static final String XML_END_TAG = "</ROWSET>"; 074 /** 各種定数 {@value} */ 075 protected static final String EXEC_START_TAG= "<EXEC_SQL>"; 076 /** 各種定数 {@value} */ 077 protected static final String EXEC_END_TAG = "</EXEC_SQL>"; 078 079 // 6.0.2.3 (2014/10/10) isXml で、CR + EXEC_END_TAG のキャッシュを作成します。 080 /** XML形式かどうか */ 081 protected boolean isXml ; // 6.0.2.3 (2014/10/10) 082 /** 終了タグ */ 083 protected String execEndTag ; // 6.0.2.3 (2014/10/10) 084 085 /** 086 * デフォルトコンストラクター 087 * 088 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 089 */ 090 protected AbstractTableFilter() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 091 092 /** 093 * keys の整合性チェックを行うための初期設定を行います。 094 * サブクラスのコンストラクタ内で、設定するようにしてください。 095 * 096 * @og.rev 6.4.1.1 (2016/01/16) keys の整合性チェック対応 097 * @og.rev 6.4.3.1 (2016/02/12) ConcurrentMap 系は、key,val ともに not null 制限です。 098 * 099 * @param key 整合性チェックを行うための keysMap に設定するキー 100 * @param cmnt 整合性チェックを行うための キー の説明 101 */ 102 protected void initSet( final String key , final String cmnt ) { 103 if( key != null && cmnt != null ) { 104 keysMap.put( key , cmnt ); 105 } 106 } 107 108 /** 109 * DBTableModel をセットします。 110 * 111 * @param table DBTableModelオブジェクト 112 */ 113 public void setDBTableModel( final DBTableModel table ) { 114 this.table = table; 115 } 116 117 /** 118 * DBTableModel を取得します。 119 * 120 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 121 * 122 * @return 内部のDBTableModel 123 */ 124 public DBTableModel getDBTableModel() { 125 return table; 126 } 127 128 /** 129 * データ処理の方法(A:追加 C:更新 D:削除)を指定します。 130 * 131 * 通常は、DBTableModel に自動設定されている modifyType を元に、データ処理方法を 132 * 選別します。(A:追加 C:更新 D:削除) 133 * この場合、行単位で modifyType の値を取得して判別する必要がありますが、一般には 134 * 処理対象は、全件おなじ modifyType である可能性が高いです。 135 * また、selectedAll などで強制的に全件処理対象とする場合は、modifyType に値が 136 * 設定さていません。その様な場合に外部より modifyType を指定します。 137 * 初期値は、自動判定 です。 138 * 139 * @og.rev 5.5.2.6 (2012/05/25) 廃止 140 * 141 * @param type データ処理の方法(A:追加 C:更新 D:削除) 142 */ 143 public void setModifyType( final String type ) { 144 modifyType = type; 145 } 146 147 /** 148 * データ処理の方法(A:追加 C:更新 D:削除)を取得します。 149 * 150 * 初期値は、自動判定 です。 151 * 152 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 153 * 154 * @return データ処理の方法(A:追加 C:更新 D:削除) 155 */ 156 public String getModifyType() { 157 return modifyType ; 158 } 159 160 /** 161 * キーと値のペアの変数配列を受け取ります。 162 * 163 * ここでは、この方式以外に、パラメーターMapを受け取る方法もあります。 164 * この受け取る時に、キーを大文字化します。TableFilter の keys は、 165 * 大文字のみで定義しておくことで、HTMLやWindows世代の曖昧な表記方法に 166 * 対応しています。(unixやxmlのような厳格な方が好きですけど) 167 * 168 * keys,vals とパラメーターMapを同時に指定した場合は、両方とも有効です。 169 * ただし、キーが重複した場合は、不定と考えてください。 170 * 171 * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。 172 * 173 * @param keys キー配列 174 * @param vals 値配列 175 * @see #setParamMap( ConcurrentMap ) 176 */ 177 public void setKeysVals( final String[] keys,final String[] vals ) { 178 if( keys != null && vals != null ) { 179 for( int i=0; i<keys.length; i++ ) { 180 // 5.6.6.0 (2013/07/05) 共通のセッターメソッド経由で登録します。 181 setKeyVal( keys[i],vals[i] ); 182 } 183 } 184 } 185 186 /** 187 * キーと値のペアを受け取り、内部の keyValMap マップに追加します。 188 * 189 * キーか値のどちらかが null の場合は、何もしません。つまり、val に 190 * null をセットすることはできません。 191 * 192 * このメソッドは、setKeysVals( String[] ,String[] ) メソッドと、 193 * setParamMap( Map<String,String> ) メソッドの両方から、使用します。 194 * 処理を行うに当たり、下記の処理を行います。 195 * 1.キーを大文字化します。 196 * 2.各クラスの keys と整合性チェックを行います。 197 * 198 * ただし、setKeysVals と setParamMap の登録順は、不定と考えてください。 199 * 両方に同じキーを指定すると、どちらの値がセットされたかは、不定です。 200 * 201 * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。 202 * @og.rev 6.4.3.4 (2016/03/12) Map#forEach で対応する。 203 * @og.rev 6.7.9.1 (2017/05/19) keysMap が、空の場合も、keyValMap に登録する。(initSet 未登録時) 204 * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"/>" 止めを、">" に変更します)。 205 * 206 * @param key キー文字列(null の場合は、処理しない) 207 * @param val 値文字列(null の場合は、処理しない) 208 * @see #setKeysVals( String[] ,String[] ) 209 * @see #setParamMap( ConcurrentMap ) 210 */ 211 private void setKeyVal( final String key,final String val ) { 212 // key か val かどちらかが null の場合は、処理を行わない。 213 if( key == null || val == null ) { return; } 214 215 final String upKey = key.toUpperCase(Locale.JAPAN); 216 217 // 6.7.9.1 (2017/05/19) keysMap が、空の場合も、keyValMap に登録する。(initSet 未登録時) 218 if( keysMap.isEmpty() || keysMap.containsKey( upKey ) ) { // keysMap は、各サブクラスで定義 219 keyValMap.put( upKey,val ); 220 } 221 else { 222// final String BR = "<br />" + CR ; 223 final String BR = "<br>" + CR ; // 7.0.1.0 (2018/10/15) 224 final StringBuilder errMsg = new StringBuilder( BUFFER_MIDDLE ); 225 // 6.0.2.5 (2014/10/31) char を append する。 226 errMsg.append( BR ) 227 .append( "指定のキーは、この tableFilter では、使用できません。" ).append( BR ) 228 .append( " class=[" ).append( getClass().getName() ).append( ']' ).append( BR ) 229 .append( " key =[" ).append( key ).append( ']' ).append( BR ) 230 .append( " ======== usage keys ======== " ).append( BR ) ; 231 // 6.4.3.4 (2016/03/12) Map#forEach で対応する。 232 keysMap.forEach( (k,v) -> { errMsg.append( ' ' ).append( k ).append( ':' ).append( v ).append( BR ); } ); 233 errMsg.append( " ============================ " ).append( BR ); 234 235 throw new HybsSystemException( errMsg.toString() ); 236 } 237 } 238 239 /** 240 * 選択された行番号の配列をセットします。 241 * 242 * 表示データの HybsSystem.ROW_SELECTED_KEY を元に、選ばれた 行を 243 * 処理の対象とします。 244 * 245 * @param rowNoTmp 行番号配列(可変長引数) 246 */ 247 public void setParameterRows( final int... rowNoTmp ) { 248 if( rowNoTmp != null && rowNoTmp.length > 0 ) { // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。 249 final int size = rowNoTmp.length ; 250 rowNo = new int[size]; 251 System.arraycopy( rowNoTmp,0,rowNo,0,size ); 252 } 253 } 254 255 /** 256 * 選択された行番号の配列を取得します。 257 * 258 * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を 259 * 処理の対象とします。 260 * 261 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 262 * @og.rev 6.0.2.5 (2014/10/31) null ではなく、サイズ0の配列を返すように変更。 263 * 264 * @return 行番号の配列(選ばれていない場合は、サイズ0の配列を返す) 265 * @og.rtnNotNull 266 */ 267 public int[] getParameterRows() { 268 // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..; 269 return rowNo == null ? new int[0] : rowNo.clone() ; 270 } 271 272 /** 273 * アクセスログ取得の為,Transactionオブジェクトを設定します。 274 * 275 * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応(新規追加) 276 * 277 * @param tran Transactionオブジェクト 278 */ 279 public void setTransaction( final Transaction tran ) { 280 this.tran = tran; 281 } 282 283 /** 284 * アクセスログ取得の為,Transactionオブジェクトを取得します。 285 * 286 * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応(新規追加) 287 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 288 * 289 * @return Transactionオブジェクト 290 */ 291 public Transaction getTransaction() { 292 return tran; 293 } 294 295 /** 296 * DBIDを指定します。 297 * 298 * @og.rev 4.2.4.0 (2008/06/23) 新規追加 299 * 300 * @param dbid 接続先ID 301 */ 302 public void setDbid( final String dbid ) { 303 this.dbid = dbid; 304 } 305 306 /** 307 * DBIDを取得します。 308 * 309 * @og.rev 4.2.4.0 (2008/06/23) 新規追加 310 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 311 * 312 * @return DBID(接続先情報) 313 */ 314 public String getDbid() { 315 return dbid; 316 } 317 318 /** 319 * ボディー部分のSQLを指定します。 320 * 321 * @og.rev 4.2.4.0 (2008/06/23) 新規追加 322 * 323 * @param sql ボディー部分のSQL 324 */ 325 public void setSql( final String sql ) { 326 this.sql = sql; 327 } 328 329 /** 330 * ボディー部分のSQLを取得します。 331 * 332 * @og.rev 4.2.4.0 (2008/06/23) 新規追加 333 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 334 * 335 * @return ボディー部分のSQL 336 */ 337 public String getSql() { 338 return sql; 339 } 340 341 /** 342 * パラメーターMapを指定します。 343 * 344 * keys,vals と パラメーターMapを同時に指定した場合は、両方とも有効です。 345 * ただし、キーが重複した場合は、不定と考えてください。 346 * 347 * この受け取る時に、キーを大文字化します。TableFilter の keys は、 348 * 大文字のみで定義しておくことで、HTMLやWindows世代の曖昧な表記方法に 349 * 対応しています。(unixやxmlのような厳格な方が好きですけど) 350 * 351 * @og.rev 5.6.5.2 (2013/06/21) 新規追加 352 * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。 353 * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap を受け取ることを明確にするため、I/FをConcurrentMapに変更します。 354 * 355 * @param paramMap パラメーターMap 356 * @see #setKeysVals( String[] ,String[] ) 357 */ 358 public void setParamMap( final ConcurrentMap<String,String> paramMap ) { 359 // 6.4.3.3 (2016/03/04) Map#forEach に変更 360 if( paramMap != null ) { 361 paramMap.forEach( (k,v) -> setKeyVal( k,v ) ); 362 } 363 } 364 365 /** 366 * リソースオブジェクトを指定します。 367 * 368 * @og.rev 4.3.7.4 (2009/07/01) 新規追加 369 * 370 * @param resource リソースオブジェクト 371 */ 372 public void setResource( final ResourceManager resource ) { 373 this.resource = resource; 374 } 375 376 /** 377 * リソースオブジェクトを取得します。 378 * 379 * @og.rev 4.3.7.4 (2009/07/01) 新規追加 380 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 381 * 382 * @return リソースオブジェクト 383 */ 384 public ResourceManager getResource() { 385 return resource; 386 } 387 388 /** 389 * デバッグ情報を出力するかどうか[true:する/false:しない]を指定します。 390 * true でデバッグ情報を表示します。 391 * 392 * @param flag デバッグ出力するか [true:する/false:しない] 393 */ 394 public void setDebug( final boolean flag ) { 395 useDebug = flag; // 6.0.2.5 (2014/10/31) refactoring メソッドと同じなので名称変更 396 } 397 398 /** 399 * デバッグ情報を出力するかどうか[true:する/false:しない]を取得します。 400 * true でデバッグ情報を表示します。 401 * 402 * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加 403 * 404 * @return デバッグ出力 [true:する/false:しない] 405 */ 406 public boolean isDebug() { 407 return useDebug ; // 6.0.2.5 (2014/10/31) refactoring メソッドと同じなので名称変更 408 } 409 410 /** 411 * エラーコード を取得します。 412 * エラーコード は、ErrorMessage クラスで規定されているコードです。 413 * 414 * @return エラーコード 415 */ 416 public int getErrorCode() { 417 return errCode; 418 } 419 420 /** 421 * エラーメッセージオブジェクト を取得します。 422 * 423 * @return エラーメッセージオブジェクト 424 */ 425 public ErrorMessage getErrorMessage() { 426 return errMessage; 427 } 428 429 /** 430 * タイトルとエラーコードを指定して、エラーメッセージオブジェクト を作成します。 431 * すでに、作成済みの場合は、作成済みのオブジェクトを、まだ、未作成の場合は、 432 * 新規に作成します。 433 * 434 * @param title タイトル 435 * @param code エラーコード 436 * 437 * @return エラーメッセージオブジェクト 438 */ 439 protected ErrorMessage makeErrorMessage( final String title,final int code ) { 440 if( errMessage == null ) { 441 errMessage = new ErrorMessage( title ); 442 } 443 if( errCode < code ) { errCode = code; } 444 return errMessage; 445 } 446 447 /** 448 * カラム名配列(String[])より、対応するカラムNo配列(int[])を作成します。 449 * 450 * @param nameArray カラム名配列 451 * 452 * @return カラムNo配列(可変長引数) 453 */ 454 protected int[] getTableColumnNo( final String... nameArray ) { 455 int[] clmNo = new int[nameArray.length]; 456 for( int i=0; i<clmNo.length; i++ ) { 457 clmNo[i] = table.getColumnNo( nameArray[i] ); 458 } 459 return clmNo; 460 } 461 462 /** 463 * 設定されたパラメータキーに対する値を取得します。 464 * 引数、および、パラメータが null の場合は、 null を返します。 465 * 466 * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap の not null制限のチェック追加 467 * 468 * @param key パラメータキー 469 * 470 * @return パラメータ値 471 */ 472 protected String getValue( final String key ) { 473 return key == null ? null : keyValMap.get( key ); 474 } 475 476 /** 477 * keyValMapに持っているキーの配列を取得します。 478 * これは、サブクラスで、initSet(String,String) を行わない場合、keys には 479 * 値を自由に設定できます。 480 * その値を取り出すためです。 481 * 482 * @og.rev 6.7.9.1 (2017/05/19) 新規追加 483 * 484 * @return キー値の配列(keyValMapに持っているキー) 485 */ 486 protected String[] getKeys() { 487 return keyValMap.keySet().toArray( new String[keyValMap.size()] ); 488 } 489}