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 org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.hayabusa.common.HybsSystemException;
020import org.opengion.hayabusa.db.AbstractQuery;
021import org.opengion.hayabusa.db.DBErrMsg;
022import org.opengion.fukurou.util.ErrorMessage;
023import org.opengion.fukurou.util.StringUtil;
024import org.opengion.fukurou.util.Closer;
025
026import java.util.Map;
027import java.sql.CallableStatement;
028import java.sql.Connection;
029import java.sql.SQLException;
030import java.sql.Types;
031// import java.sql.Array;                                               // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応。oracle.sql.ARRAY の置き換え
032import oracle.sql.ARRAY;                                                // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応。oracle.sql.ARRAY の置き換え
033import oracle.jdbc.OracleTypes;                                 // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応。java.sql.Types の置き換え
034import oracle.sql.ArrayDescriptor;                                      // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応
035
036import oracle.jdbc.OracleCallableStatement;             // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応
037
038/**
039 * Callableのエラー配列対応版です。バッチ系標準のPL/SQL をコールする Query クラスです。
040 *
041 * java.sql.CallableStatement を用いて、データベース検索処理を行います。
042 * 引数は、従来のPL/SQLの実行が可能なように、第一引数はエラーコード、第二引数は、
043 * エラーメッセージを返してきます。第三引数以降は、自由に指定できます。
044 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している
045 * ため,ここでは、execute() メソッドを実装しています。
046 *
047 * @og.formSample
048 * 例:
049 *     第一引数、第二引数は、通常のPL/SQLと同じ、結果(STATUS)と
050 *     内容(ERR_CODE)を返します。
051 *     それ以降の引数については、入力(IN)のみですが、自由に設定できます。
052 *     引数に変数を使用する場合は、? 記号を当てはめます。
053 *     第一引数、第二引数は、予約済みですが、それ以降は、好きな位置に割り当てられます。
054 *     names 属性の順番に、値だけがセットされていきます。
055 *     下記の例は、変数の引数は、使用していません。
056 *
057 * <og:query
058 *     command="NEW"
059 *     queryType="JDBCArrayCallable"
060 *     displayMsg="" >
061 *         { call GEP00002.GEP00002( ?,?,'{@GUI.KEY}','{@USER.ID}' ) }
062 * </og:query>
063 *
064 *    CREATE OR REPLACE PACKAGE GEP00002 AS
065 *        PROCEDURE GEP00002(
066 *            P_STATUS    OUT    NUMBER,
067 *            P_ERR_CODE  OUT    ERR_MSG_ARRAY,
068 *            P_MIDDB     IN     VARCHAR2,
069 *            P_USRUPD    IN     VARCHAR2  );
070 *    END;
071 *
072 * @og.group データ表示
073 * @og.group データ編集
074 *
075 * @version  4.0
076 * @author   高橋正和
077 * @since    JDK5.0,
078 */
079public class Query_JDBCArrayCallable extends AbstractQuery {
080        //* このプログラムのVERSION文字列を設定します。   {@value} */
081        private static final String VERSION = "5.7.2.3 (2014/01/31)" ;
082
083        /**
084         * クエリーを実行します。
085         * セットされているステートメント文字列とそのタイプが合っていない場合は,
086         * エラーになります。
087         * 実行結果は、DBTableModel にセットされます。
088         *
089         */
090        @Override
091        public void execute() {
092                execute( null );
093        }
094
095        /**
096         * 引数配列付のクエリーを実行します。
097         * 処理自体は, #execute() と同様に、各サブクラスの実装に依存します。
098         * これは、PreparedQuery で使用する引数を配列でセットするものです。
099         * select * from emp where deptno = ? and job = ? などの PreparedQuery の
100         * ? 部分の引数を
101         * 順番にセットしていきます。
102         *
103         * @og.rev 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
104         * @og.rev 5.7.2.3 (2014/01/31) Oracle11g(11.2.0.3のドライバ)対応は、Ver5 では行わない(戻す)。
105         *
106         * @param   args オブジェクトの引数配列
107         */
108        @Override
109        public void execute( final String[] args ) {
110                CallableStatement callStmt = null ;
111                try {
112                        Connection conn = getConnection();
113                        callStmt  = getConnection().prepareCall( getStatement() );
114                        callStmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
115                        Map<String,Class<?>> map = conn.getTypeMap();
116                        map.put( ERR_MSG,DBErrMsg.class );
117
118                        // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
119                        ArrayDescriptor sd = ArrayDescriptor.createDescriptor( ARG_ARRAY, conn );
120                        callStmt.registerOutParameter(1, Types.INTEGER);
121                        callStmt.registerOutParameter(2, OracleTypes.ARRAY,ERR_MSG_ARRAY);
122//                      callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);
123                        if( args != null ) {
124                                for( int i=0; i<args.length; i++ ) {
125                                        callStmt.setObject( i+3,StringUtil.rTrim( args[i] ) );
126                                }
127                        }
128                        callStmt.execute();
129
130                        int rtnCode = callStmt.getInt(1);
131                        setErrorCode( rtnCode );
132
133                        if( rtnCode > ErrorMessage.OK ) {            // 正常以外の場合
134                                // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応
135                                ARRAY rtn3 = ((OracleCallableStatement)callStmt).getARRAY(2);
136//                              Array rtn3 = callStmt.getArray(2);
137                                Object[] rtnval3 = (Object[])rtn3.getArray();
138                                ErrorMessage errMessage = new ErrorMessage( "Query_JDBCArrayCallable Error!!" );
139                                for( int i=0; i<rtnval3.length; i++ ) {
140                                        DBErrMsg er = (DBErrMsg)rtnval3[i];
141                                        if( er == null ) { break; }
142                                        errMessage.addMessage( er.getErrMsg() );
143                                }
144                                setErrorMessage( errMessage );
145                        }
146                }
147                catch ( SQLException ex ) {
148                        setErrorCode( ErrorMessage.EXCEPTION );
149                        String errMsg = ex.getMessage() + ":" + ex.getSQLState() + HybsSystem.CR
150                                                + getStatement() + HybsSystem.CR;
151                        rollback();
152                        realClose();
153                        throw new HybsSystemException( errMsg,ex );
154                }
155                finally {
156                        Closer.stmtClose( callStmt );
157                }
158        }
159}