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.ResultSet;
019import java.sql.SQLException;
020import java.sql.Statement;
021
022import org.opengion.fukurou.util.ErrorMessage;
023import org.opengion.hayabusa.common.HybsSystemException;
024import org.opengion.hayabusa.db.AbstractQuery;
025
026/**
027 * 指定のSQL文を実行して、検索する Query クラスです。
028 *
029 * java.sql.Statement を用いて、データベース検索処理を行います。
030 * 引数は無しです。(与えられたSQL文を実行します。)
031 * 内部変数の受け渡しのデフォルト実装は、AbstractQuery クラスを継承している
032 * ため、ここでは、execute() メソッドを実装しています。
033 * このクラスでは、ステートメント文を execute() する事により、データベースを
034 * 検索した結果を DBTableModel に割り当てます。
035 *
036 * @og.formSample
037 * <og:query command="{@command}" debug="false">
038 *     <!-- 先頭のカラム名が、"WRITABLE" の場合、'true' or '1' で、書き込み許可が与えら、'2' でチェック済みになります。-->
039 *         select KBSAKU AS WRITABLE,
040 *                 CLM,NAME_JA,LABEL_NAME,KBSAKU,SYSTEM_ID,LANG,FGJ
041 *         from GE41
042 *     <og:where>
043 *         <og:and value = "FGJ         in  ('0','1')"         />
044 *         <og:and value = "SYSTEM_ID   like '{@SYSTEM_ID}%'"  />
045 *         <og:and value = "LANG        like '{@LANG}%'"       />
046 *         <og:and value = "CLM         like '{@CLM}%'"        />
047 *         <og:and value = "KBSAKU      =    '{@KBSAKU}'"      />
048 *     </og:where>
049 *     <og:appear startKey = "order by" value = "{@ORDER_BY}"
050 *                 defaultVal = "SYSTEM_ID,CLM,LANG" />
051 * </og:query>
052 *
053 * @og.group データ表示
054 * @og.group データ編集
055 *
056 * @version  4.0
057 * @author   Kazuhiko Hasegawa
058 * @since    JDK5.0,
059 */
060public class Query_JDBC extends AbstractQuery {
061        /** このプログラムのVERSION文字列を設定します。   {@value} */
062        private static final String VERSION = "6.9.3.0 (2018/03/26)" ;
063
064        /**
065         * デフォルトコンストラクター
066         *
067         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
068         */
069        public Query_JDBC() { super(); }                // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
070
071        /**
072         * クエリーを実行します。
073         * セットされているステートメント文字列とそのタイプが合っていない場合は、
074         * エラーになります。
075         * 実行結果は、DBTableModel にセットされます。
076         *
077         * ※ 6.1.1.0 (2015/01/17) 引数のargsは使いません。
078         *
079         * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ＋Queryに変更します。
080         * @og.rev 6.1.1.0 (2015/01/17) 引数配列を可変引数にして、execute() を含めて定義します。
081         * @og.rev 6.3.6.1 (2015/08/28) close(),realClose() 廃止。Queryはキャッシュしません。
082         * @og.rev 6.4.2.1 (2016/02/05) try-with-resources 文で記述。
083         * @og.rev 6.9.3.0 (2018/03/26) DB_FETCH_SIZE追加。
084         *
085         * @param   args オブジェクトの引数配列(可変長引数)…ここでは使いません。
086         */
087        @Override
088        public void execute( final String... args ) {                   // 6.1.1.0 (2015/01/17) refactoring
089                // 6.4.2.1 (2016/02/05) try-with-resources 文
090                try( Statement stmt = getConnection().createStatement() ) {
091                        stmt.setQueryTimeout( DB_MAX_QUERY_TIMEOUT );
092                        stmt.setFetchSize( DB_FETCH_SIZE );                             // 6.9.3.0 (2018/03/26)
093
094                        final boolean status = stmt.execute( getStatement() );
095
096                        if( status ) {
097                                // 6.4.2.1 (2016/02/05) try-with-resources 文
098                                try( ResultSet resultSet = stmt.getResultSet() ) {
099                                        createTableModel( resultSet );
100                                        setUpdateFlag( false );
101                                }
102                        }
103                        else {
104                                setExecuteCount( stmt.getUpdateCount() );
105                        }
106                        setErrorCode( ErrorMessage.OK );
107                }
108                catch( final SQLException ex ) {                // catch は、close() されてから呼ばれます。
109                        setErrorCode( ErrorMessage.EXCEPTION );
110                        final String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR
111                                                + getStatement() + CR;
112                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
113                }
114        }
115}