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.fukurou.process;
017
018import org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
019import org.opengion.fukurou.util.Argument;
020import org.opengion.fukurou.util.SystemParameter;
021import org.opengion.fukurou.system.LogWriter;
022
023import org.opengion.fukurou.util.HybsEntry ;
024import org.opengion.fukurou.system.Closer;
025import org.opengion.fukurou.util.StringUtil;            // 5.7.2.3 (2014/01/31)
026import org.opengion.fukurou.db.ConnectionFactory;
027
028import java.util.Map ;
029import java.util.LinkedHashMap ;
030import java.util.Locale ;
031
032import java.sql.Connection;
033import java.sql.Statement;
034import java.sql.ResultSet;
035import java.sql.ResultSetMetaData;
036import java.sql.SQLException;
037
038/**
039 * Process_DBReaderは、データベースから読み取った内容を、LineModel に設定後、
040 * 下流に渡す、FirstProcess インターフェースの実装クラスです。
041 *
042 * データベースから読み取った内容より、LineModelを作成し、下流(プロセス
043 * チェインは、チェインしているため、データは上流から下流へと渡されます。)
044 * に渡します。ここで指定できるのは、検索系SQL のみです。
045 *
046 * データベース接続先等は、ParamProcess のサブクラス(Process_DBParam)に
047 * 設定された接続(Connection)を使用します。
048 *
049 * 引数文字列中にスペースを含む場合は、ダブルコーテーション("") で括って下さい。
050 * 引数文字列の 『=』の前後には、スペースは挟めません。必ず、-key=value の様に
051 * 繋げてください。
052 *
053 * SQL文には、{@DATE.YMDH}等のシステム変数が使用できます。
054 *
055 * @og.formSample
056 *  Process_DBReader -dbid=DBGE -sql="select * from GEA08"
057 *
058 *   [ -dbid=DB接続ID       ] :-dbid=DBGE (例: Process_DBParam の -configFile で指定する DBConfig.xml ファイルで規定)
059 *   [ -sql=検索SQL文       ] :-sql="select * from GEA08"
060 *   [ -sqlFile=検索SQLファイル ] :-sqlFile=select.sql
061 *                                 -sql= を指定しない場合は、ファイルで必ず指定してください。
062 *   [ -sql_XXXX=固定値     ] :-sql_SYSTEM_ID=GE
063 *                                SQL文中の{@XXXX}文字列を指定の固定値で置き換えます。
064 *                                WHERE SYSTEM_ID='{@SYSTEM_ID}' ⇒ WHERE SYSTEM_ID='GE'
065 *   [ -asClms=置換カラム名    ] :-asClms="FGJ:CDJ SEQ123:UNIQ" 元カラム名:新カラム名 のスペース区切り
066 *   [ -fetchSize=1000      ] :フェッチする行数(初期値:1000)
067 *   [ -display=[false/true]] :結果を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])
068 *   [ -debug=[false/true]  ] :デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])
069 *
070 * @version  4.0
071 * @author   Kazuhiko Hasegawa
072 * @since    JDK5.0,
073 */
074public class Process_DBReader extends AbstractProcess implements FirstProcess {
075        private static final String SQL_KEY  = "sql_" ;
076
077        private Connection      connection      ;
078        private Statement       stmt            ;
079        private ResultSet       resultSet       ;
080        private LineModel       newData         ;
081        private int                     count           ;
082        private int                     fetchSize       = 1000;         // 6.9.3.0 (2018/03/26) 初期値を100→1000 に変更
083
084        private String          dbid            ;
085        private boolean         display         ;               // false:表示しない
086        private boolean         debug           ;               // 5.7.3.0 (2014/02/07) デバッグ情報
087
088        /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */
089        private static final Map<String,String> MUST_PROPARTY   ;               // [プロパティ]必須チェック用 Map
090        /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */
091        private static final Map<String,String> USABLE_PROPARTY ;               // [プロパティ]整合性チェック Map
092
093        static {
094                MUST_PROPARTY = new LinkedHashMap<>();
095
096                USABLE_PROPARTY = new LinkedHashMap<>();
097                USABLE_PROPARTY.put( "dbid",    "Process_DBParam の -configFile で指定する DBConfig.xml ファイルで規定" );
098                USABLE_PROPARTY.put( "sql",             "検索SQL文(sql or sqlFile 必須)例: \"select * from GEA08\"" );
099                USABLE_PROPARTY.put( "sqlFile", "検索SQLファイル(sql or sqlFile 必須)例: select.sql" );
100                USABLE_PROPARTY.put( "sql_",            "SQL文中の{&#064;XXXX}文字列を指定の固定値で置き換えます。" +
101                                                                        CR + "WHERE SYSTEM_ID='{&#064;SYSTEM_ID}' ⇒ WHERE SYSTEM_ID='GE'" );
102                // 5.7.2.3 (2014/01/31) asClms 追加
103                USABLE_PROPARTY.put( "asClms",  "元カラム名:新カラム名 のスペース区切りでカラム名の置換を行う" );
104                USABLE_PROPARTY.put( "fetchSize","フェッチする行数 (初期値:1000)" );
105                USABLE_PROPARTY.put( "display", "結果を標準出力に表示する(true)かしない(false)か" +
106                                                                                CR + "(初期値:false:表示しない)" );
107                USABLE_PROPARTY.put( "debug",   "デバッグ情報を標準出力に表示する(true)かしない(false)か" +
108                                                                                CR + "(初期値:false:表示しない)" );             // 5.7.3.0 (2014/02/07) デバッグ情報
109        }
110
111        /**
112         * デフォルトコンストラクター。
113         * このクラスは、動的作成されます。デフォルトコンストラクターで、
114         * super クラスに対して、必要な初期化を行っておきます。
115         *
116         */
117        public Process_DBReader() {
118                super( "org.opengion.fukurou.process.Process_DBReader",MUST_PROPARTY,USABLE_PROPARTY );
119        }
120
121        /**
122         * プロセスの初期化を行います。初めに一度だけ、呼び出されます。
123         * 初期処理(ファイルオープン、DBオープン等)に使用します。
124         *
125         * @og.rev 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
126         * @og.rev 5.7.2.3 (2014/01/31) asClms 追加
127         * @og.rev 6.9.4.1 (2018/04/09) fetchSize 指定を行います。
128         *
129         * @param   paramProcess データベースの接続先情報などを持っているオブジェクト
130         */
131        public void init( final ParamProcess paramProcess ) {
132                final Argument arg = getArgument();
133
134                String sql              = arg.getFileProparty("sql","sqlFile",true);
135
136                // 5.7.2.3 (2014/01/31) asClms 追加
137                final String asClms     = arg.getProparty("asClms");
138
139//              final String fSize      = arg.getProparty("fetchSize");
140                fetchSize               = arg.getProparty( "fetchSize"  , fetchSize     );              // 6.9.4.1 (2018/04/09) fetchSize 指定
141                display                 = arg.getProparty( "display"    ,display        );
142                debug                   = arg.getProparty( "debug"              ,debug          );              // 5.7.3.0 (2014/02/07) デバッグ情報
143
144                dbid                    = arg.getProparty( "dbid" );
145                connection              = paramProcess.getConnection( dbid );
146
147                // 3.8.0.1 (2005/06/17) SQL文の {@XXXX} 文字列の固定値への置き換え
148                final HybsEntry[] entry =arg.getEntrys(SQL_KEY);                //配列
149                final SystemParameter sysParam = new SystemParameter( sql );
150                sql = sysParam.replace( entry );
151
152//              // fetchSize 指定
153//              if( fSize != null ) { fetchSize = Integer.parseInt( fSize ); }
154
155                try {
156                        stmt = connection.createStatement();
157                        if( fetchSize > 0 ) { stmt.setFetchSize( fetchSize ); }
158                        resultSet = stmt.executeQuery( sql );
159
160                        // 5.7.2.3 (2014/01/31) asClms 処理を追加。
161                        newData = createLineModel( resultSet,asClms );
162
163                        if( display ) { println( newData.nameLine() ); }
164                }
165                catch( final SQLException ex) {
166                        // 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
167                        final String errMsg = "Query の実行に問題があります。" + CR
168                                                                + "errMsg=[" + ex.getMessage() + "]" + CR
169                                                                + "errCode=[" + ex.getErrorCode() + "] State=[" + ex.getSQLState() + "]" + CR
170                                                                + "dbid=[" + dbid + "]" + CR
171                                                                + "sql =[" + sql + "]" ;
172                        throw new OgRuntimeException( errMsg,ex );
173                }
174        }
175
176        /**
177         * プロセスの終了を行います。最後に一度だけ、呼び出されます。
178         * 終了処理(ファイルクローズ、DBクローズ等)に使用します。
179         *
180         * @og.rev 4.0.0.0 (2007/11/27) commit,rollback,remove 処理を追加
181         *
182         * @param   isOK トータルで、OKだったかどうか[true:成功/false:失敗]
183         */
184        public void end( final boolean isOK ) {
185                final boolean flag1 = Closer.resultClose( resultSet );
186                resultSet  = null;
187                final boolean flag2 = Closer.stmtClose( stmt );
188                stmt       = null;
189
190                ConnectionFactory.remove( connection,dbid );
191
192                if( !flag1 || !flag2 ) {
193                        final String errMsg = "ステートメントをクローズ出来ません。";
194                        throw new OgRuntimeException( errMsg );
195                }
196        }
197
198        /**
199         * このデータの処理において、次の処理が出来るかどうかを問い合わせます。
200         * この呼び出し1回毎に、次のデータを取得する準備を行います。
201         *
202         * @og.rev 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
203         *
204         * @return      処理できる:true / 処理できない:false
205         */
206        public boolean next() {
207                try {
208                        return resultSet.next() ;
209                }
210                catch( final SQLException ex) {
211                        final String errMsg = "ネクストすることが出来ません。"
212                                                                + "errMsg=[" + ex.getMessage() + "]" + CR
213                                                                + "errCode=[" + ex.getErrorCode() + "] State=[" + ex.getSQLState() + "]" + CR ;
214                        throw new OgRuntimeException( errMsg,ex );
215                }
216        }
217
218        /**
219         * 最初に、 行データである LineModel を作成します
220         * FirstProcess は、次々と処理をチェインしていく最初の行データを
221         * 作成して、後続の ChainProcess クラスに処理データを渡します。
222         *
223         * @og.rev 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
224         *
225         * @param       rowNo   処理中の行番号
226         *
227         * @return      処理変換後のLineModel
228         */
229        public LineModel makeLineModel( final int rowNo ) {
230                count++ ;
231                try {
232                        for( int clm=0; clm<newData.size(); clm++ ) {
233                                final Object obj = resultSet.getObject(clm+1);
234                                if( obj == null ) {
235                //                      newData.setValue( clm, "" );
236                                        newData.setValue( clm, null );
237                                }
238                                else {
239                                        newData.setValue( clm, obj );
240                                }
241                        }
242                        newData.setRowNo( rowNo );
243                        if( display ) { println( newData.dataLine() ); }
244                }
245                catch( final SQLException ex) {
246                        // 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
247                        final String errMsg = "データを処理できませんでした。[" + rowNo + "]件目 " + CR
248                                        + "errMsg=[" + ex.getMessage() + "]" + CR
249                                        + "errCode=[" + ex.getErrorCode() + "] State=[" + ex.getSQLState() + "]" + CR
250                                        + "dbid=[" + dbid + "]" + CR
251                                        + "data=[" + newData.dataLine() + "]" + CR ;
252                        throw new OgRuntimeException( errMsg,ex );
253                }
254                return newData;
255        }
256
257        /**
258         * 内部で使用する LineModel を作成します。
259         * このクラスは、プロセスチェインの基点となりますので、新規 LineModel を返します。
260         * Exception 以外では、必ず LineModel オブジェクトを返します。
261         * 第2引数は、カラム名の置き換え指示です。null の場合は、何もしません。
262         * 通常は、SELECT CLM1 AS CLM2 FROM *** とする箇所を、CLM1:CLM2 と指定する事で
263         * SELECT CLM1 FROM *** のまま、以降の処理を CLM2 で扱えます。
264         *
265         * @og.rev 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
266         * @og.rev 5.7.2.3 (2014/01/31) asClms 追加
267         *
268         * @param       rs      データベースカーソル(リザルトセット)
269         * @param       asClms  別名カラム指定 (元カラム名:新カラム名 のスペース区切り文字列)
270         *
271         * @return      データベースから取り出して変換した LineModel
272         * @throws RuntimeException カラム名を取得できなかった場合。
273         */
274        private LineModel createLineModel( final ResultSet rs , final String asClms ) {
275                final LineModel model = new LineModel();
276
277                try {
278                        final ResultSetMetaData metaData        = rs.getMetaData();
279
280                        final int size =  metaData.getColumnCount();
281                        model.init( size );
282
283                        for( int clm=0; clm<size; clm++ ) {
284                                String name = metaData.getColumnLabel(clm+1).toUpperCase(Locale.JAPAN) ;
285                                // 5.7.2.3 (2014/01/31) asClms 追加
286                                if( asClms != null ) {
287                                        // asClms の null判定も、toUpperCase 処理も行っているが、判りにくいので。
288                                        name = StringUtil.caseReplace( name,asClms,false );
289                                }
290                                model.setName( clm,name );
291                        }
292                }
293                catch( final SQLException ex) {
294                        // 5.7.2.2 (2014/01/24) SQL実行エラーを少し詳細に出力します。
295                        final String errMsg = "ResultSetMetaData から、カラム名を取得できませんでした。" + CR
296                                                                + "errMsg=[" + ex.getMessage() + "]" + CR
297                                                                + "errCode=[" + ex.getErrorCode() + "] State=[" + ex.getSQLState() + "]" + CR
298                                                                + "dbid=[" + dbid + "]" + CR ;
299                        throw new OgRuntimeException( errMsg,ex );
300                }
301                return model;
302        }
303
304        /**
305         * プロセスの処理結果のレポート表現を返します。
306         * 処理プログラム名、入力件数、出力件数などの情報です。
307         * この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような
308         * 形式で出してください。
309         *
310         * @return   処理結果のレポート
311         * @og.rtnNotNull
312         */
313        public String report() {
314                // 6.0.2.5 (2014/10/31) refactoring
315                return "[" + getClass().getName() + "]" + CR
316                                + TAB + "DBID        : " + dbid + CR
317                                + TAB + "Input Count : " + count ;
318
319        }
320
321        /**
322         * このクラスの使用方法を返します。
323         *
324         * @return      このクラスの使用方法
325         * @og.rtnNotNull
326         */
327        public String usage() {
328                final StringBuilder buf = new StringBuilder( BUFFER_LARGE )
329                        .append( "Process_DBReaderは、データベースから読み取った内容を、LineModel に設定後、"   ).append( CR )
330                        .append( "下流に渡す、FirstProcess インターフェースの実装クラスです。"                                 ).append( CR )
331                        .append( CR )
332                        .append( "データベースから読み取った内容より、LineModelを作成し、下流(プロセス"                      ).append( CR )
333                        .append( "チェインは、チェインしているため、データは上流から下流へと渡されます。)"         ).append( CR )
334                        .append( "に渡します。ここで指定できるのは、検索系SQL のみです。"                                                ).append( CR )
335                        .append( CR )
336                        .append( "データベース接続先等は、ParamProcess のサブクラス(Process_DBParam)に"                    ).append( CR )
337                        .append( "設定された接続(Connection)を使用します。"                                                                           ).append( CR )
338                        .append( CR )
339                        .append( "引数文字列中に空白を含む場合は、ダブルコーテーション(\"\") で括って下さい。"    ).append( CR )
340                        .append( "引数文字列の 『=』の前後には、空白は挟めません。必ず、-key=value の様に"           ).append( CR )
341                        .append( "繋げてください。"                                                                                                                             ).append( CR )
342                        .append( CR )
343                        .append( "SQL文には、{@DATE.YMDH}等のシステム変数が使用できます。"                                          ).append( CR )
344                        .append( CR ).append( CR )
345                        .append( getArgument().usage() ).append( CR );
346
347                return buf.toString();
348        }
349
350        /**
351         * このクラスは、main メソッドから実行できません。
352         *
353         * @param       args    コマンド引数配列
354         */
355        public static void main( final String[] args ) {
356                LogWriter.log( new Process_DBReader().usage() );
357        }
358}