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.db.AbstractQuery;
019import org.opengion.hayabusa.db.DBErrMsg;
020import org.opengion.hayabusa.common.HybsSystem;
021import org.opengion.hayabusa.common.HybsSystemException;
022import org.opengion.fukurou.util.ErrorMessage;
023import org.opengion.fukurou.util.StringUtil;
024import org.opengion.fukurou.util.Closer;
025
026import java.sql.Types;
027import java.sql.Connection;
028import java.sql.CallableStatement;
029import java.sql.SQLException;
030import java.sql.Array;                                                          // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応。oracle.sql.ARRAY の置き換え
031// import oracle.sql.ARRAY;                                                     // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応
032// import oracle.sql.ArrayDescriptor;                           // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応
033import oracle.jdbc.OracleConnection;                            // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応
034
035// import oracle.jdbc.OracleTypes;                                      // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応。oracle.sql.Types の置き換え
036// import oracle.jdbc.OracleCallableStatement;          // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ) 対応
037
038import java.util.Map;
039
040/**
041 * PL/SQL にエントリ情報を配列渡しする、Query 実行クラスです。
042 *
043 * java.sql.CallableStatement を用いて、データベース登録処理を行います。
044 * 引数に、キーと値をセットで配列指定で渡すことが出来,エラー時には、
045 * DBErrMsg オブジェクトにエラー情報を格納して返すことが可能です。
046 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している
047 * ため,ここでは、execute() メソッドを実装しています。
048 * このクラスでは、ステートメント文を execute() する事により,データベースを
049 * 検索した結果を DBTableModel に割り当てます。
050 *
051 * @og.formSample
052 * 例:
053 *     第一引数、第二引数は、結果(KEKKA)とエラーメッセージ配列を返します。
054 *     キーエントリでは、エントリ(リクエスト情報)のキーと値をセットで
055 *     引数の配列に設定します。
056 *     キーを元に、値を利用する場合に使用します。
057 *     下記の例は、動的カラムを実現しているPL/SQLの例です。
058 *
059 * <og:entryQuery
060 *     command    = "NEW"
061 *     queryType  = "JDBCKeyEntry" >
062 *         { call DYNAMIC_PKG.DYNAMIC_TEST( ?,?,?,? ) }
063 * </og:entryQuery>
064 *
065 *    CREATE OR REPLACE PACKAGE DYNAMIC_PKG AS
066 *        PROCEDURE DYNAMIC_TEST(
067 *            P_KEKKA       OUT    NUMBER,
068 *            P_ERRMSGS     OUT    ERR_MSG_ARRAY,
069 *            P_KEYS        IN     ARG_ARRAY,
070 *            P_ARGS        IN     ARG_ARRAY );
071 *    END;
072 *
073 * @og.group データ編集
074 *
075 * @version  4.0
076 * @author   Kazuhiko Hasegawa
077 * @since    JDK5.0,
078 */
079public class Query_JDBCKeyEntry extends AbstractQuery {
080        //* このプログラムのVERSION文字列を設定します。   {@value} */
081        private static final String VERSION = "6.0.0.0 (2014/04/11)" ;
082
083        /**
084         * 引数配列付のクエリーを実行します。
085         * 処理自体は, #execute() と同様に、各サブクラスの実装に依存します。
086         * これは、PreparedQuery で使用する引数を配列でセットするものです。
087         * select * from emp where deptno = ? and job = ? などの PreparedQuery の
088         * ? 部分の引数を
089         * 順番にセットしていきます。
090         *
091         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
092         * @og.rev 3.3.3.1 (2003/07/18) DB登録時の後ろスペースを削除する。
093         * @og.rev 3.5.2.0 (2003/10/20) 内部オブジェクトタイプ名を システムパラメータ で定義します。
094         * @og.rev 3.5.6.0 (2004/06/18) nullに対する無駄な比較を削除します。
095         * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ+Queryに変更します。
096         * @og.rev 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
097         *
098         * @param   keys オブジェクトのキー配列
099         * @param   args オブジェクトの引数配列
100         */
101        @Override
102        public void execute( final String[] keys, final String[] args ) {
103                CallableStatement callStmt = null ;
104                try {
105                        Connection conn = getConnection();
106                        callStmt  = getConnection().prepareCall( getStatement() );
107                        callStmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
108                        Map<String,Class<?>> map = conn.getTypeMap();
109                        map.put( ERR_MSG,DBErrMsg.class );      // 4.0.0 (2005/01/31)
110
111                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm
112//                      ArrayDescriptor sd_key = ArrayDescriptor.createDescriptor( ARG_ARRAY, conn );
113//                      ARRAY newArray_key = new ARRAY( sd_key,conn,keys );
114                        Array newArray_key = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, keys );             // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
115
116                        // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm
117//                      ArrayDescriptor sd_val = ArrayDescriptor.createDescriptor( ARG_ARRAY, conn );
118//                      ARRAY newArray_val = new ARRAY( sd_val,conn,StringUtil.rTrims( args ) );
119                        Array newArray_val = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, StringUtil.rTrims( args ));         // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
120
121                        callStmt.registerOutParameter(1, Types.INTEGER);
122//                      callStmt.registerOutParameter(2, OracleTypes.ARRAY,ERR_MSG_ARRAY);                      // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
123                        callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);                            // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
124//                      ((OracleCallableStatement)callStmt).setARRAY( 3,newArray_key );                         // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
125//                      ((OracleCallableStatement)callStmt).setARRAY( 4,newArray_val );                         // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
126                        callStmt.setArray( 3,newArray_key );                                                                            // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
127                        callStmt.setArray( 4,newArray_val );                                                                            // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
128
129                        callStmt.execute();
130
131                        int rtnCode = callStmt.getInt(1);
132                        setErrorCode( rtnCode );
133                        if( rtnCode > ErrorMessage.OK ) {               // 正常以外の場合
134//                              ARRAY rtn3 = ((OracleCallableStatement)callStmt).getARRAY(2);                   // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
135                                Array rtn3 = callStmt.getArray(2);                                                                              // 6.0.0.0 (2014/04/11) Oracle11g(11.2.0.3のドライバ)対応
136                                Object[] rtnval3 = (Object[])rtn3.getArray();
137                                ErrorMessage errMessage = new ErrorMessage( "Query_JDBCKeyEntry Error!!" );
138                                for( int i=0; i<rtnval3.length; i++ ) {
139                                        DBErrMsg er = (DBErrMsg)rtnval3[i];
140                                        if( er == null ) { break; }
141                                        errMessage.addMessage( er.getErrMsg() );
142                                }
143                                setErrorMessage( errMessage );
144                        }
145                }
146                catch (SQLException ex) {
147                        setErrorCode( ErrorMessage.EXCEPTION );
148                        String errMsg = ex.getMessage() + ":" + ex.getSQLState() + HybsSystem.CR
149                                                + getStatement() + HybsSystem.CR ;
150                        rollback();
151                        realClose();
152                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
153                }
154                finally {
155                        Closer.stmtClose( callStmt );
156                }
157        }
158}