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.Connection;
019import java.sql.CallableStatement;
020// import java.sql.SQLException;
021import java.sql.Types;
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.hayabusa.db.AbstractQuery;
029import org.opengion.hayabusa.db.DBSysArg;
030import org.opengion.hayabusa.db.DBUserArg;
031import org.opengion.hayabusa.db.ExceptionBiConsumer;                            // 8.5.6.1 (2024/03/29)
032// import org.opengion.hayabusa.db.DBErrMsg;
033// import org.opengion.hayabusa.common.HybsSystemException;
034
035/**
036 * PL/SQL をコールする 登録系 Queryクラスです。
037 *
038 * java.sql.CallableStatement を用いて、データベース検索処理を行います。
039 * 引数に、SYSARG_ARRAYと、ユーザーARG_ARRAY を配列指定で渡すことが出来、
040 * エラー時には、DBErrMsg オブジェクトにエラー情報を格納して返すことが可能です。
041 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している
042 * ため、ここでは、execute() メソッドを実装しています。
043 * このクラスでは、ステートメント文を execute() する事により、データベースを
044 * 検索した結果を DBTableModel に割り当てます。
045 *
046 * @og.formSample
047 * 例:jsp/TYPE1B/result.jsp
048 *     names には、GEA08ARG で定義したカラムを指定します。
049 *     呼び出す PL/SQL では、登録系PL/SQL です。
050 *
051 * <og:plsqlUpdate
052 *     command    = "{@command}"
053 *     names      = "SYSTEM_ID,LANG,CLM,NAME_JA,LABEL_NAME,KBSAKU,FGJ,USRSET"
054 *     dbType     = "GEA08ARG"
055 *     queryType  = "JDBCPLSQL" >
056 *            { call TYPE1B01.TYPE1B01( ?,?,?,?,? ) }
057 * </og:plsqlUpdate>
058 *
059 *      PROCEDURE TYPE1B01 (
060 *         P_KEKKA     OUT   NUMBER,          -- エラー結果(0:正常 1:警告 2:異常)
061 *         P_ERRMSGS   OUT   ERR_MSG_ARRAY,   -- エラーのあるときのエラーメッセージ配列
062 *         P_NAMES     IN    VARCHAR2,
063 *         P_SYSARGS   IN    SYSARG_ARRAY,    -- 引数 SYSTEMデータ
064 *         P_GE08ARGS  IN    GEA08ARG_ARRAY   -- 引数 USERデータ
065 *  );
066 *
067 * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
068 * @og.group データ表示
069 * @og.group データ編集
070 *
071 * @version  4.0
072 * @author   Kazuhiko Hasegawa
073 * @since    JDK5.0,
074 */
075public class Query_JDBCPLSQL extends AbstractQuery {
076        /** このプログラムのVERSION文字列を設定します。   {@value} */
077        private static final String VERSION = "8.5.6.1 (2024/03/29)" ;
078
079        /**
080         * デフォルトコンストラクター
081         *
082         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
083         */
084        public Query_JDBCPLSQL() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
085
086        /**
087         * 引数配列付のクエリーを実行します。
088         * 処理自体は、#execute() と同様に、各サブクラスの実装に依存します。
089         * これは、PreparedQuery で使用する引数を配列でセットするものです。
090         * select * from emp where deptno = ? and job = ? などの PreparedQuery の
091         * ? 部分の引数を
092         * 順番にセットしていきます。
093         *
094         * ※ 8.5.6.1 (2024/03/29)
095         *    Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
096         *
097         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
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 4.0.0.0 (2005/01/31) 引数をすべて受け取って実行するメソッドを標準メソッドとして追加
102         * @og.rev 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
103         * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。
104         * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。
105         * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。
106         * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
107         *
108         * @param       names           カラム名(CSV形式)
109         * @param       dbArrayType     アレイタイプ名称
110         * @param       sysArg          DBSysArg配列
111         * @param       userArg         DBUserArg配列
112         */
113        @Override
114        public void execute( final String names,final String dbArrayType,
115                                                        final DBSysArg[] sysArg,final DBUserArg[] userArg ) {
116                final ExceptionBiConsumer<CallableStatement,Connection> biConsumer = (callStmt,conn) -> {
117                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm
118                        final Array newArray2 = ((OracleConnection)conn).createOracleArray( SYSARG_ARRAY, sysArg );                     // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
119
120                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm
121                        final Array newArray = ((OracleConnection)conn).createOracleArray( dbArrayType, userArg );                      // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
122
123                        callStmt.registerOutParameter(1, Types.INTEGER);
124                        callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);            // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
125                        callStmt.setString( 3,names );
126                        callStmt.setArray( 4,newArray2 );                                                                       // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
127                        callStmt.setArray( 5,newArray );                                                                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
128                };
129
130                execute( biConsumer, getClass().getSimpleName() );
131        }
132
133//      /**
134//       * 引数配列付のクエリーを実行します。
135//       * 処理自体は、#execute() と同様に、各サブクラスの実装に依存します。
136//       * これは、PreparedQuery で使用する引数を配列でセットするものです。
137//       * select * from emp where deptno = ? and job = ? などの PreparedQuery の
138//       * ? 部分の引数を
139//       * 順番にセットしていきます。
140//       *
141//       * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
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 4.0.0.0 (2005/01/31) 引数をすべて受け取って実行するメソッドを標準メソッドとして追加
146//       * @og.rev 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
147//       * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。
148//       * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。
149//       * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。
150//       * @og.rev 8.5.6.1 (2024/03/29) Oracle関係のPL/SQLなどを処理する execute(ExceptionBiConsumer) を使用します。
151//       *
152//       * @param       names           カラム名(CSV形式)
153//       * @param       dbArrayType     アレイタイプ名称
154//       * @param       sysArg          DBSysArg配列
155//       * @param       userArg         DBUserArg配列
156//       */
157//      @Override
158//      public void execute( final String names,final String dbArrayType,
159//                                                      final DBSysArg[] sysArg,final DBUserArg[] userArg ) {
160//                      final Connection conn = getConnection();
161//              // 6.4.2.1 (2016/02/05) try-with-resources 文
162//              try( CallableStatement callStmt = conn.prepareCall( getStatement() ) ) {
163//                      callStmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
164//                      callStmt.setFetchSize( DB_FETCH_SIZE );                 // 6.9.3.0 (2018/03/26)
165//
166//                      final Map<String,Class<?>> map = conn.getTypeMap();
167//                      map.put( ERR_MSG,DBErrMsg.class );      // 4.0.0 (2005/01/31)
168//
169//                      // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm
170//                      final Array newArray2 = ((OracleConnection)conn).createOracleArray( SYSARG_ARRAY, sysArg );                     // 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 = ((OracleConnection)conn).createOracleArray( dbArrayType, userArg );                      // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
174//
175//                      callStmt.registerOutParameter(1, Types.INTEGER);
176//                      callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);            // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
177//                      callStmt.setString( 3,names );
178//                      callStmt.setArray( 4,newArray2 );                                                                       // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
179//                      callStmt.setArray( 5,newArray );                                                                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
180//
181//                      callStmt.execute();
182//
183//                      final int rtnCode = callStmt.getInt(1);
184//                      setErrorCode( rtnCode );
185//                      if( rtnCode > ErrorMessage.OK ) {               // 正常以外の場合
186//                              final ErrorMessage errMessage = new ErrorMessage( "Query_JDBCPLSQL Error!!" );
187//                              final Array rtn3 = callStmt.getArray(2);                                                // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
188//                              // 8.5.4.2 (2024/01/12) PMD 7.0.0 ForLoopCanBeForeach
189////                            final Object[] rtnval3 = (Object[])rtn3.getArray();
190////                            for( int i=0; i<rtnval3.length; i++ ) {
191////                                    final DBErrMsg er = (DBErrMsg)rtnval3[i];
192//                              for( final Object rtnval : (Object[])rtn3.getArray() ) {
193//                                      final DBErrMsg er = (DBErrMsg)rtnval;
194//                                      if( er == null ) { break; }
195//                                      errMessage.addMessage( er.getErrMsg() );
196//                              }
197//                              setErrorMessage( errMessage );
198//                      }
199//              }
200//              catch( final SQLException ex) {         // catch は、close() されてから呼ばれます。
201//                      setErrorCode( ErrorMessage.EXCEPTION );
202//                      final String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR
203//                                              + getStatement() + CR;
204//                      throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
205//              }
206//      }
207}