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
018// import java.util.Map;
019import java.sql.CallableStatement;
020import java.sql.Connection;
021// import java.sql.SQLException;
022import java.sql.Types;
023// import java.sql.Array;                                                               // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応。oracle.sql.ARRAY の置き換え
024
025// import org.opengion.hayabusa.common.HybsSystemException;
026// import org.opengion.fukurou.util.ErrorMessage;
027import org.opengion.fukurou.util.StringUtil;
028import org.opengion.hayabusa.db.AbstractQuery;
029// import org.opengion.hayabusa.db.DBErrMsg;
030import org.opengion.hayabusa.db.ExceptionBiConsumer;                            // 8.5.6.1 (2024/03/29)
031
032/**
033 * Callableのエラー配列対応版です。バッチ系標準のPL/SQL をコールする Query クラスです。
034 *
035 * java.sql.CallableStatement を用いて、データベース検索処理を行います。
036 * 引数は、従来のPL/SQLの実行が可能なように、第一引数はエラーコード、第二引数は、
037 * エラーメッセージを返してきます。第三引数以降は、自由に指定できます。
038 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している
039 * ため、ここでは、execute() メソッドを実装しています。
040 *
041 * @og.formSample
042 * 例：
043 *     第一引数、第二引数は、通常のPL/SQLと同じ、結果(STATUS)と
044 *     内容(ERR_CODE)を返します。
045 *     それ以降の引数については、入力(IN)のみですが、自由に設定できます。
046 *     引数に変数を使用する場合は、? 記号を当てはめます。
047 *     第一引数、第二引数は、予約済みですが、それ以降は、好きな位置に割り当てられます。
048 *     names 属性の順番に、値だけがセットされていきます。
049 *     下記の例は、変数の引数は、使用していません。
050 *
051 * <og:query
052 *     command="NEW"
053 *     queryType="JDBCArrayCallable"
054 *     displayMsg="" >
055 *         { call GEP00002.GEP00002( ?,?,'{@GUI.KEY}','{@USER.ID}' ) }
056 * </og:query>
057 *
058 *    CREATE OR REPLACE PACKAGE GEP00002 AS
059 *        PROCEDURE GEP00002(
060 *            P_STATUS    OUT    NUMBER,
061 *            P_ERR_CODE  OUT    ERR_MSG_ARRAY,
062 *            P_MIDDB     IN     VARCHAR2,
063 *            P_USRUPD    IN     VARCHAR2  );
064 *    END;
065 *
066 * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
067 * @og.group データ表示
068 * @og.group データ編集
069 *
070 * @version  4.0
071 * @author   高橋正和
072 * @since    JDK5.0,
073 */
074public class Query_JDBCArrayCallable 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_JDBCArrayCallable() { 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 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
097         * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。
098         * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。
099         * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。
100         * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
101         *
102         * @param   args オブジェクトの引数配列(可変長引数)
103         */
104        @Override
105        public void execute( final String... args ) {                   // 6.1.1.0 (2015/01/17) refactoring
106                final ExceptionBiConsumer<CallableStatement,Connection> biConsumer = (callStmt,conn) -> {
107                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
108                        callStmt.registerOutParameter(1, Types.INTEGER);
109                        callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);
110                        // 6.1.1.0 (2015/01/17) refactoring. 可変引数にしたため、null は来ない。
111                        if( args != null ) {            // 引数に null を渡せば、null が来る(何も渡さなければ、長さ０の配列)
112                                for( int i=0; i<args.length; i++ ) {
113                                        callStmt.setObject( i+3,StringUtil.rTrim( args[i] ) );
114                                }
115                        }
116                };
117
118                execute( biConsumer, getClass().getSimpleName() );
119        }
120
121//      /**
122//       * 引数配列付のクエリーを実行します。
123//       * 処理自体は、#execute() と同様に、各サブクラスの実装に依存します。
124//       * これは、PreparedQuery で使用する引数を配列でセットするものです。
125//       * select * from emp where deptno = ? and job = ? などの PreparedQuery の
126//       * ? 部分の引数を
127//       * 順番にセットしていきます。
128//       *
129//       * @og.rev 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
130//       * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。
131//       * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。
132//       * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。
133//       * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
134//       *
135//       * @param   args オブジェクトの引数配列(可変長引数)
136//       */
137//      @Override
138//      public void execute( final String... args ) {                   // 6.1.1.0 (2015/01/17) refactoring
139//              final Connection conn = getConnection();
140//              // 6.4.2.1 (2016/02/05) try-with-resources 文
141//              try( CallableStatement callStmt = conn.prepareCall( getStatement() ) ) {
142//                      callStmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
143//                      callStmt.setFetchSize( DB_FETCH_SIZE );                 // 6.9.3.0 (2018/03/26)
144//
145//                      final Map<String,Class<?>> map = conn.getTypeMap();
146//                      map.put( ERR_MSG,DBErrMsg.class );
147//
148//                      // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
149//                      callStmt.registerOutParameter(1, Types.INTEGER);
150//                      callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);
151//                      // 6.1.1.0 (2015/01/17) refactoring. 可変引数にしたため、null は来ない。
152//                              for( int i=0; i<args.length; i++ ) {
153//                                      callStmt.setObject( i+3,StringUtil.rTrim( args[i] ) );
154//                              }
155//                      callStmt.execute();
156//
157//                      final int rtnCode = callStmt.getInt(1);
158//                      setErrorCode( rtnCode );
159//
160//                      if( rtnCode > ErrorMessage.OK ) {               // 正常以外の場合
161//                              // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応
162//                              final ErrorMessage errMessage = new ErrorMessage( "Query_JDBCArrayCallable Error!!" );
163//                              final Array rtn3 = callStmt.getArray(2);
164//                              // 8.5.4.2 (2024/01/12) PMD 7.0.0 ForLoopCanBeForeach
165////                            final Object[] rtnval3 = (Object[])rtn3.getArray();
166////                            for( int i=0; i<rtnval3.length; i++ ) {
167////                                    final DBErrMsg er = (DBErrMsg)rtnval3[i];
168//                              for( final Object rtnval : (Object[])rtn3.getArray() ) {
169//                                      final DBErrMsg er = (DBErrMsg)rtnval;
170//                                      if( er == null ) { break; }
171//                                      errMessage.addMessage( er.getErrMsg() );
172//                              }
173//                              setErrorMessage( errMessage );
174//                      }
175//              }
176//              catch( final SQLException ex ) {                // catch は、close() されてから呼ばれます。
177//                      setErrorCode( ErrorMessage.EXCEPTION );
178//                      final String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR
179//                                              + getStatement() + CR;
180//                      throw new HybsSystemException( errMsg,ex );
181//              }
182//      }
183}