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.db; 017 018import org.opengion.fukurou.util.StringUtil; 019import org.opengion.fukurou.util.ApplicationInfo; 020import org.opengion.fukurou.util.Closer; 021import org.opengion.fukurou.model.Formatter; 022import org.opengion.fukurou.model.ArrayDataModel; 023 024import java.sql.Connection; 025import java.sql.PreparedStatement; 026import java.sql.ParameterMetaData; 027import java.sql.SQLException; 028 029import java.util.Arrays; 030 031/** 032 * DBTableModel インターフェースを継承した TableModel の実装クラスです。 033 * sql文を execute( query ) する事により,データベースを検索した結果を 034 * DBTableModel に割り当てます。 035 * 036 * メソッドを宣言しています 037 * DBTableModel インターフェースは,データベースの検索結果(Resultset)をラップする 038 * インターフェースとして使用して下さい。 039 * 040 * @og.rev 5.2.2.0 (2010/11/01) パッケージ移動(hayabusa.db ⇒ fukurou.db) 041 * @og.group DB/Shell制御 042 * 043 * @version 4.0 044 * @author Kazuhiko Hasegawa 045 * @since JDK5.0, 046 */ 047public class DBSimpleTable { 048 049 /** システム依存の改行記号をセットします。 */ 050 private static final String CR = System.getProperty("line.separator"); 051 052 private final String[] names ; // データ配列に対応するカラム配列(names) 053 private String[] keys = null; // 登録に使用するカラムキー配列(keys) 054 private int[] keysNo = null; // 登録に使用するカラムキー配列番号 055 private String table = null; // 登録テーブル名 056 private String where = null; // where 条件式[カラム名]を含む 057 private int[] whereNo = null; // [カラム名]に対応するデータ配列番号 058 private String[] constrain = null; // key に対応した制約条件 059 060 private String connID = null; // 登録に使用するコネクションID 061 private boolean useWhere = false; // where が設定されると true にセットされます。 062 063 private Connection conn = null; 064 private PreparedStatement pstmt = null; 065 private ParameterMetaData pMeta = null; // 5.1.2.0 (2010/01/01) setObject に、Type を渡す。(PostgreSQL対応) 066 private String query = null; // エラーメッセージ用の変数 067 private int execCnt = 0; 068 private ApplicationInfo appInfo = null; // 3.8.7.0 (2006/12/15) 069 private boolean useParamMetaData = false; // 5.1.2.0 (2010/01/01) setObject に、Type を渡す。(PostgreSQL対応) 070 071 /** 072 * データ配列のカラム名称配列を指定してオブジェクトを構築します。 073 * 074 * @param nm カラム名称配列 075 * @throws RuntimeException tbl が null の場合 076 */ 077 public DBSimpleTable( final String[] nm ) { 078 if( nm == null ) { 079 String errMsg = "データ配列のカラム名称に null は設定できません。"; 080 throw new RuntimeException( errMsg ); 081 } 082 083 names = new String[nm.length]; 084 System.arraycopy( nm,0,names,0,names.length ); 085 } 086 087 /** 088 * 登録に使用するカラムキー配列(keys)を登録します。 089 * 090 * 引数のkey配列が null の場合は、names と同じカラム名称配列(names)が使用されます。 091 * キー配列(keys)は、一度しか登録できません。また、addConstrain等のメソッド 092 * 呼び出しを先に実行すると、カラム名称配列(names)が設定されてしまう為、 093 * その後にこのメソッドを呼び出すとエラーが発生します。 094 * 095 * @param key 登録カラム名称配列 096 * @see #addConstrain( String ,String ) 097 * @throws RuntimeException すでに キー配列(keys)が登録済み/作成済みの場合 098 */ 099 public void setKeys( final String[] key ) { 100 if( keys != null ) { 101 String errMsg = "すでに キー配列(keys)が登録済みです。"; 102 throw new RuntimeException( errMsg ); 103 } 104 105 if( key != null ) { 106 int size = key.length; 107 keys = new String[size]; 108 System.arraycopy( key,0,keys,0,size ); 109 110 constrain = new String[size]; 111 Arrays.fill( constrain,"?" ); 112 113 keysNo = new int[size]; 114 for( int i=0; i<size; i++ ) { 115 int address = findAddress( names,keys[i] ); 116 if( address >= 0 ) { 117 keysNo[i] = address; 118 } 119 else { 120 String errMsg = "指定の key は、カラム配列(names)に存在しません" 121 + " key[" + i + "]=" + key[i] 122 + " names=" + StringUtil.array2csv( names ) ; 123 throw new RuntimeException( errMsg ); 124 } 125 } 126 } 127 } 128 129 /** 130 * カラム名称配列(names)と同じキー配列(keys)を作成します。 131 * 132 * これは、キー配列(keys) が作成されなかった場合の処理です。 133 * keys が null の場合のみ、処理を実行します。 134 * 135 * @see #setKeys( String[] ) 136 */ 137 private void makeKeys() { 138 // キー配列(keys) が未設定の場合は、カラム名称配列(names)が設定されます。 139 if( keys == null ) { 140 keys = names; 141 int size = keys.length; 142 143 constrain = new String[size]; 144 Arrays.fill( constrain,"?" ); 145 146 keysNo = new int[size]; 147 for( int i=0; i<size; i++ ) { 148 keysNo[i] = i; 149 } 150 } 151 } 152 153 /** 154 * Insert/Update/Delete 時の登録するテーブル名 155 * 156 * @param tbl テーブル名 157 * @throws RuntimeException tbl が null の場合 158 */ 159 public void setTable( final String tbl ) { 160 if( tbl == null ) { 161 String errMsg = "table に null は設定できません。"; // 5.1.8.0 (2010/07/01) errMsg 修正 162 throw new RuntimeException( errMsg ); 163 } 164 165 table = tbl; 166 } 167 168 /** 169 * データベースの接続先IDを設定します。 170 * 171 * @param conn 接続先ID 172 */ 173 public void setConnectionID( final String conn ) { 174 connID = conn; 175 } 176 177 /** 178 * アクセスログ取得の為,ApplicationInfoオブジェクトを設定します。 179 * 180 * @og.rev 3.8.7.0 (2006/12/15) 新規追加 181 * 182 * @param appInfo アプリ情報オブジェクト 183 */ 184 public void setApplicationInfo( final ApplicationInfo appInfo ) { 185 this.appInfo = appInfo; 186 } 187 188 /** 189 * Insert/Update/Delete 時の PreparedStatement の引数(?)制約 190 * 191 * 制約条件(val)は、そのまま引数に使用されます。通常、? で表される 192 * パラメータに、文字長を制限する場合、SUBSTRB( ?,1,100 ) という 193 * val 変数を与えます。 194 * また、キー一つに対して、値を複数登録したい場合にも、使用できます。 195 * 例えば、NVAL( ?,? ) のような場合、キー一つに値2つを割り当てます。 196 * 値配列の並び順は、キー配列(keys)に対する(?の個数)に対応します。 197 * 注意:カラム名称配列(names)ではありません。また、先にキー配列(keys)を登録 198 * しておかないと、キー配列登録時にエラーが発生します。 199 * 制約条件は、処理するQUERYに対して適用されますので、 200 * key または、val が null の場合は、RuntimeException を Throwします。 201 * 202 * @param key 制約をかけるキー 203 * @param val 制約条件式 204 * @see #setKeys( String[] ) 205 * @throws RuntimeException key または、val が null の場合 206 */ 207 public void addConstrain( final String key,final String val ) { 208 if( key == null || val == null ) { 209 String errMsg = "key または、val に null は設定できません。" 210 + " key=[" + key + "] , val=[" + val + "]" ; 211 throw new RuntimeException( errMsg ); 212 } 213 214 // キー配列(keys)が未設定(null)の場合は、カラム名称配列(names)を割り当てます。 215 if( keys == null ) { makeKeys(); } 216 217 // 制約条件のアドレスは、カラム名称配列(names)でなく、キー配列(keys)を使用します。 218 int address = findAddress( keys,key ); 219 if( address >= 0 ) { 220 constrain[address] = val; 221 } 222 else { 223 String errMsg = "指定の key は、キー配列(keys)に存在しません" 224 + " key=[" + key + "] , val=[" + val + "]" 225 + " keys=" + StringUtil.array2csv( keys ) ; 226 throw new RuntimeException( errMsg ); 227 } 228 } 229 230 /** 231 * Update/Delete 時のキーとなるWHERE 条件のカラム名を設定します。 232 * 233 * 通常の WHERE 句の書き方と同じで、カラム配列(names)に対応する設定値(values)の値を 234 * 割り当てたい箇所に[カラム名] を記述します。文字列の場合、設定値をセットする 235 * ときに、シングルコーテーションを使用しますが、[カラム名]で指定する場合は、 236 * その前後に、(')シングルコーテーションは、不要です。 237 * WHERE条件は、登録に使用するキー配列(keys)に現れない条件で行を特定することがありますので 238 * カラム名称配列(names)を元にカラム名のアドレスを求めます。 239 * [カラム名]は、? に置き換えて、PreparedStatement として、実行される形式に変換されます。 240 * 例:FGJ='1' and CLM=[CLM] and SYSTEM_ID in ([SYSID],'**') 241 * 242 * @og.rev 4.3.4.0 (2008/12/01) キー配列(keys)が未設定(null)の場合は、カラム名称配列(names)を割り当てる 243 * @og.rev 5.0.2.0 (2009/11/01) バグ修正(keysはデータセットのキーなので、where句のカラムに含まれて入いるわけではない) 244 * 245 * @param wh WHERE条件のカラム名 246 * @throws RuntimeException [カラム名]がカラム配列(names)に存在しない場合 247 */ 248 public void setWhere( final String wh ) { 249 250 if( wh != null ) { 251 // キー配列(keys)が未設定(null)の場合は、カラム名称配列(names)を割り当てます。 252 // 5.0.2.0 (2009/11/01) 253 ArrayDataModel data = new ArrayDataModel( names ); 254 Formatter format = new Formatter( data ); 255 format.setFormat( wh ); 256 where = format.getQueryFormatString(); 257 whereNo = format.getClmNos(); 258 } 259 else { 260 where = null; 261 } 262 } 263 264 /** 265 * データをインサートする場合に使用するSQL文を作成します。 266 * 267 * @return インサートSQL 268 */ 269 private String getInsertSQL() { 270 // キー配列(keys)が未設定(null)の場合は、カラム名称配列(names)を割り当てます。 271 if( keys == null ) { makeKeys(); } 272 273 StringBuilder sql = new StringBuilder(); 274 sql.append( "INSERT INTO " ).append( table ); 275 sql.append( " ( " ); 276 sql.append( keys[0] ); 277 for( int i=1; i<keys.length; i++ ) { 278 sql.append( "," ).append( keys[i] ); 279 } 280 sql.append( " ) VALUES ( " ); 281 sql.append( constrain[0] ); 282 for( int i=1; i<keys.length; i++ ) { 283 sql.append( "," ).append( constrain[i] ); 284 } 285 sql.append( " )" ); 286 287 useWhere = false; 288 289 return sql.toString(); 290 } 291 292 /** 293 * データをアップデートする場合に使用するSQL文を作成します。 294 * 295 * @return アップデートSQL 296 */ 297 private String getUpdateSQL() { 298 // キー配列(keys)が未設定(null)の場合は、カラム名称配列(names)を割り当てます。 299 if( keys == null ) { makeKeys(); } 300 301 StringBuilder sql = new StringBuilder(); 302 sql.append( "UPDATE " ).append( table ).append( " SET " ); 303 sql.append( keys[0] ).append( " = " ).append( constrain[0] ); 304 305 for( int i=1; i<keys.length; i++ ) { 306 sql.append( " , " ); 307 sql.append( keys[i] ).append( " = " ).append( constrain[i] ); 308 } 309 310 if( where != null && where.length() > 0 ) { 311 sql.append( " WHERE " ).append( where ); 312 useWhere = true; 313 } 314 else { 315 useWhere = false; 316 } 317 318 return sql.toString(); 319 } 320 321 /** 322 * データをデリートする場合に使用するSQL文を作成します。 323 * 324 * @og.rev 5.0.2.0 (2009/11/01) バグ修正(削除時はkeysは必要ない) 325 * 326 * @return デリートSQL 327 */ 328 private String getDeleteSQL() { 329 // キー配列(keys)が未設定(null)の場合は、カラム名称配列(names)を割り当てます。 330 // 5.0.2.0 (2009/11/01) 331 keys = new String[0]; 332 333 StringBuilder sql = new StringBuilder(); 334 sql.append( "DELETE FROM " ).append( table ); 335 336 if( where != null && where.length() > 0 ) { 337 sql.append( " WHERE " ).append( where ); 338 useWhere = true; 339 } 340 else { 341 useWhere = false; 342 } 343 344 return sql.toString(); 345 } 346 347 /** 348 * Insert 処理の開始を宣言します。 349 * 内部的に、コネクションを接続して、PreparedStatementオブジェクトを作成します。 350 * このメソッドと、close() メソッドは必ずセットで処理してください。 351 * 352 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 353 * @og.rev 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 354 * @og.rev 5.3.8.0 (2011/08/01) useParamMetaData を ConnectionFactory経由で取得。(PostgreSQL対応) 355 * 356 * @throws SQLException Connection のオープンに失敗した場合 357 */ 358 public void startInsert() throws SQLException { 359 execCnt = 0; 360 query = getInsertSQL(); 361 conn = ConnectionFactory.connection( connID,appInfo ); 362 pstmt = conn.prepareStatement( query ); 363 // 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 364 useParamMetaData = ConnectionFactory.useParameterMetaData( connID ); // 5.3.8.0 (2011/08/01) 365 if( useParamMetaData ) { 366 pMeta = pstmt.getParameterMetaData(); 367 } 368 } 369 370 /** 371 * Update 処理の開始を宣言します。 372 * 内部的に、コネクションを接続して、PreparedStatementオブジェクトを作成します。 373 * このメソッドと、close() メソッドは必ずセットで処理してください。 374 * 375 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 376 * @og.rev 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 377 * @og.rev 5.3.8.0 (2011/08/01) useParamMetaData を ConnectionFactory経由で取得。(PostgreSQL対応) 378 * 379 * @throws SQLException Connection のオープンに失敗した場合 380 */ 381 public void startUpdate() throws SQLException { 382 execCnt = 0; 383 query = getUpdateSQL(); 384 conn = ConnectionFactory.connection( connID,appInfo ); 385 pstmt = conn.prepareStatement( query ); 386 // 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 387 useParamMetaData = ConnectionFactory.useParameterMetaData( connID ); // 5.3.8.0 (2011/08/01) 388 if( useParamMetaData ) { 389 pMeta = pstmt.getParameterMetaData(); 390 } 391 } 392 393 /** 394 * Delete 処理の開始を宣言します。 395 * 内部的に、コネクションを接続して、PreparedStatementオブジェクトを作成します。 396 * このメソッドと、close() メソッドは必ずセットで処理してください。 397 * 398 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 399 * @og.rev 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 400 * @og.rev 5.3.8.0 (2011/08/01) useParamMetaData を ConnectionFactory経由で取得。(PostgreSQL対応) 401 * 402 * @throws SQLException Connection のオープンに失敗した場合 403 */ 404 public void startDelete() throws SQLException { 405 execCnt = 0; 406 query = getDeleteSQL(); 407 conn = ConnectionFactory.connection( connID,appInfo ); 408 pstmt = conn.prepareStatement( query ); 409 // 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 410 useParamMetaData = ConnectionFactory.useParameterMetaData( connID ); // 5.3.8.0 (2011/08/01) 411 if( useParamMetaData ) { 412 pMeta = pstmt.getParameterMetaData(); 413 } 414 } 415 416 /** 417 * データ配列を渡して実際のDB処理を実行します。 418 * 419 * この処理の前に、startXXXX をコールしておき、INSER,UPDATE,DELETEのどの 420 * 処理を行うか、宣言しておく必要があります。 421 * 戻り値は、この処理での処理件数です。 422 * 最終件数は、close( boolean ) 時に取得します。 423 * 424 * @og.rev 4.0.0.0 (2007/11/28) SQLException をきちんと伝播させます。 425 * @og.rev 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 426 * @og.rev 5.3.8.0 (2011/08/01) useParamMetaData 時の setNull 対応(PostgreSQL対応) 427 * 428 * @param values カラム配列(names) に対応する設定値配列 429 * 430 * @return ここでの処理件数 431 * 432 * @see #close( boolean ) 433 * @throws SQLException Connection のクロースに失敗した場合 434 * @throws RuntimeException Connection DB処理の実行に失敗した場合 435 */ 436 public int execute( final String[] values ) throws SQLException { 437 final int cnt; 438 try { 439 int clmNo = 1; // JDBC のカラム番号は、1から始まる。 440 441 // 5.1.2.0 (2010/01/01) setObject に ParameterMetaData の getParameterType を渡す。(PostgreSQL対応) 442 if( useParamMetaData ) { 443 // keys に値を割り当てます。 444 for( int i=0; i<keys.length; i++ ) { 445 int type = pMeta.getParameterType( clmNo ); 446 // 5.3.8.0 (2011/08/01) setNull 対応 447 String val = values[keysNo[i]]; 448 if( val == null || val.isEmpty() ) { 449 pstmt.setNull( clmNo++, type ); 450 } 451 else { 452 pstmt.setObject( clmNo++,val,type ); 453 } 454 } 455 456 // where 条件を使用する場合は、値を割り当てます。 457 if( useWhere ) { 458 for( int i=0; i<whereNo.length; i++ ) { 459 int type = pMeta.getParameterType( clmNo ); 460 // 5.3.8.0 (2011/08/01) setNull 対応 461 String val = values[whereNo[i]]; 462 if( val == null || val.isEmpty() ) { 463 pstmt.setNull( clmNo++, type ); 464 } 465 else { 466 pstmt.setObject( clmNo++,val,type ); 467 } 468 } 469 } 470 } 471 else { 472 // keys に値を割り当てます。 473 for( int i=0; i<keys.length; i++ ) { 474 pstmt.setObject( clmNo++,values[keysNo[i]] ); 475 } 476 477 // where 条件を使用する場合は、値を割り当てます。 478 if( useWhere ) { 479 for( int i=0; i<whereNo.length; i++ ) { 480 pstmt.setObject( clmNo++,values[whereNo[i]] ); 481 } 482 } 483 } 484 485 cnt = pstmt.executeUpdate(); 486 execCnt += cnt; 487 } 488 catch (SQLException ex) { 489 Closer.stmtClose( pstmt ); 490 pMeta = null; // 5.1.2.0 (2010/01/01) 491 if( conn != null ) { 492 conn.rollback(); 493 ConnectionFactory.remove( conn,connID ); 494 conn = null; 495 } 496 String errMsg = "DB処理の実行に失敗しました。" + CR 497 + " query=[" + query + "]" + CR 498 + " values=" + StringUtil.array2csv( values ); 499 throw new RuntimeException( errMsg ,ex ); 500 } 501 return cnt; 502 } 503 504 /** 505 * DB処理をクロースします。 506 * 507 * 引数には、commit させる場合は、true を、rollback させる場合は、false をセットします。 508 * 戻り値は、今まで処理された合計データ件数です。 509 * この処理は、SQLException を内部で RuntimeException に変換している為、catch 節は 510 * 不要ですが、必ず finally 節で呼び出してください。そうしないと、リソースリークの 511 * 原因になります。 512 * 513 * @og.rev 5.1.2.0 (2010/01/01) pMeta のクリア 514 * 515 * @param commitFlag コミットフラグ [true:commitする/false:rollbacする] 516 * 517 * @return 今までの合計処理件数 518 */ 519 public int close( final boolean commitFlag ) { 520 if( conn != null ) { 521 try { 522 if( commitFlag ) { conn.commit(); } 523 else { conn.rollback(); } 524 } 525 catch (SQLException ex) { 526 ConnectionFactory.remove( conn,connID ); 527 conn = null; 528 String errMsg = "DB処理を確定(COMMIT)できませんでした。" + CR 529 + " query=[" + query + "]" + CR ; 530 throw new RuntimeException( errMsg,ex ); 531 } 532 finally { 533 Closer.stmtClose( pstmt ); 534 pMeta = null; // 5.1.2.0 (2010/01/01) 535 ConnectionFactory.close( conn,connID ); 536 conn = null; 537 } 538 } 539 540 return execCnt; 541 } 542 543 /** 544 * 文字列配列中の値とマッチするアドレスを検索します。 545 * 文字列配列がソートされていない為、バイナリサーチが使えません。よって、 546 * 総当りでループ検索しています。 547 * 総数が多い場合は、遅くなる為、マップにセットして使用することを検討ください。 548 * 549 * @param data ターゲットの文字列配列中 550 * @param key 検索する文字列 551 * 552 * @return ターゲットの添え字(存在しない場合は、-1) 553 */ 554 private int findAddress( final String[] data,final String key ) { 555 int address = -1; 556 if( data != null && key != null ) { 557 for( int i=0; i<data.length; i++ ) { 558 if( key.equalsIgnoreCase( data[i] ) ) { 559 address = i; 560 break; 561 } 562 } 563 } 564 return address; 565 } 566}