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;
020
021import java.util.Calendar;
022import java.util.Map;
023import java.util.SortedMap;
024import java.util.TreeMap ;
025import java.util.BitSet ;
026
027/**
028 * 事業所(CDJGS) 毎の休日カレンダデータオブジェクトです。
029 *
030 * カレンダデータは、指定の事業所に関して、すべての休日情報を持っています。
031 * 元のカレンダテーブル(GE13)の 1日(DY1)~31日(DY31)までの日付け欄に対して、
032 * 休日日付けの 年月日 に対する、休日かどうかを判断できるだけの情報を保持します。
033 * 具体的には、休日の年月日に対する List を持つことになります。
034 * このクラスは、パッケージプライベートになっています。このオブジェクトを作成するのは、
035 * CalendarFactory#getCalendarData( String ) で行います。引数は、事業所コード(cdjgs)です。
036 * このカレンダオブジェクトを使用するには、事業所カレンダテーブル(GE13) を使用する
037 * ことを許可しておく必要があります。
038 * 許可は、システムパラメータ の USE_CALENDAR_DATABASE 属性を true に
039 * 設定します(初期値は、互換性優先の false です。)
040 * この、カレンダテーブルは、GE13 固定です。他のテーブルを使用する場合は、
041 * ビュー等を作成する必要があります。
042 * カレンダテーブル は、通常 DEFAULT DBIDを使用しますが、RESOURCE_CALENDAR_DBID
043 * を設定することで、他のデータベースから読み取ることが可能になります。
044 *
045 * @og.rev 3.6.0.0 (2004/09/17) 新規作成
046 * @og.group リソース管理
047 *
048 * @version  4.0
049 * @author   Kazuhiko Hasegawa
050 * @since    JDK5.0,
051 */
052class CalendarDBData implements CalendarData {
053        private final SortedMap<String,BitSet> ymMap  = new TreeMap<String,BitSet>() ;  // 休日日付けデータを年月をキーに持ちます。
054
055        /**
056         * コンストラクタ
057         *
058         * 配列文字列のデータを元に、CalendarDBDataオブジェクトを構築します。
059         * このコンストラクタは、他のパッケージから呼び出せないように、
060         * パッケージプライベートにしておきます。
061         * 年月データは、連続である必要があります。
062         * 途中に抜けがあるかどうかのチェックを行います。
063         *
064         * @param       data    データベース検索データ
065         * @param       isFlat  縦持ち(false)か横持ち(true)の区別
066         */
067        CalendarDBData( final String[][] data,final boolean isFlat ) {
068                if( isFlat ) {
069                        callFlatTable( data );
070                }
071                else {
072                        callVerticalTable( data );
073                }
074        }
075
076        /**
077         * 横持ち(フラット)配列文字列のデータを元に、日付情報を構築します。
078         * 年月データは、連続である必要があります。
079         * 途中に抜けがあるかどうかのチェックを行います。
080         *
081         * @og.rev 3.8.8.0 (2007/12/22) 休日が全くない場合でも、日付設定する。
082         *
083         * @param data String[][]
084         *                     [0]:年月(YYYYMM) 200406 という形式
085         *                     [1]~[31] 1日~31日のデータ
086         *                           0:平日 / その他:休日
087         */
088        private void callFlatTable( final String[][] data ) {
089                for( int ym=0; ym<data.length; ym++ ) {
090                        String yyyymm = data[ym][0] ;
091                        if( yyyymm.length() != 6 ) {
092                                String errMsg = "年月(YYYYMM)は、YYYYMM(例:200406) という形式で指定して下さい。"
093                                                        + " YYYYMM [" + yyyymm + "]" ;
094                                throw new HybsSystemException( errMsg );
095                        }
096
097                        Calendar month = HybsSystem.getCalendar( yyyymm + "01" );       // 当月
098                        int lastDay = month.getActualMaximum( Calendar.DAY_OF_MONTH );  // 月末日
099
100                        BitSet ymData = new BitSet( lastDay+1 );
101                        for( int d=1; d<=lastDay; d++ ) {
102                                if( ! "0".equals( data[ym][d] ) ) {
103                                        // 日付けのビットを立てます。
104                                        ymData.set( d );
105                                }
106                        }
107
108                        // 日付けのキーがあり、休日設定があれば、有効月とみなし、セットします。
109                        // 3.8.8.0 (2007/12/22) 休日が全くない場合でも、日付設定する。
110                        ymMap.put( yyyymm,ymData );
111                }
112        }
113
114        /**
115         * 縦持ち(バーティカル)配列文字列のデータを元に、日付情報を構築します。
116         * 年月データは、連続である必要があります。
117         * 途中に抜けがあるかどうかのチェックを行います。
118         *
119         * @og.rev 3.8.8.0 (2007/12/22) 休日が全くない場合でも、日付設定する。
120         *
121         * @param data String[][]
122         *                     [0]:年月(YYYYMMDD) 20040601 という形式
123         *                     [1] 0:平日 / その他:休日
124         */
125        private void callVerticalTable( final String[][] data ) {
126                String bk_yyyymm = null;
127                BitSet ymData = null;
128                for( int ymd=0; ymd<data.length; ymd++ ) {
129                        if( data[ymd][0].length() != 8 ) {
130                                String errMsg = "年月日(YYYYMMDD)は、YYYYMMDD(例:20040601) という形式で指定して下さい。"
131                                                        + " YYYYMMDD [" + data[ymd][0] + "]" ;
132                                throw new HybsSystemException( errMsg );
133                        }
134
135                        String yyyymm = data[ymd][0].substring( 0,6 ) ;
136                        if( ! yyyymm.equals( bk_yyyymm ) ) {    // 月のブレイク
137                                // 日付けのキーがあり、休日設定があれば、有効月とみなし、セットします。
138                                // 3.8.8.0 (2007/12/22) 休日が全くない場合でも、日付設定する。
139                                if( ymData != null && bk_yyyymm != null ) {
140                                        ymMap.put( bk_yyyymm,ymData );
141                                }
142                                bk_yyyymm = yyyymm;
143
144                                Calendar month = HybsSystem.getCalendar( yyyymm + "01" );       // 当月
145                                int lastDay = month.getActualMaximum( Calendar.DAY_OF_MONTH );  // 月末日
146
147                                ymData = new BitSet( lastDay+1 );
148                        }
149
150                        if( ! "0".equals( data[ymd][1] ) ) {
151                                // 日付けのビットを立てます。
152                                int dt = Integer.parseInt( data[ymd][0].substring( 6 ) );
153                                ymData.set( dt );
154                        }
155                }
156                // 日付けのキーがあり、休日設定があれば、有効月とみなし、セットします。
157                // 3.8.8.0 (2007/12/22) 休日が全くない場合でも、日付設定する。
158                if( ymData != null && bk_yyyymm != null ) {
159                        ymMap.put( bk_yyyymm,ymData );
160                }
161        }
162
163        /**
164         * 指定の日付けが、休日かどうかを返します。
165         * 指定の日付けが、データベースに設定されていない場合は、すべて休日を
166         * 返すことで、存在しない事を示します。
167         *
168         * @param  day Calendar 指定の日付け
169         *
170         * @return      休日:true それ以外:false
171         *
172         */
173        public boolean isHoliday( final Calendar day ) {
174                String yyyymm = cal2YM( day );
175                BitSet ymData = ymMap.get( yyyymm );
176
177                if( ymData != null ) {
178                        return ymData.get( day.get( Calendar.DATE ) );
179                }
180                else {
181                        return true;    // DB 上に登録されていない場合は、すべて休日とする。
182                }
183        }
184
185        /**
186         * 指定の日付けから、範囲の間に、本日を含むかどうかを返します。
187         * 指定の日付けが、キャッシュしているデータの最大と最小の間に
188         * 存在しない場合は、常に false になります。
189         * 判定は、年月日の項目のみで比較し、時分秒は無視します。
190         *
191         * @og.rev 3.7.1.1 (2005/05/31) 新規追加
192         * @og.rev 3.8.8.6 (2007/04/20) today を毎回求めます。(キャッシュ対策)
193         *
194         * @param  day Calendar 指定の開始日付け
195         * @param       scope   範囲の日数
196         *
197         * @return      本日:true それ以外:false
198         */
199        public boolean isContainedToday( final Calendar day,final int scope ) {
200                final boolean rtnFlag;
201
202                Calendar today = Calendar.getInstance();
203                today.set( Calendar.HOUR_OF_DAY ,12 );  // 昼にセット
204                today.set( Calendar.MINUTE ,0 );
205                today.set( Calendar.SECOND ,0 );
206
207                if( scope == 1 ) {
208                        // false の確率の高い方から、比較します。
209                        rtnFlag = day.get( Calendar.DATE )  == today.get( Calendar.DATE  ) &&
210                                                day.get( Calendar.MONTH ) == today.get( Calendar.MONTH ) &&
211                                                day.get( Calendar.YEAR )  == today.get( Calendar.YEAR  ) ;
212                }
213                else {
214                        Calendar next = (Calendar)day.clone();
215                        next.add( Calendar.DATE,scope );
216                        rtnFlag = day.before( today ) && next.after( today ) ;
217                }
218                return rtnFlag ;
219        }
220
221        /**
222         * 指定の開始、終了日の期間に、平日(稼働日)が何日あるか求めます。
223         * 調査月が、データベース上に存在していない場合は、エラーとします。
224         * 開始と終了が同じ日の場合は、1を返します。
225         *
226         * @param  start Calendar 開始日付け(稼働日に含めます)
227         * @param  end   Calendar 終了日付け(稼働日に含めます)
228         *
229         * @return      稼働日数
230         *
231         */
232        public int getKadoubisu( final Calendar start,final Calendar end ) {
233
234                String stYM = cal2YM( start );
235                String edYM = cal2YM( end );
236
237                SortedMap<String,BitSet> subMap = ymMap.subMap( stYM,edYM+"\0" ) ;      // 終了キーはそのままでは含まれないため。
238
239                @SuppressWarnings("rawtypes")
240                Map.Entry[] entrys = subMap.entrySet().toArray( new Map.Entry[subMap.size()] );
241
242                int holidaySu = 0;
243                for( int i=0; i<entrys.length; i++ ) {
244                        String ym = (String)entrys[i].getKey();
245                        BitSet bt ;
246                        if( stYM.equals( ym ) ) {
247                                bt = ((BitSet)entrys[i].getValue()).get( start.get( Calendar.DATE ),31 );
248                        }
249                        else if( edYM.equals( ym ) ) {
250                                bt = ((BitSet)entrys[i].getValue()).get( 1,end.get( Calendar.DATE )+1 );
251                        }
252                        else {
253                                bt = (BitSet)entrys[i].getValue();
254                        }
255                        holidaySu += bt.cardinality() ;
256                }
257
258                long diff = start.getTimeInMillis() - end.getTimeInMillis() ;
259                int dayCount = (int)(diff/(1000*60*60*24)) + 1; // end も含むので+1必要
260
261                return dayCount - holidaySu ;
262        }
263
264        /**
265         * 指定の開始日に平日のみ期間を加算して求められる日付けを返します。
266         * これは、実稼働日計算に使用します。
267         * 例えば、start=20040810 , span=5 で、休日がなければ、10,11,12,13,14 となり、
268         * 20040815 を返します。
269         * 指定の日付けや、期間加算後の日付けが、キャッシュしているデータの
270         * 最大と最小の間に存在しない場合は、エラーとします。
271         *
272         * @param  start Calendar   開始日付け(YYYYMMDD 形式)
273         * @param       span    稼動期間
274         *
275         * @return Calendar 開始日から稼動期間を加算した日付け(当日を含む)
276         *
277         */
278        public Calendar getAfterDay( final Calendar start,final int span ) {
279                Calendar today = (Calendar)(start.clone());
280                int suSpan = span ;
281                while( suSpan > 0 ) {
282                        if( ! isHoliday( today ) ) { suSpan--; }
283                        today.add(Calendar.DATE, 1);            // 日にちを進める。
284                }
285                return today ;
286        }
287
288        /**
289         * カレンダオブジェクトより、年月を YYYYMM 形式にした 文字列を返します。
290         *
291         * @return  カレンダのYYYYMM 文字列
292         */
293        private String cal2YM( final Calendar cal ) {
294                return String.valueOf(
295                                        cal.get( Calendar.YEAR ) * 100 +
296                                        cal.get( Calendar.MONTH ) + 1 );
297        }
298
299        /**
300         * オブジェクトの識別子として,詳細なカレンダ情報を返します。
301         *
302         * @return  詳細なカレンダ情報
303         */
304        public String toString() {
305                StringBuilder rtn = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
306                rtn.append( "CLASS   : ").append( getClass().getName() ).append( HybsSystem.CR );       // クラス名
307
308                @SuppressWarnings("rawtypes")
309                Map.Entry[] entrys = ymMap.entrySet().toArray( new Map.Entry[ymMap.size()] );
310
311                for( int i=0; i<entrys.length; i++ ) {
312                        String yyyymm = (String)entrys[i].getKey();
313
314                        rtn.append( yyyymm );
315                        rtn.append( ":" );
316                        rtn.append( (BitSet)entrys[i].getValue() );
317                        rtn.append( HybsSystem.CR );
318                }
319
320                return rtn.toString();
321        }
322}