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