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.hayabusa.resource;
017
018import org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.fukurou.db.ApplicationInfo;
020import org.opengion.fukurou.db.DBUtil;
021// import org.opengion.hayabusa.db.DBColumnConfig;              // 7.0.7.0 (2019/12/13)
022
023import java.util.Map;
024import java.util.WeakHashMap;
025import java.util.Collections ;
026
027/**
028 * systemId に対応したカラムデータを作成するデータロードクラスです。
029 *
030 * カラムデータは、項目(CLM)に対して、各種カラム情報を持っています。
031 * エンジン内部で使用している DBColumn オブジェクトは、RENDERER や EDITOR など
032 * 実際にはオブジェクトで管理していますが、この ColumnData では、それらのキーとなる
033 * 文字列を持っています。実際に DBColumn オブジェクトの構築時に、各属性オブジェクトを
034 * 生成(または、キャッシュから取り出し)ます。
035 *
036 * カラムデータを作成する場合は、同一カラムで、作成区分(KBSAKU)違いの場合は、
037 * 最も大きな作成区分を持つコードを使用します。
038 * 作成区分(KBSAKU)='0' のデータは、マスタリソースとして、エンジンとともに
039 * 配布されるリソースになります。
040 *
041 * カラムデータには、3つのレベルのオブジェクト作成方法が適用されます。
042 * エンジン内部のカラムリソースファイル(org.opengion.hayabusa.common.data.ColumnResource)は、
043 * 初期作成されるカラムリソースです。エンジンの更新に対応して、このリソースも同時に
044 * 更新されます。このカラムは、最も優先順位の低いリソースで、同一キー情報で他の形式の
045 * カラムがあれば、そちらが使用されます。
046 *
047 * 読込フラグ(FGLOAD)='1'のカラムリソースは、すべて初期起動時に一括読み込みされます。
048 * 読込フラグが、'1' 以外のデータは、初期起動時には、メモリにキャッシュされず
049 * 実際に使用されるまで、オブジェクトが作成されません。
050 * これは、使用されるかどうか判らないカラムデータを、予め作成しないことで、メモリの
051 * 節約を図っています。
052 *
053 * SYSTEM_ID='**' は、共通リソースです。
054 * これは、システム間で共通に使用されるリソース情報を登録しておきます。
055 *
056 * @og.rev 4.0.0.0 (2004/12/31) 新規作成
057 * @og.group リソース管理
058 *
059 * @version  4.0
060 * @author   Kazuhiko Hasegawa
061 * @since    JDK5.0,
062 */
063final class ColumnDataLoader {
064        // リソースの接続先を、取得します。
065        private final String DBID = HybsSystem.sys( "RESOURCE_DBID" );
066
067        // DBリソースの初期一括読込のクエリー
068 //private static final String QUERY = "select CLM,CLS_NAME,USE_LENGTH,VIEW_LENGTH,"
069 //                                                                     + "RENDERER,EDITOR,DBTYPE,DATA_DEFAULT,LABEL_CLM,CODE_CLM,"
070 //                                                                     + "CLM_PARAM,RENDERER_PARAM,EDITOR_PARAM,TYPE_PARAM,ROLES"
071 //                                                                     + " from GEA03 where SYSTEM_ID in ( ?,'**')"
072 //                                                                     + " and FGJ='1' and FGLOAD = '1'"
073 //                                                                     + " order by SYSTEM_ID,CLM,KBSAKU" ;
074
075        // 4.3.5.7 (2009/03/22) FGLOADの影響で個別システムのリソースが読まれない問題の対応
076        // 6.2.0.0 (2015/02/27) フィールドサイズ(FIELD_SIZE) 追加
077        private static final String QUERY = "select CLM,CLS_NAME,USE_LENGTH,VIEW_LENGTH,"
078                                                                        + "RENDERER,EDITOR,DBTYPE,DATA_DEFAULT,LABEL_CLM,CODE_CLM,"
079                                                                        + "CLM_PARAM,RENDERER_PARAM,EDITOR_PARAM,TYPE_PARAM,ROLES,'' AS FIELD_SIZE"                     // 6.4.9.5 (2016/09/09) javaDB対応
080                                                                        + ",FGLOAD"
081                                                                        + " from GEA03 where SYSTEM_ID in ( ?,'**')"
082                                                                        + " and FGJ='1'"
083                                                                        + " order by SYSTEM_ID,CLM,KBSAKU" ;
084
085        // DBリソースの個別読込時のクエリー
086        // 6.2.0.0 (2015/02/27) フィールドサイズ(FIELD_SIZE) 追加
087        // 6.3.1.1 (2015/07/10) FGLOAD,UNIQ 追加
088        private static final String QUERY2 = "select CLM,CLS_NAME,USE_LENGTH,VIEW_LENGTH,"
089                                                                        + "RENDERER,EDITOR,DBTYPE,DATA_DEFAULT,LABEL_CLM,CODE_CLM,"
090                                                                        + "CLM_PARAM,RENDERER_PARAM,EDITOR_PARAM,TYPE_PARAM,ROLES,'' AS FIELD_SIZE"                     // 6.4.9.5 (2016/09/09) javaDB対応
091                                                                        + ",FGLOAD,UNIQ,SYSTEM_ID"                              // 6.3.1.1 (2015/07/10)
092                                                                        + " from GEA03 where SYSTEM_ID in ( ?,'**')"
093                                                                        + " and CLM=? and FGJ='1'"
094                                                                        + " order by SYSTEM_ID,KBSAKU" ;
095
096        // 6.3.1.1 (2015/07/10) 読込フラグ(FGLOAD) のマーカー設定追加。
097        private static final boolean IS_FGLOAD_AUTOSET = HybsSystem.sysBool( "USE_FGLOAD_AUTOSET" );            // 6.4.1.1 (2016/01/16) useFgloadAutoset → IS_FGLOAD_AUTOSET  refactoring
098
099        // 6.3.1.1 (2015/07/10) FGLOAD更新(UNIQ だけで指定可能だが、万一を想定して、SYSTEM_IDとCLMを条件に追記)
100        private static final String UPDATE2 = "update GEA03 set FGLOAD='2' where UNIQ=? and SYSTEM_ID=? and CLM=?";
101
102        /** 6.4.3.1 (2016/02/12) Collections.synchronizedMap で同期処理を行います。  */
103        private final Map<String,ColumnData> columnMap = Collections.synchronizedMap( new WeakHashMap<>() );    // キャッシュ用プール
104        private final String  SYSTEM_ID ;               // システムID
105
106        /** コネクションにアプリケーション情報を追記するかどうか指定 */
107        public static final boolean USE_DB_APPLICATION_INFO  = HybsSystem.sysBool( "USE_DB_APPLICATION_INFO" ) ;
108
109        // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
110        private final ApplicationInfo appInfo;
111
112        /**
113         *  SystemId 毎に ファクトリオブジェクトを作成します。
114         *
115         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
116         *
117         * @param systemId システムID
118         * @param initLoad リソースデータの先読み可否(true:先読みする)
119         */
120        ColumnDataLoader( final String systemId,final boolean initLoad ) {
121                SYSTEM_ID = systemId;
122
123                // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
124                if( USE_DB_APPLICATION_INFO ) {
125                        appInfo = new ApplicationInfo();
126                        // ユーザーID,IPアドレス,ホスト名
127                        appInfo.setClientInfo( SYSTEM_ID,HybsSystem.HOST_ADRS,HybsSystem.HOST_NAME );
128                        // 画面ID,操作,プログラムID
129                        appInfo.setModuleInfo( "ColumnDataLoader",null,null );
130                }
131                else {
132                        appInfo = null;
133                }
134
135                // ApplicationInfo の設定が終わってから実行します。
136                if( initLoad ) { loadDBResource(); }
137        }
138
139        /**
140         * DBリソースより カラムデータを取得、設定します。
141         * 同一キー(CLM)に対して、複数の作成区分(KBSAKU)を持つデータが
142         * 検索される場合は、作成区分(KBSAKU)の大きな値が使用されます。
143         * つまり、より、ローカライズなキーほど、作成区分(KBSAKU)に大きな値を
144         * 使用するようにします。
145         *
146         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
147         * @og.rev 4.3.5.7 (2009/03/22) FGLOADの影響でシステム個別リソースが読まれない問題対応
148         * @og.rev 7.0.7.0 (2019/12/13) 読み取り件数の評価を、破棄分も考慮する。
149         *
150         */
151        private void loadDBResource() {
152                final String[] args = new String[] { SYSTEM_ID };
153
154                final String[][] vals = DBUtil.dbExecute( QUERY,args,appInfo,DBID );
155
156                final int len = vals.length;
157                for( int i=0; i<len; i++ ) {
158                        if( "1".equals( vals[i][ColumnData.FG_LOAD] ) ) {                       // 4.3.5.7 (2009/03/22) 1:一括読込
159                                columnMap.put( vals[i][0],new ColumnData( vals[i] ) );
160                        }
161                        // より上の作成区分で、FGLOAD='0'(個別読込)が来た場合は、下位のFGLOAD='1'(一括読込)を破棄
162                        // order by SYSTEM_ID,CLM,KBSAKU
163                        else if( columnMap.get( vals[i][0]) != null ){
164                                columnMap.remove( vals[i][0] );
165                        }
166                }
167
168                // 7.0.7.0 (2019/12/13) 読み取り件数の評価を、破棄分も考慮する。
169//              System.out.println( "  ColumnDataLoader [" + len + "] loaded" );
170                System.out.println( "  ColumnDataLoader [" + len + "] select [" + columnMap.size() + "] loaded"  );             // 7.0.7.0 (2019/12/13)
171        }
172
173        /**
174         * ColumnDataオブジェクトを取得します。
175         * 作成したColumnDataオブジェクトは,内部にプールしておき,同じリソース要求が
176         * あったときは,プールの ColumnDataを返します。
177         * 読込フラグ(FGLOAD)が '1' のデータは、起動時に先読みします。
178         * それ以外のデータは、ここでキー要求が発生した時点で読み込みます。
179         * 読込フラグ(FGLOAD) のマーカー設定モード(USE_FGLOAD_AUTOSET)を使用する(true)場合は、
180         * 追加読み込み(先読みされていないカラム)に対して、読込フラグ(FGLOAD)を 2:使用実績 に
181         * 設定します。(次回起動時の、初期読み込みは行いません。)
182         *
183         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
184         * @og.rev 6.3.1.1 (2015/07/10) 読込フラグ(FGLOAD) のマーカー設定追加。
185//       * @og.rev 7.0.7.0 (2019/12/13) FG_LOADが、3:使用確認 , 8:未使用 の場合に使用されると、2:使用実績 をセットする。       7.0.7.2 元に戻す
186         * @og.rev 7.0.7.0 (2019/12/13) キーだけからリソース無しのColumnDataを作成します。
187         * @og.rev 7.0.7.2 (2019/12/28) リソース無しのキャッシュは行わない。(DBからSELECTした際、スキーマから自動で文字か数字を判定しているから)
188         *
189         * @param   key         カラムのキー
190         *
191         * @return      ColumnDataオブジェクト
192         */
193        public ColumnData getColumnData( final String key ) {
194                ColumnData column = columnMap.get( key ) ;
195                if( column == null ) {
196                        final String[] args = new String[] { SYSTEM_ID,key };
197                        final String[][] vals = DBUtil.dbExecute( QUERY2,args,appInfo,DBID );           // SYSTEM_ID='**' も含む
198                        if( vals.length > 0 ) {
199                                final int row=vals.length-1;                                            // 最後の検索結果
200                                column = new ColumnData( vals[row] );                           // 最後の検索結果が有効
201                                columnMap.put( key,column );
202
203                                // 6.3.1.1 (2015/07/10) 読込フラグ(FGLOAD) のマーカー設定追加。
204                                if( IS_FGLOAD_AUTOSET ) {
205                                        // 1:一括読込 と、2:使用実績 以外のリソースは、2:使用実績 をセットする。(SYSTEM_ID='**'は含まない)
206                                        final String fgld  = vals[row][ColumnData.FG_LOAD];
207                                        final String sysld = vals[row][ColumnData.SYSTEM_ID];
208                                        if( !"1".equals( fgld ) && !"2".equals( fgld ) && !"**".equals( sysld ) ) {
209        //                              // 7.0.7.0 (2019/12/13) FG_LOADが、3:使用確認 , 8:未使用 の場合に使用されると、2:使用実績 をセットする。
210        //                              if( "3".equals( fgld ) || "8".equals( fgld ) ) {
211                                                final String[] args2 = new String[] { vals[row][ColumnData.UNIQ],SYSTEM_ID,key };
212                                                DBUtil.dbExecute( UPDATE2,args2,appInfo,DBID );         // FGLOAD を、2:使用実績 にセット
213                                        }
214                                }
215                        }
216//                      // 
217//                      // 7.0.7.0 (2019/12/13) キーだけからリソース無しのColumnDataを作成します。
218//                      else {
219//                              final DBColumnConfig config = new DBColumnConfig( key );
220//                              column = config.getColumnData();
221//                              columnMap.put( key,column );
222//                      }
223                }
224                return column ;
225        }
226
227        /**
228         * ColumnData オブジェクトのキャッシュを個別にクリアします。
229         * リソースデータの更新など、一部分の更新時に、すべてのキャッシュを
230         * 破棄するのではなく、指定の分のみ破棄できる機能です。
231         *
232         * @og.rev 6.9.0.1 (2018/02/05) どのシステムIDのリソースがクリアされたかを表示します。
233         *
234         * @param   key         カラムのキー
235         */
236        public void clear( final String key ) {
237                System.out.println( "SYSTEM_ID=[" + SYSTEM_ID + "] , Key=[" + key + "] の部分リソースクリアを実施しました。" );
238                columnMap.remove( key );
239        }
240
241        /**
242         * ColumnData オブジェクトのキャッシュをクリアします。
243         *
244         * @og.rev 6.9.0.1 (2018/02/05) どのシステムIDのリソースがクリアされたかを表示します。
245         *
246         */
247        public void clear() {
248                System.out.println( "SYSTEM_ID=[" + SYSTEM_ID + "] の全リソースをクリアしました。" );
249                columnMap.clear();
250        }
251}