    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.db;
    017
    018import org.opengion.fukurou.system.LogWriter;
    019import org.opengion.fukurou.util.HybsDateUtil;
    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.Locale;
    025import java.text.DateFormat;
    026import java.text.SimpleDateFormat;
    027
    028/**
    029 * データのコード情報を取り扱うクラスです。
    030 *
    031 * パラメータで指定した、開始、終了、ステップ、フォーマット、titleフォーマットの情報から、
    032 * HTMLのメニューやリストを作成するための オプション
    033 * タグを作成したり、与えられたキーをもとに、チェック済みのオプションタグを作成したりします。
    034 * パラメータの初期値は、開始(0)、終了(14)、ステップ(1)、フォーマット(MM/dd)、titleフォーマット(null) です。
    035 *
    036 * ここでは、日付(年/月/日）の自動生成を行います。
    037 * 基準は、実行日に対して、＋－の数字を指定します。
    038 * 例：20130206 に対して、-2,3,1 を指定すると、20130204,20130205,20130206,20130207,20130208,20130209 となります。
    039 *
    040 * 開始、終了に、特殊なコマンドを指定する事も可能です。
    041 * ・SD ：当月の最初の日付にセットします。(当月１日)
    042 * ・ED ：当月の最後の日付にセットします。(当月月末)
    043 * ・SW ：日付処理の週初め(月曜日)にセットします。日付は当日より前に移動します。
    044 * ・EW ：日付処理の週末(日曜日)にセットします。日付は当日より後ろに移動します。
    045 * ・D1 ～ DXXX ：日を指定の分だけ進めます。D1なら翌日、D200 なら200日後
    046 * ・M1 ～ MXXX ：月を指定の分だけ進めます。M1なら翌月、M6 なら半年後
    047 * ・BSD ：先月の最初の日付にセットします。(先月１日)
    048 * ・BED ：先月の最後の日付にセットします。(先月月末)
    049 * ・ASD ：翌月の最初の日付にセットします。(翌月１日)
    050 * ・AED ：翌月の最後の日付にセットします。(翌月月末)
    051 * ・M1  ：１か月先。数字部分は、任意に指定できるため、M5 とすれば、５か月先。M-2 は、２か月前
    052 *
    053 * ステップは、無指定の場合は、１日単位です。例えば、SW,M6,7 とすれば、毎週月曜日を６か月先まで作成します。
    054 * また、M1 は、１か月単位になります。ただし、開始日を SD などにしないと、大の月と小の月で、おかしくなるので
    055 * ご注意ください。
    056 *
    057 * キーは、８文字の yyyyMMdd 形式で与えられます。ラベルは、フォーマットの指定に準拠します。
    058 * フォーマットを指定する場合は、ステップは、必須となります。
    059 * フォーマットの初期値は、MM/dd です。
    060 * titleフォーマット は、tips表示する場合のフォーマットになります。初期値は、ありません。
    061 *
    062 * @og.group 選択データ制御
    063 * @og.rev 5.6.1.1 (2013/02/08) 新規追加
    064 *
    065 * @version  4.0
    066 * @author   Kazuhiko Hasegawa
    067 * @since    JDK5.0,
    068 */
    069public class Selection_YMD extends Selection_NULL {
    070        private final String   CACHE ;
    071        private final String   ST_ED_STEP ;
    072
    073        private final DateFormat lblFmt  ;
    074        private final DateFormat tipsFmt ;
    075
    076        private final long      maxCacheTime ;          // キャッシュの破棄タイミングを計るための最大有効時間
    077
    078        /**
    079         * コンストラクター
    080         *
    081         * 引数は、開始、終了、ステップ、フォーマット、titleフォーマットです。
    082         * パラメータの初期値は、開始(0)、終了(14)、ステップ(1)、フォーマット(MM/dd)、titleフォーマット(null) です。
    083         *
    084         * @og.rev 6.2.6.0 (2015/06/19) type別Selectionの場合、ラベルリソースを使用する為、言語を引数で渡す。
    085         * @og.rev 6.3.4.0 (2015/08/01) Selection_NUM の引数から、lang 属性を削除します。
    086         *
    087         * @param       editPrm 開始、終了、ステップ、フォーマット、titleフォーマットを表す引数(-2,3,1)
    088         */
    089        public Selection_YMD( final String editPrm ) {
    090                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    091        //      if( param.length < 2 ) {
    092        //      final String errMsg = "引数は、開始、終了、[ステップ]、[フォーマット]、 [titleフォーマット]です。最低でも２個必要です。";
    093        //              throw new IllegalArgumentException( errMsg );
    094        //      }
    095
    096                final String[] param = editPrm == null  ? new String[0] : editPrm.split( "," ) ;
    097
    098                final String start   = param.length > 0 ? param[0].trim() : "0" ;
    099                final String end     = param.length > 1 ? param[1].trim() : "14" ;
    100
    101                final String step    = param.length > 2 ? param[2].trim() : "1" ;
    102                final String lblPrm  = param.length > 3 ? param[3].trim() : "MM/dd" ;
    103                final String tipsPrm = param.length > 4 ? param[4].trim() : "MM月dd日(EEE)" ;
    104
    105                final Calendar cal = Calendar.getInstance();
    106                HybsDateUtil.calendarCalc( cal , start );
    107
    108                final Calendar endCal = Calendar.getInstance();
    109                HybsDateUtil.calendarCalc( endCal , end );
    110
    111                final DateFormat keyFmt  = new SimpleDateFormat( "yyyyMMdd",Locale.JAPAN );                                     // キーとなるフォーマット。yyyyMMdd 固定
    112                lblFmt  = new SimpleDateFormat( lblPrm,Locale.JAPAN );                                                                  // ラベルのフォーマット
    113                // 6.0.2.5 (2014/10/31) null でないことがわかっている値の冗長な null チェックがあります。
    114                tipsFmt = new SimpleDateFormat( tipsPrm,Locale.JAPAN );                                                                 // titleフォーマット
    115
    116                ST_ED_STEP = "Start=" + lblFmt.format( cal.getTime() ) +
    117                                         " , End=" + lblFmt.format( endCal.getTime() ) + " , Step=" + step ;
    118
    119                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    120
    121                // cal.before( endCal ) では、同一時刻の場合に false になる為、ここの判定では使えません。
    122                // sign を掛け算しているのは、逆順対応
    123                final int sign = step.indexOf( '-' ) < 0 ? 1 : -1 ;     // ステップの符号。
    124                while( endCal.compareTo( cal ) * sign >= 0 ) {
    125                        final String key  = keyFmt.format( cal.getTime() );
    126                        final String val  = lblFmt.format( cal.getTime() );
    127
    128                        buf.append( '>' ).append( val )                                         // 6.0.2.5 (2014/10/31) char を append する。
    129                                .append( "</option><option value=\"" ).append( key )
    130                                .append("\" title=\"").append( tipsFmt.format( cal.getTime() ) )
    131                                .append( "\">" ).append( val ).append( "</option>" );
    132
    133                        HybsDateUtil.calendarCalc( cal , step );
    134                }
    135
    136                CACHE = buf.toString();
    137
    138                // キャシュの有効期間を求めるための時刻を作成します。キャッシュは、当日のみ有効です。
    139                final Calendar now   = Calendar.getInstance();
    140                now.set( Calendar.HOUR   , 0 );                         // 時、分、秒 をリセットします。
    141                now.set( Calendar.MINUTE , 0 );
    142                now.set( Calendar.SECOND , 0 );
    143                now.add( Calendar.DAY_OF_MONTH , 1 );           // 1日進めます。
    144
    145                maxCacheTime = now.getTimeInMillis() ;
    146        }
    147
    148        /**
    149         * 初期値が選択済みの 選択肢(オプション)を返します。
    150         * このオプションは、引数の値を初期値とするオプションタグを返します。
    151         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
    152         * ツールチップ表示を行います。
    153         *
    154         * @param   selectValue  選択されている値
    155         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
    156         * @param   useShortLabel ラベル(短)をベースとしたオプション表示を行うかどうか。(未使用)
    157         *
    158         * @return  オプションタグ
    159         * @og.rtnNotNull
    160         */
    161        @Override
    162        public String getOption( final String selectValue,final boolean seqFlag, final boolean useShortLabel ) {
    163                // マッチするアドレスを探す。
    164                final int selected = CACHE.indexOf( "\"" + selectValue + "\"" );
    165
    166                if( selected < 0 ) {
    167                        if( selectValue != null && selectValue.length() > 0 ) {
    168                                final String errMsg = "年月日範囲に存在しない値が指定されました。"
    169                                                        + " value=[" + selectValue + "]"
    170                                                        + CR + ST_ED_STEP ;
    171                                LogWriter.log( errMsg );
    172                        }
    173                        return CACHE;
    174                }
    175                else {
    176                        // "年月日" 文字列の位置が、selected なので、年月日の文字数＋２までが、前半部分になる。(年月日の文字数は８固定のはず)
    177                        final int indx = selected + selectValue.length() + 2 ;
    178
    179                        final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    180                        // 3.6.0.6 (2004/10/22) シーケンスアクセス機能を指定する seqFlag を導入
    181                        if( seqFlag ) {
    182                                buf.append( "<option value=\"" ).append( selectValue ).append( '"' );           // 6.0.2.5 (2014/10/31) char を append する。
    183                        }
    184                        else {
    185                                buf.append( CACHE.substring( 0,indx ) );
    186                        }
    187                        buf.append( " selected=\"selected\"" )
    188                                .append( CACHE.substring( indx ) );
    189                        return buf.toString() ;
    190                }
    191        }
    192
    193        /**
    194         * 選択肢(value)に対するラベルを返します。
    195         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
    196         * このメソッドでは、短縮ラベルを返すかどうかを指定するフラグを指定します。
    197         * getValueLabel( XX,false ) は、getValueLabel( XX ) と同じです。
    198         *
    199         * @og.rev 4.0.0.0 (2005/11/30) を追加
    200         *
    201         * @param       selectValue     選択肢の値
    202         * @param       isSLbl  短縮ラベルを [true:使用する/false:しない]
    203         *
    204         * @return  選択肢のラベル
    205         * @og.rtnNotNull
    206         * @see     #getValueLabel( String )
    207         */
    208        @Override
    209        public String getValueLabel( final String selectValue,final boolean isSLbl ) {
    210                // 選択肢があろうとなかろうと、フォーマット変換して値を返す。
    211
    212                final Calendar cal = HybsDateUtil.getCalendar( selectValue );
    213
    214                // 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
    215                return isSLbl && tipsFmt != null
    216                                ? "<span title=\"" + tipsFmt.format( cal.getTime() ) + "\">" + lblFmt.format( cal.getTime() ) + "</span>"
    217                                : lblFmt.format( cal.getTime() );
    218        }
    219
    220        /**
    221         * オブジェクトのキャッシュが時間切れかどうかを返します。
    222         * キャッシュが時間切れ(無効)であれば、true を、有効であれば、
    223         * false を返します。
    224         *
    225         * @og.rev 4.0.0.0 (2005/01/31) 新規作成
    226         *
    227         * @return  キャッシュが時間切れなら true
    228         */
    229        @Override
    230        public boolean isTimeOver() {
    231                return System.currentTimeMillis() > maxCacheTime ;
    232        }
    233}