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.hayabusa.common.HybsSystemException; 020import org.opengion.fukurou.db.ApplicationInfo; 021import org.opengion.fukurou.db.DBUtil; 022 023import java.util.HashMap; 024import java.util.Map; 025import java.util.WeakHashMap; 026import java.util.Collections ; 027 028/** 029 * systemId と lang に対応したラベルデータを作成するデータロードクラスです。 030 * 031 * ラベルデータは、項目(CLM)に対して、各種ラベル情報を持っています。 032 * ラベルデータは、名前(ORG)と名前(短)と名前(長)を持っています。従来のラベルは、表示名称と 033 * して、一種類しか持っていませんでした。 034 * 名前(ORG)は、従来の表示名称にあたります。これは、一般的なラベルとして 035 * 使用されます。名前(短)は、テーブル一覧のヘッダーの様に、特殊なケースで、 036 * 簡略化された名称を使用するときに利用されます。この切り替えは、自動で判断されます。 037 * 名前(短)に、なにも設定されていない場合は、名前(長)が自動的に使用されますので 038 * 初期データ移行時には、そのまま、通常時もテーブルヘッダー時も同じ文字列が 039 * 使用されます。 040 * 名前(短)と名前(長)は、コメント情報が存在する場合は、Tips表示を行います。 041 * 042 * ラベルデータを作成する場合は、同一ラベルで、作成区分(KBSAKU)違いの場合は、 043 * 最も大きな作成区分を持つコードを使用します。 044 * 作成区分(KBSAKU)='0' のデータは、マスタリソースとして、エンジンとともに 045 * 配布されるリソースになります。 046 * 047 * 読込フラグ(FGLOAD)='1'のラベルリソースは、このLabelDataLoaderオブジェクトが 048 * 構築された時に、すべてキャッシュとして内部メモリに読み取ります。 049 * 読込フラグが、'1' 以外のデータは、初期起動時には、メモリにキャッシュされず 050 * 実際に使用されるまで、オブジェクトが作成されません。 051 * これは、使用されるかどうか判らないラベルデータを、予め作成しないことで、メモリの 052 * 節約を図っています。 053 * ただし、リソースのキャッシュに、WeakHashMap クラスを使用しているため、 054 * メモリオーバー時には、クリアされるため、単独での読み取りも行います。 055 * 056 * SYSTEM_ID='**' は、共通リソースです。 057 * これは、システム間で共通に使用されるリソース情報を登録しておきます。 058 * 059 * @og.rev 4.0.0.0 (2004/12/31) 新規作成 060 * @og.group リソース管理 061 * 062 * @version 4.0 063 * @author Kazuhiko Hasegawa 064 * @since JDK5.0, 065 */ 066final class LabelDataLoader { 067 // リソースの接続先を、取得します。 068 private final String DBID = HybsSystem.sys( "RESOURCE_DBID" ); 069 070 // DBリソースの初期一括読み込みのクエリー 071 // 4.3.5.7 (2009/03/22) FGLOADの影響で個別システムのリソースが読まれない問題の対応 072 private static final String QUERY = "select CLM,SNAME,LNAME,DESCRIPTION" 073 + " ,FGLOAD" 074 + " from GEA08 where SYSTEM_ID in ( ?,'**')" 075 + " and LANG=? and FGJ='1'" 076 + " order by SYSTEM_ID,CLM,KBSAKU" ; 077 078 // DBリソースの個別読み込み時のクエリー 079 // 6.3.1.1 (2015/07/10) FGLOAD,UNIQ 追加 080 private static final String QUERY2 = "select CLM,SNAME,LNAME,DESCRIPTION" 081 + " ,FGLOAD,UNIQ,SYSTEM_ID" // 6.3.1.1 (2015/07/10) 082 + " from GEA08 where SYSTEM_ID in ( ?,'**')" 083 + " and LANG=? and CLM=? and FGJ='1'" 084 + " order by SYSTEM_ID,KBSAKU" ; 085 086 // 6.3.1.1 (2015/07/10) 読込フラグ(FGLOAD) のマーカー設定追加。 087 private static final boolean IS_FGLOAD_AUTOSET = HybsSystem.sysBool( "USE_FGLOAD_AUTOSET" ); // 6.4.1.1 (2016/01/16) useFgloadAutoset → IS_FGLOAD_AUTOSET refactoring 088 089 // 6.3.1.1 (2015/07/10) FGLOAD更新(UNIQ だけで指定可能だが、万一を想定して、SYSTEM_IDとCLMを条件に追記) 090 private static final String UPDATE2 = "update GEA08 set FGLOAD='2' where UNIQ=? and SYSTEM_ID=? and CLM=?"; 091 092 /** 6.4.3.1 (2016/02/12) Collections.synchronizedMap で同期処理を行います。 */ 093 private final Map<String,LabelData> labelMap = Collections.synchronizedMap( new WeakHashMap<>() ); // キャッシュ用プール 094 private final String SYSTEM_ID ; // システムID 095 private final String LANG ; // 言語 096 097 /** コネクションにアプリケーション情報を追記するかどうか指定 */ 098 public static final boolean USE_DB_APPLICATION_INFO = HybsSystem.sysBool( "USE_DB_APPLICATION_INFO" ) ; 099 100 // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 101 private final ApplicationInfo appInfo; 102 103 /** 104 * SystemId と lang 毎に ファクトリオブジェクトを作成します。 105 * 106 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 107 * 108 * @param systemId システムID 109 * @param lang 言語 110 * @param initLoad リソースデータの先読み可否(true:先読みする) 111 */ 112 LabelDataLoader( final String systemId,final String lang,final boolean initLoad ) { 113 SYSTEM_ID = systemId; 114 LANG = lang; 115 116 // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 117 if( USE_DB_APPLICATION_INFO ) { 118 appInfo = new ApplicationInfo(); 119 // ユーザーID,IPアドレス,ホスト名 120 appInfo.setClientInfo( SYSTEM_ID,HybsSystem.HOST_ADRS,HybsSystem.HOST_NAME ); 121 // 画面ID,操作,プログラムID 122 appInfo.setModuleInfo( "LabelDataLoader",null,null ); 123 } 124 else { 125 appInfo = null; 126 } 127 128 // ApplicationInfo の設定が終わってから実行します。 129 if( initLoad ) { loadDBResource(); } 130 } 131 132 /** 133 * DBリソースより ラベルデータを取得、設定します。 134 * 取得データは、CLM,SNAME,LNAME,DESCRIPTION です。 135 * 136 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 137 * @og.rev 4.3.5.7 (2009/03/22) FGLOADの影響でシステム個別リソースが読まれない問題対応 138 * @og.rev 7.0.7.0 (2019/12/13) 読み取り件数の評価を、破棄分も考慮する。 139 */ 140 private void loadDBResource() { 141 final String[] args = new String[] { SYSTEM_ID,LANG }; 142 143 final String[][] vals = DBUtil.dbExecute( QUERY,args,appInfo,DBID ); 144 145 final int len = vals.length; 146 for( int i=0; i<len; i++ ) { 147 if( "1".equals( vals[i][LabelData.FG_LOAD] ) ){ // 4.3.5.7 (2009/03/22) 148 labelMap.put( vals[i][0],new LabelData( vals[i] ) ); 149 } 150 // より上の作成区分で、FGLOAD='0'(個別読込)が来た場合は、下位のFGLOAD='1'(一括読込)を破棄 151 else if( labelMap.get( vals[i][0]) != null ){ 152 labelMap.remove( vals[i][0] ); 153 } 154 } 155 156 // 7.0.7.0 (2019/12/13) 読み取り件数の評価を、破棄分も考慮する。 157// System.out.println( " LabelDataLoader [" + len + "] loaded" ); 158 System.out.println( " LabelDataLoader [" + len + "] select [" + labelMap.size() + "] loaded" ); // 7.0.7.0 (2019/12/13) 159 } 160 161 /** 162 * LabelData オブジェクトを取得します。 163 * 作成したLabelDataオブジェクトは,内部にプールしておき,同じリソース要求が 164 * あったときは,プールの LabelDataを返します。 165 * リソースDBに存在しない場合は、NULLラベルを作成します。このオブジェクトも 166 * キャッシュします。 167 * 読込フラグ(FGLOAD)が '1' のデータは、起動時に先読みします。 168 * それ以外のデータは、ここでキー要求が発生した時点で読み込みます。 169 * 読込フラグ(FGLOAD) のマーカー設定モード(USE_FGLOAD_AUTOSET)を使用する(true)場合は、 170 * 追加読み込み(先読みされていないカラム)に対して、読込フラグ(FGLOAD)を 2:使用実績 に 171 * 設定します。(次回起動時の、初期読み込みは行いません。) 172 * 173 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 174 * @og.rev 6.3.1.1 (2015/07/10) 読込フラグ(FGLOAD) のマーカー設定追加。 175 * 176 * @param key ラベルのキー 177 * 178 * @return LabelDataオブジェクト 179 * @og.rtnNotNull 180 */ 181 public LabelData getLabelData( final String key ) { 182 LabelData label = labelMap.get( key ) ; 183 184 if( label == null ) { 185 final String[] args = new String[] { SYSTEM_ID,LANG,key }; 186 final String[][] vals = DBUtil.dbExecute( QUERY2,args,appInfo,DBID ); // SYSTEM_ID='**' も含む 187 188 if( vals.length > 0 ) { 189 final int row=vals.length-1; // 最後の検索結果 190 label = new LabelData( vals[row] ); // 最後のデータ 191 192 // 6.3.1.1 (2015/07/10) 読込フラグ(FGLOAD) のマーカー設定追加。 193 if( IS_FGLOAD_AUTOSET ) { 194 // 1:一括読込 と、2:使用実績 以外のリソースは、2:使用実績 をセットする。(SYSTEM_ID='**'は含まない) 195 final String fgld = vals[row][LabelData.FG_LOAD]; 196 final String sysld = vals[row][LabelData.SYSTEM_ID]; 197 if( !"1".equals( fgld ) && !"2".equals( fgld ) && !"**".equals( sysld ) ) { 198 final String[] args2 = new String[] { vals[row][LabelData.UNIQ],SYSTEM_ID,key }; 199 DBUtil.dbExecute( UPDATE2,args2,appInfo,DBID ); // FGLOAD を、2:使用実績 にセット 200 } 201 } 202 } 203 else { 204 label = new LabelData( key ); // null ラベル 205 } 206 labelMap.put( key,label ); 207 } 208 209 return label ; 210 } 211 212 /** 213 * 指定されたクエリを発行し、ラベルマップを作成します。 214 * 215 * ここで作成されたラベル情報は、内部的にキャッシュされません。 216 * 各画面で一時的にラベル情報を追加したい場合に使用します。 217 * 218 * 発行するクエリでは、第1カラムにラベルキーを、第2カラムにラベル名称を設定します。 219 * 第3カラムが存在する場合は、名称(短)として使用されます。(必須ではありません) 220 * クエリが指定されていない又は、検索したカラム数が1以下の場合はエラーを返します。 221 * 222 * @og.rev 4.3.4.0 (2008/12/01) 新規作成 223 * @og.rev 6.4.0.5 (2016/01/09) useLabelMap="true" 時のSQL文の実行は、dbid を使用して行う。 224 * 225 * @param query ラベルマップを作成するクエリ 226 * @param dbid 接続先ID 227 * 228 * @return ラベルマップ 229 */ 230 public Map<String, LabelData> getLabelMap( final String query , final String dbid ) { 231 if( query == null || query.isEmpty() ) { 232 final String errMsg = "ラベルを取得するクエリが指定されていません。"; 233 throw new HybsSystemException( errMsg ); 234 } 235 236 final String[][] rtn = DBUtil.dbExecute( query, new String[0], appInfo, dbid ); // 6.4.0.5 (2016/01/09) 237 if( rtn == null || rtn.length == 0 ) { // データが存在しない場合はそのまま終了します。 238 return null; 239 } 240 241 final int confSize = rtn[0].length; 242 if( confSize < 2 ) { 243 final String errMsg = "ラベルキー、ラベル名称の指定は必須です。" 244 + " SQL=" + query ; // 5.1.8.0 (2010/07/01) errMsg 修正 245 throw new HybsSystemException( errMsg ); 246 } 247 248 // 6.4.4.1 (2016/03/18) 変数名がややこしいので、変更します。 249 final Map<String, LabelData> lblMap = new HashMap<>(); 250 for( int i=0; i<rtn.length; i++ ) { 251 String[] ldconf = new String[5]; 252 ldconf[0] = rtn[i][0]; // CLM 253 ldconf[1] = ( confSize == 2 ? rtn[i][1] : rtn[i][2] ); // SNAME 254 ldconf[2] = rtn[i][1]; // LNAME 255 ldconf[3] = ""; 256 ldconf[4] = ""; 257 258 lblMap.put( rtn[i][0], new LabelData( ldconf ) ); 259 } 260 return lblMap; 261 } 262 263 /** 264 * LabelData オブジェクトのキャッシュを個別にクリアします。 265 * リソースデータの更新など、一部分の更新時に、すべてのキャッシュを 266 * 破棄するのではなく、指定の分のみ破棄できる機能です。 267 * 268 * @param key ラベルのキー 269 */ 270 public void clear( final String key ) { 271 labelMap.remove( key ); 272 } 273 274 /** 275 * LabelData オブジェクトのキャッシュをクリアします。 276 * 277 */ 278 public void clear() { 279 labelMap.clear(); 280 } 281}