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.Connection;
027import java.sql.CallableStatement;
028import java.sql.ResultSet;
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のドライバ) 対応
033import oracle.sql.ArrayDescriptor;                                      // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応
034import oracle.jdbc.OracleConnection;                            // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ) 対応
035
036import oracle.jdbc.OracleTypes;                                         // CURSOR が残る
037import oracle.jdbc.OracleCallableStatement;                     // CURSOR が残る
038
039import java.util.Map;
040
041/**
042 * エントリ系 PL/SQL をコールして、結果カーソルから、DBTableModel を作成します。
043 *
044 * java.sql.CallableStatement を用いて、データベース検索処理を行います。
045 * 引数を配列指定で渡すことが出来,エラー時には、DBErrMsg オブジェクトにエラー情報を
046 * 格納して返すことが可能です。
047 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している
048 * ため,ここでは、execute() メソッドを実装しています。
049 * このクラスでは、ステートメント文を execute() する事により,データベースを
050 * 検索した結果を DBTableModel に割り当てます。
051 *
052 * @og.formSample
053 * 例:jsp/TYPESB/result.jsp  (検索系:カーソル返し)
054 * 例:jsp/TYPE3B/entry.jsp   (エントリ系)
055 *     names には、ARG_ARRAY 配列に順次セットされます。
056 *     使用する場合は、一旦わかり易い変数に受けて利用してください。
057 *     呼び出す PL/SQL では、検索系PL/SQL です。(下記の例は、エントリ系)
058 *
059 * <og:query
060 *     command    = "NEW"
061 *     names      = "SYSTEM_ID,LANG,CLM,NAME_JA,LABEL_NAME,KBSAKU,USER.ID"
062 *     queryType  = "JDBCErrMsg"
063 *     displayMsg = "" >
064 *        {call TYPE3B01.TYPE3B01(?,?,?,?)}
065 * </og:query>
066 *
067 *    CREATE OR REPLACE PACKAGE TYPE3B01 AS
068 *        TYPE CUST_CURSOR IS REF CURSOR;
069 *        PROCEDURE TYPE3B01(
070 *            P_KEKKA      OUT    NUMBER,
071 *            P_ERRMSGS    OUT    ERR_MSG_ARRAY,
072 *            P_RC1        OUT    CUST_CURSOR,
073 *            P_ARGS       IN     ARG_ARRAY     );
074 *    END;
075 *
076 *     P_SYSTEM_ID     GEA08.SYSTEM_ID%TYPE     := P_ARGS(1);    --システムID
077 *     P_LANG          GEA08.LANG%TYPE          := P_ARGS(2);    --言語
078 *     P_CLM           GEA08.CLM%TYPE           := P_ARGS(3);    --項目
079 *     P_NAME_JA       GEA08.NAME_JA%TYPE       := P_ARGS(4);    --名称(漢字)
080 *     P_LABEL_NAME    GEA08.LABEL_NAME%TYPE    := P_ARGS(5);    --表示名称
081 *     P_KBSAKU        GEA08.KBSAKU%TYPE        := P_ARGS(6);    --作成区分
082 *     P_USRSET        GEA08.USRSET%TYPE        := P_ARGS(7);    --登録者
083 *
084 * @og.group データ表示
085 * @og.group データ編集
086 *
087 * @version  4.0
088 * @author   Kazuhiko Hasegawa
089 * @since    JDK5.0,
090 */
091public class Query_JDBCErrMsg extends AbstractQuery {
092        //* このプログラムのVERSION文字列を設定します。   {@value} */
093        private static final String VERSION = "5.7.2.3 (2014/01/31)" ;
094
095        /**
096         * クエリーを実行します。
097         * 実行方法等は各サブクラスの実装に依存します。
098         * セットされているステートメント文字列とそのタイプが合っていない場合は,
099         * エラーになります。
100         * 実行結果は、DBTableModel にセットされます。
101         * 実行結果の件数は #getExecuteCount() で取得できます。
102         *
103         */
104        @Override
105        public void execute() {
106                execute( null );
107        }
108
109        /**
110         * 引数配列付のクエリーを実行します。
111         * 処理自体は, #execute() と同様に、各サブクラスの実装に依存します。
112         * これは、CallableStatement を用いて、データベース検索処理を行います。
113         * {call TYPE3B01.TYPE3B01(?,?,?,?)} で、4番目の引数には、
114         * names で指定したリクエスト情報が、ARG_ARRAY 配列に順次セットされます。
115         * 使用する場合は、一旦わかり易い変数に受けて利用してください。
116         * 呼び出す PL/SQL では、検索系PL/SQL です。
117         *
118         * @og.rev 2.3.1.3 (2003/01/28) Open Cursor が、大量に残る件の対応。ResultSet を close()
119         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
120         * @og.rev 3.3.3.1 (2003/07/18) DB登録時の後ろスペースを削除する。
121         * @og.rev 3.5.2.0 (2003/10/20) 内部オブジェクトタイプ名を システムパラメータ で定義します。
122         * @og.rev 3.5.6.0 (2004/06/18) nullに対する無駄な比較を削除します。
123         * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ+Queryに変更します。
124         * @og.rev 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
125         * @og.rev 5.7.2.3 (2014/01/31) Oracle11g(11.2.0.3のドライバ)対応は、Ver5 では行わない(戻す)。
126         *
127         * @param   args オブジェクトの引数配列
128         */
129        @Override
130        public void execute( final String[] args ) {
131                CallableStatement callStmt = null ;
132                ResultSet resultSet = null ;
133                try {
134                        Connection conn = getConnection();
135                        callStmt  = getConnection().prepareCall( getStatement() );
136                        callStmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
137                        Map<String,Class<?>> map = conn.getTypeMap();
138                        map.put( ERR_MSG,DBErrMsg.class );      // 4.0.0 (2005/01/31)
139
140                        // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応 http://docs.oracle.com/cd/E28389_01/web.1111/b60995/thirdparty.htm
141                        ArrayDescriptor sd = ArrayDescriptor.createDescriptor( ARG_ARRAY, conn );
142                        ARRAY newArray = new ARRAY( sd,conn,StringUtil.rTrims( args ) );
143//                      Array newArray = ((OracleConnection)conn).createOracleArray( ARG_ARRAY, StringUtil.rTrims( args ));             // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
144
145                        callStmt.registerOutParameter(1, Types.INTEGER);
146                        callStmt.registerOutParameter(2, OracleTypes.ARRAY,ERR_MSG_ARRAY);              // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
147//                      callStmt.registerOutParameter(2, Types.ARRAY,ERR_MSG_ARRAY);                    // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
148                        callStmt.registerOutParameter(3, OracleTypes.CURSOR);
149                        ((OracleCallableStatement)callStmt).setARRAY( 4,newArray );                             // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
150//                      callStmt.setArray( 4,newArray );                                                                                // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
151
152                        callStmt.execute();
153
154                        int rtnCode = callStmt.getInt(1);
155                        setErrorCode( rtnCode );
156                        if( rtnCode < ErrorMessage.NG ) {            // 異常以外の場合
157                                resultSet = ((OracleCallableStatement)callStmt).getCursor(3);
158                                createTableModel( resultSet );
159                        }
160                        if( rtnCode > ErrorMessage.OK ) {            // 正常以外の場合
161                                ARRAY rtn3 = ((OracleCallableStatement)callStmt).getARRAY(2);           // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
162//                              Array rtn3 = callStmt.getArray(2);                                                                      // 5.7.2.2 (2014/01/24) Oracle11g(11.2.0.3のドライバ)対応
163                                Object[] rtnval3 = (Object[])rtn3.getArray();
164                                ErrorMessage errMessage = new ErrorMessage( "Query_JDBCErrMsg Error!!" );
165                                for( int i=0; i<rtnval3.length; i++ ) {
166                                        DBErrMsg er = (DBErrMsg)rtnval3[i];
167                                        if( er == null ) { break; }
168                                        errMessage.addMessage( er.getErrMsg() );
169                                }
170                                setErrorMessage( errMessage );
171                        }
172                }
173                catch (SQLException ex) {
174                        setErrorCode( ErrorMessage.EXCEPTION );
175                        String errMsg = ex.getMessage() + ":" + ex.getSQLState() + HybsSystem.CR
176                                                + getStatement() + HybsSystem.CR;
177                        rollback();
178                        realClose();
179                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
180                }
181                finally {
182                        Closer.resultClose( resultSet );
183                        Closer.stmtClose( callStmt );
184                }
185        }
186}