    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 java.util.Calendar;
    019import java.util.Locale;
    020import java.text.DateFormat;
    021import java.text.SimpleDateFormat;
    022
    023import org.opengion.hayabusa.common.HybsSystem;
    024import org.opengion.fukurou.util.LogWriter;
    025import org.opengion.fukurou.util.HybsDateUtil;
    026
    027/**
    028 * データのコード情報を取り扱うクラスです。
    029 *
    030 * パラメータで指定した、開始、終了、ステップ、フォーマット、titleフォーマットの情報から、
    031 * HTMLのメニューやリストを作成するための オプション
    032 * タグを作成したり、与えられたキーをもとに、チェック済みのオプションタグを作成したりします。
    033 * パラメータの初期値は、開始(0)、終了(14)、ステップ(1)、フォーマット(MM/dd)、titleフォーマット(null) です。
    034 *
    035 * ここでは、日付(年/月/日）の自動生成を行います。
    036 * 基準は、実行日に対して、＋－の数字を指定します。
    037 * 例：20130206 に対して、-2,3,1 を指定すると、20130204,20130205,20130206,20130207,20130208,20130209 となります。
    038 *
    039 * 開始、終了に、特殊なコマンドを指定する事も可能です。
    040 * ・SD ：当月の最初の日付にセットします。(当月１日)
    041 * ・ED ：当月の最後の日付にセットします。(当月月末)
    042 * ・SW ：日付処理の週初め(月曜日)にセットします。日付は当日より前に移動します。
    043 * ・EW ：日付処理の週末(日曜日)にセットします。日付は当日より後ろに移動します。
    044 * ・D1 ～ DXXX ：日を指定の分だけ進めます。D1なら翌日、D200 なら200日後
    045 * ・M1 ～ MXXX ：月を指定の分だけ進めます。M1なら翌月、M6 なら半年後
    046 * ・BSD ：先月の最初の日付にセットします。(先月１日)
    047 * ・BED ：先月の最後の日付にセットします。(先月月末)
    048 * ・ASD ：翌月の最初の日付にセットします。(翌月１日)
    049 * ・AED ：翌月の最後の日付にセットします。(翌月月末)
    050 * ・M1  ：１か月先。数字部分は、任意に指定できるため、M5 とすれば、５か月先。M-2 は、２か月前
    051 *
    052 * ステップは、無指定の場合は、１日単位です。例えば、SW,M6,7 とすれば、毎週月曜日を６か月先まで作成します。
    053 * また、M1 は、１か月単位になります。ただし、開始日を SD などにしないと、大の月と小の月で、おかしくなるので
    054 * ご注意ください。
    055 *
    056 * キーは、８文字の yyyyMMdd 形式で与えられます。ラベルは、フォーマットの指定に準拠します。
    057 * フォーマットを指定する場合は、ステップは、必須となります。
    058 * フォーマットの初期値は、MM/dd です。
    059 * titleフォーマット は、tips表示する場合のフォーマットになります。初期値は、ありません。
    060 *
    061 * @og.group 選択データ制御
    062 * @og.rev 5.6.1.1 (2013/02/08) 新規追加
    063 *
    064 * @version  4.0
    065 * @author   Kazuhiko Hasegawa
    066 * @since    JDK5.0,
    067 */
    068// public class Selection_YMD implements Selection {
    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         * @param       editPrm 開始、終了、ステップ、フォーマット、titleフォーマットを表す引数(-2,3,1)
    085         */
    086        public Selection_YMD( final String editPrm ) {
    087        //      if( param.length < 2 ) {
    088        //              String errMsg = "引数は、開始、終了、[ステップ]、[フォーマット]、 [titleフォーマット]です。最低でも２個必要です。";
    089        //              throw new IllegalArgumentException( errMsg );
    090        //      }
    091
    092                String[] param = (editPrm == null) ? new String[0] : editPrm.split( "," ) ;
    093
    094                String start   = (param.length > 0) ? param[0].trim() : "0" ;
    095                String end     = (param.length > 1) ? param[1].trim() : "14" ;
    096
    097                String step    = (param.length > 2) ? param[2].trim() : "1" ;
    098                String lblPrm  = (param.length > 3) ? param[3].trim() : "MM/dd" ;
    099                String tipsPrm = (param.length > 4) ? param[4].trim() : "MM月dd日(EEE)" ;
    100
    101                Calendar cal = Calendar.getInstance();
    102                HybsDateUtil.calendarCalc( cal , start );
    103
    104                Calendar endCal = Calendar.getInstance();
    105                HybsDateUtil.calendarCalc( endCal , end );
    106
    107                DateFormat keyFmt  = new SimpleDateFormat( "yyyyMMdd",Locale.JAPAN );                                   // キーとなるフォーマット。yyyyMMdd 固定
    108                lblFmt  = new SimpleDateFormat( lblPrm,Locale.JAPAN );                                                                  // ラベルのフォーマット
    109                tipsFmt = ( tipsPrm != null ) ? new SimpleDateFormat( tipsPrm,Locale.JAPAN ) : null ;   // titleフォーマット
    110
    111                ST_ED_STEP = "Start=" + lblFmt.format( cal.getTime() ) +
    112                                         " , End=" + lblFmt.format( endCal.getTime() ) + " , Step=" + step ;
    113
    114                StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
    115
    116                // cal.before( endCal ) では、同一時刻の場合に false になる為、ここの判定では使えません。
    117                // sign を掛け算しているのは、逆順対応
    118                int sign = ( step.indexOf( '-' ) < 0 ) ? 1 : -1 ;       // ステップの符号。
    119                while( endCal.compareTo( cal ) * sign >= 0 ) {
    120                        String key  = keyFmt.format( cal.getTime() );
    121                        String val  = lblFmt.format( cal.getTime() );
    122
    123                        buf.append( "<option value=\"" ).append( key ).append( "\"" );
    124                        if( tipsFmt != null ) {
    125                                String tips = tipsFmt.format( cal.getTime() ) ;
    126                                buf.append(" title=\"").append( tips ).append("\"");
    127                        }
    128                        buf.append( ">" ).append( val ).append( "</option>" );
    129
    130                        HybsDateUtil.calendarCalc( cal , step );
    131                }
    132
    133                CACHE = buf.toString();
    134
    135                // キャシュの有効期間を求めるための時刻を作成します。キャッシュは、当日のみ有効です。
    136                Calendar now   = Calendar.getInstance();
    137                now.set( Calendar.HOUR   , 0 );                         // 時、分、秒 をリセットします。
    138                now.set( Calendar.MINUTE , 0 );
    139                now.set( Calendar.SECOND , 0 );
    140                now.add( Calendar.DAY_OF_MONTH , 1 );           // 1日進めます。
    141
    142                maxCacheTime = now.getTimeInMillis() ;
    143        }
    144
    145        /**
    146         * 初期値が選択済みの 選択肢(オプション)を返します。
    147         * このオプションは、引数の値を初期値とするオプションタグを返します。
    148         * このメソッドでは、ラベル(短)が設定されている場合でも、これを使用せずに必ずラベル(長)を使用します。
    149         *
    150         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能を指定する seqFlag を導入
    151         * @og.rev 4.0.0.0 (2005/01/31) selectValue が、null/ゼロ文字列でない場合に、選択肢にない場合は、エラー
    152         * @og.rev 5.7.7.1 (2014/06/13) Selection_NULL を 継承するため、削除
    153         *
    154         * @param   selectValue  選択されている値
    155         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
    156         *
    157         * @return  オプションタグ
    158         * @see     #getOption( String, boolean, boolean )
    159         */
    160//      public String getOption( final String selectValue,final boolean seqFlag ) {
    161//              return getOption( selectValue, seqFlag, false );
    162//      }
    163
    164        /**
    165         * 初期値が選択済みの 選択肢(オプション)を返します。
    166         * このオプションは、引数の値を初期値とするオプションタグを返します。
    167         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
    168         * ツールチップ表示を行います。
    169         *
    170         * @param   selectValue  選択されている値
    171         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
    172         * @param   useShortLabel ラベル(短)をベースとしたオプション表示を行うかどうか。(未使用)
    173         *
    174         * @return  オプションタグ
    175         * @see     #getOption( String, boolean )
    176         */
    177        @Override
    178        public String getOption( final String selectValue,final boolean seqFlag, final boolean useShortLabel ) {
    179                // マッチするアドレスを探す。
    180                int selected = CACHE.indexOf( "\"" + selectValue + "\"" );
    181
    182                if( selected < 0 ) {
    183                        if( selectValue != null && selectValue.length() > 0 ) {
    184                                String errMsg = "年月日範囲に存在しない値が指定されました。"
    185                                                        + " value=[" + selectValue + "]"
    186                                                        + HybsSystem.CR + ST_ED_STEP ;
    187                                LogWriter.log( errMsg );
    188                        }
    189                        return CACHE;
    190                }
    191                else {
    192                        // "年月日" 文字列の位置が、selected なので、年月日の文字数＋２までが、前半部分になる。(年月日の文字数は８固定のはず)
    193                        int indx = selected + selectValue.length() + 2 ;
    194
    195                        StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
    196                        // 3.6.0.6 (2004/10/22) シーケンスアクセス機能を指定する seqFlag を導入
    197                        if( seqFlag ) {
    198                                buf.append( "<option value=\"" ).append( selectValue ).append( "\"" );
    199                        }
    200                        else {
    201                                buf.append( CACHE.substring( 0,indx ) );
    202                        }
    203                        buf.append( " selected=\"selected\"" );
    204                        buf.append( CACHE.substring( indx ) );
    205                        return buf.toString() ;
    206                }
    207        }
    208
    209        /**
    210         * 初期値が選択済みの 選択肢(オプション)を返します。
    211         * このオプションは、引数の値を初期値とするオプションタグを返します。
    212         * ※ このクラスでは実装されていません。
    213         *
    214         * @og.rev 2.1.0.1 (2002/10/17) 選択リストを、正方向にしか選べないようにする sequenceFlag を導入する
    215         * @og.rev 3.8.6.0 (2006/09/29) useLabel 属性 追加
    216         * @og.rev 5.7.7.1 (2014/06/13) Selection_NULL を 継承するため、削除
    217         *
    218         * @param   name         ラジオの name
    219         * @param   selectValue  選択されている値
    220         * @param   useLabel     ラベル表示の有無 [true:有/false:無]
    221         *
    222         * @return  オプションタグ
    223         */
    224//      public String getRadio( final String name,final String selectValue,final boolean useLabel ) {
    225//              String errMsg = "このクラスでは実装されていません。";
    226//              throw new UnsupportedOperationException( errMsg );
    227//      }
    228
    229        /**
    230         * 初期値が選択済みの 選択肢(オプション)を返します。
    231         * このオプションは、引数の値を初期値とするオプションタグを返します。
    232         * ※ このクラスでは実装されていません。
    233         *
    234         * @og.rev 5.7.7.1 (2014/06/13) Selection_NULL を 継承するため、削除
    235         *
    236         * @param   selectValue  選択されている値
    237         *
    238         * @return  オプションタグ
    239         */
    240//      public String getRadioLabel( final String selectValue ) {
    241//              String errMsg = "このクラスでは実装されていません。";
    242//              throw new UnsupportedOperationException( errMsg );
    243//      }
    244
    245        /**
    246         * 選択肢(value)に対するラベルを返します。
    247         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
    248         * getValueLabel( XX ) は、getValueLabel( XX,false ) と同じです。
    249         *
    250         * @og.rev 5.7.7.1 (2014/06/13) Selection_NULL を 継承するため、削除
    251         *
    252         * @param   selectValue 選択肢の値
    253         *
    254         * @return  選択肢のラベル
    255         * @see     #getValueLabel( String,boolean )
    256         */
    257//      public String getValueLabel( final String selectValue ) {
    258//              return getValueLabel( selectValue,false );
    259//      }
    260
    261        /**
    262         * 選択肢(value)に対するラベルを返します。
    263         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
    264         * このメソッドでは、短縮ラベルを返すかどうかを指定するフラグを指定します。
    265         * getValueLabel( XX,false ) は、getValueLabel( XX ) と同じです。
    266         *
    267         * @og.rev 4.0.0.0 (2005/11/30) を追加
    268         *
    269         * @param       selectValue     選択肢の値
    270         * @param       flag    短縮ラベルを [true:使用する/false:しない]
    271         *
    272         * @return  選択肢のラベル
    273         * @see     #getValueLabel( String )
    274         */
    275        @Override
    276        public String getValueLabel( final String selectValue,final boolean flag ) {
    277                // 選択肢があろうとなかろうと、フォーマット変換して値を返す。
    278
    279                Calendar cal = HybsDateUtil.getCalendar( selectValue );
    280
    281                if( flag && tipsFmt != null ) {
    282                        return "<span title=\"" + tipsFmt.format( cal.getTime() ) + "\">" + lblFmt.format( cal.getTime() ) + "</span>";
    283                }
    284                else {
    285                        return lblFmt.format( cal.getTime() );
    286                }
    287        }
    288
    289        /**
    290         * マルチ・キーセレクトを使用するかどうかを返します。
    291         * true：使用する。false:使用しない です。
    292         * ただし、実際に使用するかどうかは、HTML出力時に決めることが出来ます。
    293         * ここでは、USE_MULTI_KEY_SELECT が true で、USE_SIZE(=20)以上の場合に
    294         * true を返します。
    295         *
    296         * @og.rev 3.5.5.7 (2004/05/10) 新規作成
    297         * @og.rev 5.7.7.1 (2014/06/13) Selection_NULL を 継承するため、削除
    298         *
    299         * @return  選択リストで、マルチ・キーセレクトを使用するかどうか(true:使用する)(false固定)
    300         */
    301//      public boolean useMultiSelect() {
    302//              return false;
    303//      }
    304
    305        /**
    306         * オブジェクトのキャッシュが時間切れかどうかを返します。
    307         * キャッシュが時間切れ(無効)であれば、true を、有効であれば、
    308         * false を返します。
    309         *
    310         * @og.rev 4.0.0.0 (2005/01/31) 新規作成
    311         *
    312         * @return  キャッシュが時間切れなら true
    313         */
    314        @Override
    315        public boolean isTimeOver() {
    316                return System.currentTimeMillis() > maxCacheTime ;
    317        }
    318}