    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.util.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        // ＤＢリソースの初期一括読み込みのクエリー
    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        // ＤＢリソースの個別読み込み時のクエリー
    079        private static final String QUERY2 = "select CLM,SNAME,LNAME,DESCRIPTION"
    080                                                                        + " from GEA08 where SYSTEM_ID in ( ?,'**')"
    081                                                                        + " and LANG=? and CLM=? and FGJ='1'"
    082                                                                        + " order by SYSTEM_ID,KBSAKU" ;
    083
    084        private final Map<String,LabelData> pool = Collections.synchronizedMap( new WeakHashMap<String,LabelData>() );  // キャッシュ用プール
    085        private final String  SYSTEM_ID ;               // システムID
    086        private final String  LANG ;                    // 言語
    087
    088        /** コネクションにアプリケーション情報を追記するかどうか指定 */
    089        public static final boolean USE_DB_APPLICATION_INFO  = HybsSystem.sysBool( "USE_DB_APPLICATION_INFO" ) ;
    090
    091        // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
    092        private final ApplicationInfo appInfo;
    093
    094        /**
    095         *  SystemId と lang 毎に ファクトリオブジェクトを作成します。
    096         *
    097         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
    098         *
    099         * @param systemId システムID
    100         * @param lang  言語
    101         * @param initLoad リソースデータの先読み可否(true:先読みする)
    102         */
    103        LabelDataLoader( final String systemId,final String lang,final boolean initLoad ) {
    104                SYSTEM_ID = systemId;
    105                LANG      = lang;
    106
    107                // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
    108                if( USE_DB_APPLICATION_INFO ) {
    109                        appInfo = new ApplicationInfo();
    110                        // ユーザーID,IPアドレス,ホスト名
    111                        appInfo.setClientInfo( SYSTEM_ID,HybsSystem.HOST_ADRS,HybsSystem.HOST_NAME );
    112                        // 画面ID,操作,プログラムID
    113                        appInfo.setModuleInfo( "LabelDataLoader",null,null );
    114                }
    115                else {
    116                        appInfo = null;
    117                }
    118
    119                // ApplicationInfo の設定が終わってから実行します。
    120                if( initLoad ) { loadDBResource(); }
    121        }
    122
    123        /**
    124         * ＤＢリソースより ラベルデータを取得、設定します。
    125         * 取得データは、CLM,SNAME,LNAME,DESCRIPTION です。
    126         *
    127         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
    128         * @og.rev 4.3.5.7 (2009/03/22)  FGLOADの影響でシステム個別リソースが読まれない問題対応
    129         */
    130        private void loadDBResource() {
    131                String[] args = new String[] { SYSTEM_ID,LANG };
    132
    133                String[][] vals = DBUtil.dbExecute( QUERY,args,appInfo,DBID );
    134
    135                int len = vals.length;
    136                for( int i=0; i<len; i++ ) {
    137                        if( "1".equals( vals[i][LabelData.FG_LOAD] ) ){ // 4.3.5.7 (2009/03/22)
    138                                pool.put( vals[i][0],new LabelData( vals[i] ) );
    139                        }
    140                        // より上の作成区分で、FGLOAD='0'(個別読込)が来た場合は、下位のFGLOAD='1'(一括読込)を破棄
    141                        else if( pool.get( vals[i][0]) != null ){
    142                                pool.remove( vals[i][0] );
    143                        }
    144                }
    145
    146                System.out.println( "  LabelDataLoader [" + len + "] loaded" );
    147        }
    148
    149        /**
    150         * LabelData オブジェクトを取得します。
    151         * 作成したLabelDataオブジェクトは，内部にプールしておき，同じリソース要求が
    152         * あったときは，プールの LabelDataを返します。
    153         * リソースDBに存在しない場合は、NULLラベルを作成します。このオブジェクトも
    154         * キャッシュします。
    155         *
    156         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
    157         *
    158         * @param   key        ラベルのキー
    159         *
    160         * @return  LabelData  オブジェクト
    161         */
    162        public LabelData getLabelData( final String key ) {
    163                LabelData label = pool.get( key ) ;
    164
    165                if( label == null ) {
    166                        String[] args = new String[] { SYSTEM_ID,LANG,key };
    167                        String[][] vals = DBUtil.dbExecute( QUERY2,args,appInfo,DBID );
    168
    169                        if( vals.length > 0 ) {
    170                                label = new LabelData( vals[vals.length-1] );           // 最後のデータ
    171                        }
    172                        else {
    173                                label = new LabelData( key );           // null ラベル
    174                        }
    175                        pool.put( key,label );
    176                }
    177
    178                return label ;
    179        }
    180
    181        /**
    182         * 指定されたクエリを発行し、ラベルマップを作成します。
    183         *
    184         * ここで作成されたラベル情報は、内部的にキャッシュされません。
    185         * 各画面で一時的にラベル情報を追加したい場合に使用します。
    186         *
    187         * 発行するクエリでは、第1カラムにラベルキーを、第2カラムにラベル名称を設定します。
    188         * 第3カラムが存在する場合は、名称(短)として使用されます。(必須ではありません)
    189         * クエリが指定されていない又は、検索したカラム数が1以下の場合はエラーを返します。
    190         *
    191         * @og.rev 4.3.4.0 (2008/12/01) 新規作成
    192         *
    193         * @param       query           ラベルマップを作成するクエリ
    194         *
    195         * @return  labelMap    ラベルマップ
    196         */
    197        public Map<String, LabelData> getLabelMap( final String query ) {
    198                if( query == null || query.length() == 0 ) {
    199                        String errMsg = "ラベルを取得するクエリが指定されていません。";
    200                        throw new HybsSystemException( errMsg );
    201                }
    202
    203                String[][] rtn = DBUtil.dbExecute( query, new String[0], appInfo );
    204                if( rtn == null || rtn.length == 0 ) { // データが存在しない場合はそのまま終了します。
    205                        return null;
    206                }
    207
    208                int confSize = rtn[0].length;
    209                if( confSize < 2 ) {
    210                        String errMsg = "ラベルキー、ラベル名称の指定は必須です。"
    211                                                + " SQL=" + query ;                                     // 5.1.8.0 (2010/07/01) errMsg 修正
    212                        throw new HybsSystemException( errMsg );
    213                }
    214
    215                Map<String, LabelData> labelMap = new HashMap<String, LabelData>();
    216                for ( int i = 0; i < rtn.length; i++ ) {
    217                        String[] ldconf = new String[5];
    218                        ldconf[0] = rtn[i][0];
    219                        ldconf[1] = ( confSize == 2 ? rtn[i][1] : rtn[i][2] ); // SNAME
    220                        ldconf[2] = rtn[i][1]; // LNAME
    221                        ldconf[3] = "";
    222                        ldconf[4] = "";
    223
    224                        labelMap.put( rtn[i][0], new LabelData( ldconf ) );
    225                }
    226                return labelMap;
    227        }
    228
    229        /**
    230         * LabelData オブジェクトのキャッシュを個別にクリアします。
    231         * リソースデータの更新など、一部分の更新時に、すべてのキャッシュを
    232         * 破棄するのではなく、指定の分のみ破棄できる機能です。
    233         *
    234         * @param   key        ラベルのキー
    235         */
    236        public void clear( final String key ) {
    237                pool.remove( key );
    238        }
    239
    240        /**
    241         * LabelData オブジェクトのキャッシュをクリアします。
    242         *
    243         */
    244        public void clear() {
    245                pool.clear();
    246        }
    247}