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.SystemManager;
020import org.opengion.fukurou.db.DBUtil;
021import org.opengion.fukurou.util.Cleanable;
022import org.opengion.fukurou.util.ApplicationInfo;
023
024import java.util.Map;
025import java.util.WeakHashMap;
026
027/**
028 * 事業所(CDJGS) , 年月(YYYYMM) に対応した休日カレンダデータを作成するファクトリクラスです。
029 *
030 * カレンダデータは、1日(DY1)~31日(DY31)までの日付け欄に対して、0:平日 1:休日 という
031 * データを持っています。実際には、内部では true:平日 false:休日 という持ち方をします。
032 * (カレンダDBは、文字列ですが、内部で持つ場合は、数字で管理しています。)
033 *
034 * 通常のカレンダでは、月毎に、(2月は、年によって)最大日付けが変わります。
035 * これは、カレンダデータクラスとしては、-1 を設定しておきます。
036 *
037 * カレンダデータには、3つのレベルのオブジェクト作成方法が適用されます。
038 * 他のリソースの3つのレベルとは異なり、エンジンリソースからの読み取りは
039 * 存在しなく、第4の方法が加わった事により、3つの方法になっています。
040 *
041 * まず、読込フラグ(FGLOAD)='1'のカレンダデータは、このCalendarFactoryオブジェクトが
042 * 構築された時に、すべてキャッシュとして内部メモリに読み取ります。
043 * 読込フラグが、'1' 以外のデータは、初期起動時には、メモリにキャッシュされず
044 * 実際に使用されるまで、オブジェクトが作成されません。
045 * カレンダの場合、過去の使用される可能性が低いデータまで、キャッシュしない様に、
046 * このフラグを使用して、メモリの節約を図ることが可能になります。
047 *
048 * 読込フラグ(FGLOAD)自動設定機能を使用すれば、読み取ったラベルデータに対して、
049 * 読込フラグ(FGLOAD)に '1' を自動的にセットします。この機能により、一度でも
050 * 読み取ったことがあるデータに '1' を付け、次回起動時には、メモリキャッシュさせる
051 * 事と、一度も読み取っていないデータを判別して、データ削除等のメンテナンスに
052 * 使用することが可能です。
053 * カレンダに限定すれば、当面使用されない先のカレンダ(1年分など)を登録する時に、
054 * 読込フラグ(FGLOAD)='0' にしておけば、実際に読み取られるまで、メモリキャッシュ
055 * されないため、さらにメモリ効率が向上します。
056 *
057 * 2つめの方法は、キャッシュに存在しない場合は、DBから読み取ります。
058 *
059 * 3つめは、カレンダ特有の方法で、DBにデータが存在しない場合の設定です。
060 * これは、カレンダテーブル未設定時でも、カレンダとして使用できるように
061 * 自動的にカレンダデータを作成します。日曜日を休日として自動設定します。
062 *
063 * @og.rev 3.6.0.0 (2004/09/17) 新規作成
064 * @og.group リソース管理
065 *
066 * @version  4.0
067 * @author   Kazuhiko Hasegawa
068 * @since    JDK5.0,
069 */
070public final class CalendarFactory {
071        private static final Map<String,CalendarData> pool = new WeakHashMap<String,CalendarData>();                            // 4.0.0 (2005/01/31)
072        private static final Map<String,CalendarQuery> queryClassPool = new WeakHashMap<String,CalendarQuery>();                // 4.0.0 (2005/01/31)
073        // 4.0.0.0 PGカレンダーの初期設定をシステムリソースに変更
074        private static CalendarData pgCalData = null;
075        private static final String PG_CALENDAR_DATA_CLASS = HybsSystem.sys( "DEFAULT_CALENDAR_CLASS");
076        private static final Object lock = new Object();
077
078        // カレンダDBの接続先を、取得します。
079        private static final String DBID  = HybsSystem.sys( "RESOURCE_CALENDAR_DBID" );
080
081        // カレンダDBを使用するかどうかを指定します。(互換モード)
082        private static boolean useDB = HybsSystem.sysBool( "USE_CALENDAR_DATABASE" );
083
084        // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
085        private static final ApplicationInfo appInfo;
086
087        // 4.0.0 (2005/01/31) Cleanable インターフェースによる初期化処理
088        static {
089                Cleanable clr = new Cleanable() {
090                        public void clear() {
091                                CalendarFactory.clear();
092                        }
093                };
094
095                SystemManager.addCleanable( clr );
096
097                /** コネクションにアプリケーション情報を追記するかどうか指定 */
098                boolean USE_DB_APPLICATION_INFO  = HybsSystem.sysBool( "USE_DB_APPLICATION_INFO" ) ;
099
100                // 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
101                if( USE_DB_APPLICATION_INFO ) {
102                        String SYSTEM_ID = HybsSystem.sys( "SYSTEM_ID" );
103                        appInfo = new ApplicationInfo();
104                        // ユーザーID,IPアドレス,ホスト名
105                        appInfo.setClientInfo( SYSTEM_ID,HybsSystem.HOST_ADRS,HybsSystem.HOST_NAME );
106                        // 画面ID,操作,プログラムID
107                        appInfo.setModuleInfo( "CalendarFactory",null,null );
108                }
109                else {
110                        appInfo = null;
111                }
112        }
113
114        /**
115         * コンストラクタ
116         * ファクトリクラスの為、private 化しています。
117         *
118         */
119        private CalendarFactory() { }
120
121        /**
122         * CalendarData オブジェクトを取得します。
123         * 作成したCalendarDataオブジェクトは,内部にプールしておき,同じリソース要求が
124         * あったときは,プールの CalendarDataを返します。
125         * DBにデータが存在しない場合は、自動でカレンダを作成します。
126         *
127         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
128         * @og.rev 4.0.0.0 (2007/08/29) カレンダーテーブルが存在しない場合のデフォルトのカレンダーデータをシステムリソースで設定する
129         *
130         * @param       cls     CalendarQueryオブジェクトを名称を指定します。
131         * @param       arg1    データベース検索時の第1引数
132         * @param       arg2    データベース検索時の第2引数
133         * @param       arg3    データベース検索時の第3引数
134         * @param       arg4    データベース検索時の第4引数
135         *
136         * @return      CalendarDataオブジェクト
137         */
138        public static CalendarData getCalendarData( final String cls,final String arg1,final String arg2,final String arg3,final String arg4 ) {
139
140                // 4.0.0.0 PGカレンダーの初期設定をシステムリソースに変更
141                synchronized( lock ) {
142                        if(pgCalData == null) {
143                                pgCalData = (CalendarData)HybsSystem.newInstance(PG_CALENDAR_DATA_CLASS);
144                        }
145                }
146
147                if( ! useDB || cls == null ) { return pgCalData; }
148
149                CalendarData calData ;
150
151                String key = cls + ":" + arg1 + ":" + arg2 + ":" + arg3 + ":" + arg4 ;
152                synchronized( lock ) {
153                        calData = pool.get( key ) ;
154                }
155
156                if( calData == null ) {
157                        CalendarQuery query ;
158                        synchronized( lock ) {
159                                query = queryClassPool.get( cls );
160                                if( query == null ) {
161                                        String queryClass = HybsSystem.sys( "CalendarQuery_" + cls );
162                                        query = (CalendarQuery)HybsSystem.newInstance( queryClass );
163                                        queryClassPool.put( cls,query );
164                                }
165                        }
166
167                        String[] args = query.checkArgment( arg1,arg2,arg3,arg4 );
168                        String[][] vals = DBUtil.dbExecute( query.getQuery(),args,appInfo,DBID );       // 3.8.7.0 (2006/12/15)
169                        boolean  isFlat = query.isFlatTable();
170
171                        if( vals != null && vals.length > 0 ) {
172                                calData = new CalendarDBData( vals,isFlat );
173                                // 完全同期ではない。DB処理中に別にもDB処理を行い、
174                                // 先に put されたとしても、同一キーに同じ属性のオブジェクトを
175                                // 登録するだけなので、実質的な問題は発生しない。
176                                // これが、List などの順序が関係すると、このコードは使えない。
177                                synchronized( lock ) {
178                                        pool.put( key,calData );
179                                }
180                        }
181                        else {
182                                // カレンダテーブルにデータが存在しない場合。
183                                // 4.0.0.0 PGカレンダーの初期設定をシステムリソースに変更
184                                calData = pgCalData;
185                        }
186                }
187                return calData ;
188        }
189
190        /**
191         * キャッシュ(プール)から、すべてのオブジェクトをクリアします。
192         *
193         */
194        public static void clear() {
195                synchronized( lock ) {
196                        pool.clear();
197                        queryClassPool.clear();
198                        useDB = HybsSystem.sysBool( "USE_CALENDAR_DATABASE" );
199                }
200        }
201}