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