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.plugin.query; 017 018import java.sql.Types; 019import java.sql.Connection; 020import java.sql.CallableStatement; 021// import java.sql.SQLException; 022import java.sql.Array; // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応。oracle.sql.ARRAY の置き換え 023// import java.util.Map; 024 025import oracle.jdbc.OracleConnection; // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応 026 027// import org.opengion.fukurou.util.ErrorMessage; 028import org.opengion.fukurou.util.StringUtil; 029import org.opengion.hayabusa.db.AbstractQuery; 030// import org.opengion.hayabusa.db.DBErrMsg; 031// import org.opengion.hayabusa.common.HybsSystemException; 032import org.opengion.hayabusa.db.ExceptionBiConsumer; // 8.5.6.1 (2024/03/29) 033 034/** 035 * PL/SQL にエントリ情報を配列渡しする、Query 実行クラスです。 036 * 037 * java.sql.CallableStatement を用いて、データベース登録処理を行います。 038 * 引数に、キーと値をセットで配列指定で渡すことが出来、エラー時には、 039 * DBErrMsg オブジェクトにエラー情報を格納して返すことが可能です。 040 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している 041 * ため、ここでは、execute() メソッドを実装しています。 042 * このクラスでは、ステートメント文を execute() する事により、データベースを 043 * 検索した結果を DBTableModel に割り当てます。 044 * 045 * @og.formSample 046 * 例： 047 * 第一引数、第二引数は、結果(KEKKA)とエラーメッセージ配列を返します。 048 * キーエントリでは、エントリ(リクエスト情報)のキーと値をセットで 049 * 引数の配列に設定します。 050 * キーを元に、値を利用する場合に使用します。 051 * 下記の例は、動的カラムを実現しているPL/SQLの例です。 052 * 053 * <og:entryQuery 054 * command = "NEW" 055 * queryType = "JDBCKeyEntry" > 056 * { call DYNAMIC_PKG.DYNAMIC_TEST( ?,?,?,? ) } 057 * </og:entryQuery> 058 * 059 * CREATE OR REPLACE PACKAGE DYNAMIC_PKG AS 060 * PROCEDURE DYNAMIC_TEST( 061 * P_KEKKA OUT NUMBER, 062 * P_ERRMSGS OUT ERR_MSG_ARRAY, 063 * P_KEYS IN ARG_ARRAY, 064 * P_ARGS IN ARG_ARRAY ); 065 * END; 066 * 067 * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。 068 * @og.group データ編集 069 * 070 * @version 4.0 071 * @author Kazuhiko Hasegawa 072 * @since JDK5.0, 073 */ 074public class Query_JDBCKeyEntry extends AbstractQuery { 075 /** このプログラムのVERSION文字列を設定します。 {@value} */ 076 private static final String VERSION = "8.5.6.1 (2024/03/29)" ; 077 078 /** 079 * デフォルトコンストラクター 080 * 081 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 082 */ 083 public Query_JDBCKeyEntry() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 084 085 /** 086 * 引数配列付のクエリーを実行します。 087 * 処理自体は、#execute() と同様に、各サブクラスの実装に依存します。 088 * これは、PreparedQuery で使用する引数を配列でセットするものです。 089 * select * from emp where deptno = ? and job = ? などの PreparedQuery の 090 * ? 部分の引数を 091 * 順番にセットしていきます。 092 * 093 * ※ 8.5.6.1 (2024/03/29) 094 * Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。 095 * 096 * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。 097 * @og.rev 3.3.3.1 (2003/07/18) ＤＢ登録時の後ろスペースを削除する。 098 * @og.rev 3.5.2.0 (2003/10/20) 内部オブジェクトタイプ名を システムパラメータ で定義します。 099 * @og.rev 3.5.6.0 (2004/06/18) nullに対する無駄な比較を削除します。 100 * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ＋Queryに変更します。 101 * @og.rev 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 102 * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。 103 * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。 104 * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。 105 * @og.rev 8.5.4.2 (2024/01/12) PMD 7.0.0 LocalVariableNamingConventions 対応 106 * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。 107 * 108 * @param keys オブジェクトのキー配列 109 * @param args オブジェクトの引数配列(可変長引数) 110 */ 111 @Override 112 public void execute( final String[] keys, final String... args ) { // 6.1.1.0 (2015/01/17) refactoring 113 final ExceptionBiConsumer<CallableStatement,Connection> biConsumer = (callStmt,conn) -> { 114 // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm 115 // 8.5.5.1 (2024/02/29) PMD 7.0.0 LocalVariableNamingConventions 116 final Array arrayKey = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, keys ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 117 118 // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm 119 // 8.5.5.1 (2024/02/29) PMD 7.0.0 LocalVariableNamingConventions 120 final Array arrayVal = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, StringUtil.rTrims( args )); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 121 122 callStmt.registerOutParameter(1, Types.INTEGER); 123 callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 124 // 8.5.5.1 (2024/02/29) PMD 7.0.0 LocalVariableNamingConventions 125 callStmt.setArray( 3,arrayKey ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 126 callStmt.setArray( 4,arrayVal ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 127 }; 128 129 execute( biConsumer, getClass().getSimpleName() ); 130 } 131 132// /** 133// * 引数配列付のクエリーを実行します。 134// * 処理自体は、#execute() と同様に、各サブクラスの実装に依存します。 135// * これは、PreparedQuery で使用する引数を配列でセットするものです。 136// * select * from emp where deptno = ? and job = ? などの PreparedQuery の 137// * ? 部分の引数を 138// * 順番にセットしていきます。 139// * 140// * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。 141// * @og.rev 3.3.3.1 (2003/07/18) ＤＢ登録時の後ろスペースを削除する。 142// * @og.rev 3.5.2.0 (2003/10/20) 内部オブジェクトタイプ名を システムパラメータ で定義します。 143// * @og.rev 3.5.6.0 (2004/06/18) nullに対する無駄な比較を削除します。 144// * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ＋Queryに変更します。 145// * @og.rev 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 146// * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。 147// * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。 148// * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。 149// * @og.rev 8.5.4.2 (2024/01/12) PMD 7.0.0 LocalVariableNamingConventions 対応 150// * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。 151// * 152// * @param keys オブジェクトのキー配列 153// * @param args オブジェクトの引数配列(可変長引数) 154// */ 155// @Override 156// public void execute( final String[] keys, final String... args ) { // 6.1.1.0 (2015/01/17) refactoring 157// final Connection conn = getConnection(); 158// // 6.4.2.1 (2016/02/05) try-with-resources 文 159// try( CallableStatement callStmt = conn.prepareCall( getStatement() ) ) { 160// callStmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT ); 161// callStmt.setFetchSize( DB_FETCH_SIZE ); // 6.9.3.0 (2018/03/26) 162// 163// final Map<String,Class<?>> map = conn.getTypeMap(); 164// map.put( ERR_MSG,DBErrMsg.class ); // 4.0.0 (2005/01/31) 165// 166// // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm 167//// final Array newArray_key = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, keys ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 168// // 8.5.5.1 (2024/02/29) PMD 7.0.0 LocalVariableNamingConventions 169//// final Array array_key = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, keys ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 170// final Array arrayKey = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, keys ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 171// 172// // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm 173//// final Array newArray_val = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, StringUtil.rTrims( args )); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 174// // 8.5.5.1 (2024/02/29) PMD 7.0.0 LocalVariableNamingConventions 175//// final Array array_val = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, StringUtil.rTrims( args )); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 176// final Array arrayVal = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, StringUtil.rTrims( args )); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 177// 178// callStmt.registerOutParameter(1, Types.INTEGER); 179// callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 180//// callStmt.setArray( 3,newArray_key ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 181//// callStmt.setArray( 4,newArray_val ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 182// // 8.5.5.1 (2024/02/29) PMD 7.0.0 LocalVariableNamingConventions 183//// callStmt.setArray( 3,array_key ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 184//// callStmt.setArray( 4,array_val ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 185// callStmt.setArray( 3,arrayKey ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 186// callStmt.setArray( 4,arrayVal ); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 187// 188// callStmt.execute(); 189// 190// final int rtnCode = callStmt.getInt(1); 191// setErrorCode( rtnCode ); 192// if( rtnCode > ErrorMessage.OK ) { // 正常以外の場合 193// final ErrorMessage errMessage = new ErrorMessage( "Query_JDBCKeyEntry Error!!" ); 194// final Array rtn3 = callStmt.getArray(2); // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 195// // 8.5.4.2 (2024/01/12) PMD 7.0.0 ForLoopCanBeForeach 196//// final Object[] rtnval3 = (Object[])rtn3.getArray(); 197//// for( int i=0; i<rtnval3.length; i++ ) { 198//// final DBErrMsg er = (DBErrMsg)rtnval3[i]; 199// for( final Object rtnval : (Object[])rtn3.getArray() ) { 200// final DBErrMsg er = (DBErrMsg)rtnval; 201// if( er == null ) { break; } 202// errMessage.addMessage( er.getErrMsg() ); 203// } 204// setErrorMessage( errMessage ); 205// } 206// } 207// catch( final SQLException ex) { // catch は、close() されてから呼ばれます。 208// setErrorCode( ErrorMessage.EXCEPTION ); 209// final String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR 210// + getStatement() + CR ; 211// throw new HybsSystemException( errMsg,ex ); // 3.5.5.4 (2004/04/15) 引数の並び順変更 212// } 213// } 214}