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.PreparedStatement;
020// import java.sql.ParameterMetaData;
021import java.sql.SQLException;
022
023import org.opengion.hayabusa.db.AbstractQuery;
024import org.opengion.hayabusa.db.DBTableModel;
025import org.opengion.hayabusa.common.HybsSystemException;
026import org.opengion.fukurou.util.ErrorMessage;
027import org.opengion.fukurou.util.StringUtil;
028// import org.opengion.fukurou.util.HybsDateUtil;                       // 5.5.8.5 (2012/11/27)
029import org.opengion.fukurou.model.Formatter;
030import org.opengion.fukurou.db.DBUpdater;                               // 6.9.3.0 (2018/03/26)
031
032/**
033 * 引数引き当て(PreparedStatement) を利用した登録系Queryです。
034 *
035 * java.sql.PreparedStatement を用いて、データベース登録処理を行います。
036 * 引数の指定方法は、DBTableModele のカラム名に対応する名称を、SQL文の[カラム名]形式で
037 * 記述します。これを解析して、実際に実行する PreparedStatement に対応する文字列を
038 * 作成します。
039 * たとえば、INSERT INTO GEXX (CLM,NAME_JA,LABEL_NAME) VALUES ([CLM],[NAME_JA],[LABEL_NAME] )
040 * と記述すれば、内部で、DBTableModele のカラム名に対応する値を取り出し、SQL文として、
041 * INSERT INTO GEXX (CLM,NAME_JA,LABEL_NAME) VALUES (?,?,? ) を実行します。
042 *
043 * @og.formSample
044 * ●使用例
045 *
046 *    ・QUERYを直接書く場合
047 *    【entry.jsp】
048 *        <og:tableUpdate
049 *            command   = "{@command}"
050 *            queryType = "JDBCTableUpdate"
051 *        >
052 *            INSERT INTO GE41
053 *                (CLM,NAME_JA,LABEL_NAME,KBSAKU,SYSTEM_ID,LANG,
054 *                 FGJ,DYSET,DYUPD,USRSET,USRUPD,PGUPD)
055 *            VALUES
056 *                ([CLM],[NAME_JA],[LABEL_NAME],[KBSAKU],[SYSTEM_ID],[LANG],
057 *                 '1','{@USER.YMDH}','{@USER.YMDH}','{@USER.ID}','{@USER.ID}','{@GUI.KEY}')
058 *        </og:tableUpdate>
059 *
060 * @og.rev 4.0.0.0 (2005/01/31) 新規作成
061 * @og.group データ編集
062 *
063 * @version  4.0
064 * @author   Kazuhiko Hasegawa
065 * @since    JDK5.0,
066 */
067public class Query_JDBCTableUpdate extends AbstractQuery {
068        /** このプログラムのVERSION文字列を設定します。   {@value} */
069        private static final String VERSION = "7.2.9.1 (2020/10/23)" ;
070
071        /**
072         * デフォルトコンストラクター
073         *
074         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
075         */
076        public Query_JDBCTableUpdate() { super(); }             // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
077
078        /**
079         * 引数配列付のクエリーを実行します。
080         * 処理自体は、#execute() と同様に、各サブクラスの実装に依存します。
081         * これは、PreparedQuery で使用する引数を配列でセットするものです。
082         * select * from emp where deptno = ? and job = ? などの PreparedQuery の
083         * [カラム名] 部分の引数を、DBTableModelから順番にセットしていきます。
084         *
085         * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ+Queryに変更します。
086         * @og.rev 4.0.0.0 (2007/05/09) ParameterMetaData を使用したパラメータ設定追加。
087         * @og.rev 4.0.0.0 (2007/09/25) isOracle から useParamMetaData に変更
088         * @og.rev 5.3.8.0 (2011/08/01) useParamMetaData を ConnectionFactory経由で取得。(PostgreSQL対応)、setNull 対応
089         * @og.rev 5.5.5.4 (2012/08/18) useParamMetaData 処理を、ループの外に出す。(PostgreSQL対応)
090         * @og.rev 5.5.5.4 (2012/08/18) DATE オブジェクトを登録できるようにする。
091         * @og.rev 5.5.8.5 (2012/11/27) TIMESTAMP型でも処理できるようにします。
092         * @og.rev 5.6.9.4 (2013/10/31) エラーメッセージに1行前の情報も出力します。
093         * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。
094         * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。
095         * @og.rev 6.4.3.4 (2016/03/11) Formatterに新しいコンストラクターを追加する。
096         * @og.rev 6.4.4.2 (2016/04/01) contains 判定を行う新しいメソッドを使用します。
097         * @og.rev 6.4.6.0 (2016/05/27) isNumber , isDate 追加。
098         * @og.rev 6.9.3.0 (2018/03/26) DBUpdaterクラスを利用したバッチ更新を追加します。
099         * @og.rev 6.9.8.0 (2018/05/28) エラー時に、わかりやすいように、引数を、パラメータ順にします。
100         * @og.rev 7.2.9.1 (2020/10/23) isTimeのメソッドを統合します。
101         *
102         * @param   rowNo 選択された行番号配列(登録する対象行)
103         * @param   table DBTableModelオブジェクト(登録する元データ)
104         */
105        @Override
106        public void execute( final int[] rowNo, final DBTableModel table ) {
107
108                int row = 0;                    // エラー時に表示するエラー行番号
109                int executeCount = 0;   // 処理件数
110                final Formatter form = new Formatter( table,getStatement() );   // 6.4.3.4 (2016/03/11)
111                final int[] clmNos = form.getClmNos();          // 引数の個数分の配列。カラム番号を保存
112                final String query = form.getQueryFormatString();
113                final int    cnt   = clmNos.length;                     // 引数の個数(カラムの個数ではありません。)
114
115                // 5.5.5.4 (2012/08/18) Timestamp オブジェクトを登録できるようにする。
116                boolean useTimeStamp = false;
117                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
118
119                // 8.5.4.2 (2024/01/12) PMD 7.0.0 LinguisticNaming
120//              final boolean[] isTime = new boolean[cnt];
121                final boolean[] timeClms = new boolean[cnt];
122                for( int j=0; j<cnt; j++ ) {
123                        // 5.5.8.5 (2012/11/27) TIMESTAMP型でも処理できるようにします。
124                        // 6.4.4.2 (2016/04/01) contains 判定を行う新しいメソッドを使用します。
125                        // 8.5.4.2 (2024/01/12) PMD 7.0.0 LinguisticNaming
126//                      isTime[j] = table.getDBColumn( clmNos[j] ).isDateType();        // 6.4.6.0 (2016/05/27)
127//                      if( !useTimeStamp && isTime[j] ) { useTimeStamp = true; }       // isTime[j] == true 時に、一度だけ実行される。
128                        timeClms[j] = table.getDBColumn( clmNos[j] ).isDateType();      // 6.4.6.0 (2016/05/27)
129                        if( !useTimeStamp && timeClms[j] ) { useTimeStamp = true; }     // timeClms[j] == true 時に、一度だけ実行される。
130                }
131
132                // 6.9.8.0 (2018/05/28) エラー時に、わかりやすいように、引数を、パラメータ順にします。
133                final String[] vals = new String[cnt];
134
135                // 6.4.2.1 (2016/02/05) try-with-resources 文
136                final Connection conn = getConnection();
137                try( PreparedStatement pstmt = conn.prepareStatement( query ) ) {               // 更新系なので、setFetchSize は不要。
138                        pstmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
139                //      ((oracle.jdbc.OraclePreparedStatement)pstmt).setExecuteBatch(50);
140                        // 4.0.0.0 (2007/09/25) isOracle から usePMeta に変更
141                        final boolean usePMeta = useParameterMetaData();                                        // 5.3.8.0 (2011/08/01)
142
143                        // 8.5.4.2 (2024/01/12) PMD 7.0.0 LinguisticNaming
144//                      final DBUpdater dbUpper = new DBUpdater( cnt,pstmt,usePMeta,useTimeStamp ? isTime : null );             // 7.2.9.1 (2020/10/23)
145                        final DBUpdater dbUpper = new DBUpdater( cnt,pstmt,usePMeta,useTimeStamp ? timeClms : null );   // 7.2.9.1 (2020/10/23)
146
147                        // 8.5.4.2 (2024/01/12) PMD 7.0.0 ForLoopCanBeForeach
148//                      for( int i=0; i<rowNo.length; i++ ) {
149//                              row = rowNo[i];
150                        for( final int tmp : rowNo ) {
151                                row = tmp;
152                                final String[] data = table.getValues( row );
153                                for( int j=0; j<cnt; j++ ) {
154                                        vals[j] = StringUtil.rTrim( data[ clmNos[j] ] );
155                                }
156
157                                dbUpper.execute( vals );
158                        }
159
160                        executeCount = dbUpper.execEnd();
161
162                        setExecuteCount( executeCount );
163                        setErrorCode( ErrorMessage.OK );
164                }
165                catch( final SQLException ex) {         // catch は、close() されてから呼ばれます。
166                        setErrorCode( ErrorMessage.EXCEPTION );
167                        final StringBuilder errMsg = new StringBuilder( BUFFER_MIDDLE )
168                                .append( ex.getMessage() ).append( ':' ).append( ex.getSQLState() ).append( CR )
169                                .append( "  QUERY=" ).append( getStatement() ).append( CR )
170                                .append( "  ROW =[" ).append( row+1 ).append( ']' ).append( CR )
171                                // 6.9.8.0 (2018/05/28) エラー時に、わかりやすいように、引数を、パラメータ順にします。
172                                .append( "  VALS=[" ).append( StringUtil.array2csv( vals )).append( ']' )       // 6.9.8.0 (2018/05/28)
173                                .append( CR ) ;
174                        // 5.6.9.4 (2013/10/31)
175                        if( row > 0 ) {
176                                // 6.9.8.0 (2018/05/28) エラー時に、わかりやすいように、引数を、パラメータ順にします。
177                                for( int j=0; j<cnt; j++ ) {
178                                        vals[j] = StringUtil.rTrim( table.getValue( row-1,clmNos[j] ) );
179                                }
180
181                                errMsg.append("  ROW(-1) =[" ).append( row ).append( ']' ).append( CR )         // 6.3.9.0 (2015/11/06) This statement may have some unnecessary parentheses(PMD)
182                                        .append(  "  VALS(-1)=[" ).append( StringUtil.array2csv( vals )).append( ']' )  // 6.9.8.0 (2018/05/28)
183                                        .append( CR ) ;
184                        }
185                        throw new HybsSystemException( errMsg.toString(),ex );          // 3.5.5.4 (2004/04/15) 引数の並び順変更
186                }
187        }
188}