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