    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;
    019
    020import org.opengion.fukurou.system.LogWriter;
    021import static org.opengion.fukurou.system.HybsConst.CR ;                                // 6.1.0.0 (2014/12/26)
    022import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 6.1.0.0 (2014/12/26) refactoring
    023
    024/**
    025 * データのコード情報を取り扱うクラスです。
    026 *
    027 * 開始、終了、ステップの情報から、HTMLのメニューやリストを作成するための オプション
    028 * タグを作成したり、与えられたキーをもとに、チェック済みのオプションタグを作成したりします。
    029 *
    030 * ここでは、時間(時:分）の自動生成を行います。パラメータで、開始、終了、ステップ、開始前設定値、終了後設定値
    031 * を指定できます。
    032 * キーは、４文字の HHMM 形式で与えられます。ラベルは、HH:MM になります。
    033 * ステップは、分単位です。つまり、１時間の場合は、"60" と指定します。"0100"ではありません。
    034 * 開始前設定値、終了後設定値はそれぞれ、開始の前と終了の後ろに特別に値を設定できます。
    035 *
    036 * 開始、または、終了に、現在時刻からの相対値を指定する事ができます。
    037 * H1 ～ HXXX とすれば、現在時刻の時に数字部分を＋－します。分は０に初期化されます。
    038 *
    039 * パラメータの初期値は、開始(0700)、終了(1900)、ステップ(30)、開始前設定値(null)、終了後設定値(null) です。
    040 *
    041 * 例：0800,2000,30  → 0800,0830,0900,0930,1000,・・・1900,1930,2000 のプルダウン
    042 * 例：0800,2000,30,0000:△,2400:▽  → 0000,0800,0830,0900,0930,1000,・・・1900,1930,2000,2400 のプルダウン
    043 *
    044 * @og.group 選択データ制御
    045 * @og.rev 5.6.1.1 (2013/02/08) 新規追加
    046 *
    047 * @version  4.0
    048 * @author   Kazuhiko Hasegawa
    049 * @since    JDK5.0,
    050 */
    051public class Selection_HM extends Selection_NULL {
    052        private final String   CACHE ;
    053        private final String   ST_ED_STEP ;
    054
    055        private final long      maxCacheTime ;          // キャッシュの破棄タイミングを計るための最大有効時間
    056
    057        /**
    058         * コンストラクター
    059         *
    060         * 引数は、開始、終了、ステップ、開始前設定値、終了後設定値 です。
    061         * パラメータの初期値は、開始(0700)、終了(1900)、ステップ(30)、開始前設定値(null)、終了後設定値(null) です。
    062         *
    063         * @og.rev 6.2.6.0 (2015/06/19) type別Selectionの場合、ラベルリソースを使用する為、言語を引数で渡す。
    064         * @og.rev 6.3.4.0 (2015/08/01) Selection_HM の引数から、lang 属性を削除します。
    065         *
    066         * @param       editPrm 開始、終了、ステップ、開始前設定値、終了後設定値 を表す引数(例：0800,2000,30)
    067         */
    068        public Selection_HM( final String editPrm ) {
    069                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    070        //      if( param.length < 3 ) {
    071        //      final String errMsg = "引数は、開始、終了、ステップ、[開始前設定値]、[終了後設定値]です。最低でも３個必要です。";
    072        //              throw new IllegalArgumentException( errMsg );
    073        //      }
    074
    075                final String[] param = editPrm == null ? new String[0] : editPrm.split( "," ) ;
    076                final String step  = param.length > 2 ? param[2].trim() : "30" ;
    077
    078                final int stepTime      = Integer.parseInt( step );
    079                if( stepTime == 0 ) {
    080                        final String errMsg = "ステップ に ０ は指定できません。無限ループします。";
    081                        throw new IllegalArgumentException( errMsg );
    082                }
    083
    084                final String start = param.length > 0 ? param[0].trim() : "0700" ;
    085                final String end   = param.length > 1 ? param[1].trim() : "1900" ;
    086                final String stOp  = param.length > 3 ? param[3].trim() : null ;
    087                final String enOp  = param.length > 4 ? param[4].trim() : null ;
    088
    089                final Calendar cal = Calendar.getInstance();
    090                calendarCalc( cal, start );
    091
    092                final Calendar endCal = Calendar.getInstance();
    093                calendarCalc( endCal, end );
    094
    095                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    096
    097                addOption( buf,stOp );          // 開始前設定値 の追加
    098
    099                // cal.before( endCal ) では、同一時刻の場合に false になる為、ここの判定では使えません。
    100                // sign を掛け算しているのは、逆順対応
    101                final int sign = stepTime > 0 ? 1 : -1 ;        // ステップの符号。
    102                while( endCal.compareTo( cal ) * sign >= 0 ) {
    103                        final int hh = cal.get( Calendar.HOUR_OF_DAY ); // 時
    104                        final int mm = cal.get( Calendar.MINUTE );              // 分
    105
    106                        final String hVal = hh < 10 ? "0" + hh : String.valueOf( hh ) ;
    107                        final String mVal = mm < 10 ? "0" + mm : String.valueOf( mm ) ;
    108
    109                        // 6.0.2.5 (2014/10/31) char を append する。
    110                        buf.append( "<option value=\"" ).append( hVal ).append( mVal )
    111                                .append( "\">" ).append( hVal ).append( ':' ).append( mVal ).append( "</option>" );
    112
    113                        cal.add( Calendar.MINUTE,stepTime );            // 時刻に加えるのは、分
    114                }
    115
    116                addOption( buf,enOp );          // 終了後設定値 の追加
    117
    118                CACHE = buf.toString();
    119                ST_ED_STEP = "Start=" + start + " , End=" + end + " , Step=" + step + " , StartBefore=" + stOp + " , EndAfter=" + enOp ;
    120
    121                // キャシュの有効期間を求めるための時刻を作成します。キャッシュは、時間指定があれば、同一時間内のみ有効です。
    122                final Calendar now   = Calendar.getInstance();
    123                final boolean nowBase = start.charAt(0) == 'H' || end.charAt(0) == 'H' ;
    124                if( nowBase ) {
    125                        now.add( Calendar.HOUR   , 1 );                         // １時間進めます。
    126                        now.set( Calendar.MINUTE , 0 );                         // 分、秒 をリセットします。
    127                        now.set( Calendar.SECOND , 0 );
    128                }
    129                else {
    130                        now.add( Calendar.YEAR   , 1 );                         // １年間進めます。(現在時刻をベースに指定ない為、無制限キャッシュの意味)
    131                }
    132
    133                maxCacheTime = now.getTimeInMillis() ;
    134        }
    135
    136        /**
    137         * 開始、または 終了の文字列から、カレンダオブジェクトを作成します。
    138         * 基準となる日付に計算した結果を反映させます。
    139         *
    140         * prmB は、日付についての加減算処理を行うためのコマンドを指定します。
    141         * ・数字       ：HHMM 形式の時分です。
    142         * ・H1 ～ HXXX ：現在時刻に数字部分を＋－します。分は０に初期化されます。
    143         *
    144         * @param   cal     基準となる日付（Calendarオブジェクト）
    145         * @param   prmB        処理コマンド
    146         *
    147         */
    148        private void calendarCalc( final Calendar cal,final String prmB ) {
    149                final boolean nowBase = prmB.charAt(0) == 'H' ;
    150
    151                if( nowBase ) {
    152                        final int hour  = Integer.parseInt( prmB.substring( 1 ) );
    153                        cal.add( Calendar.HOUR_OF_DAY,hour );
    154                        cal.set( Calendar.MINUTE     ,0 );
    155                        cal.set( Calendar.SECOND     ,0 );
    156                }
    157                else {
    158                        final int hour  = Integer.parseInt( prmB.substring( 0,2 ) );
    159                        final int minute        = Integer.parseInt( prmB.substring( 2,4 ) );
    160                        cal.set( Calendar.HOUR_OF_DAY,hour );
    161                        cal.set( Calendar.MINUTE     ,minute );
    162                        cal.set( Calendar.SECOND     ,0 );
    163                }
    164        }
    165
    166        /**
    167         * 開始前設定値、または 終了後設定値の文字列から、オプション文字列を合成します。
    168         * このオプションは、引数のStringBuilder に、オプションタグを追加して返します。
    169         * optVal が null の場合は、処理しません。
    170         *
    171         * @param   buf     文字列連結する StringBuilderオブジェクト。このオブジェクトに追加します。
    172         * @param   optVal  開始前設定値、または 終了後設定値 文字列（"0000:△" 形式）
    173         *
    174         */
    175        private void addOption( final StringBuilder buf,final String optVal ) {
    176                if( optVal != null ) {
    177                        final int adrs = optVal.indexOf( ':' );
    178                        if( adrs > 0 ) {
    179                                // 6.0.2.5 (2014/10/31) char を append する。
    180                                buf.append( "<option value=\"" ).append( optVal.substring( 0,adrs ) )
    181                                        .append( "\">" ).append( optVal.substring( adrs+1 ) ).append( "</option>" );
    182                        }
    183                        // 開始前設定値 が存在する場合、"0000:△" 形式必須
    184                        else {
    185                                final String errMsg = "引数は、0000:△ 形式です。";
    186                                throw new IllegalArgumentException( errMsg );
    187                        }
    188                }
    189        }
    190
    191        /**
    192         * 初期値が選択済みの 選択肢(オプション)を返します。
    193         * このオプションは、引数の値を初期値とするオプションタグを返します。
    194         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
    195         * ツールチップ表示を行います。
    196         *
    197         * @param   selectValue  選択されている値
    198         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
    199         * @param   useShortLabel ラベル(短)をベースとしたオプション表示を行うかどうか。(未使用)
    200         *
    201         * @return  オプションタグ
    202         * @og.rtnNotNull
    203         */
    204        @Override
    205        public String getOption( final String selectValue,final boolean seqFlag, final boolean useShortLabel ) {
    206                // マッチするアドレスを探す。
    207                final int selected = CACHE.indexOf( "\"" + selectValue + "\"" );
    208
    209                if( selected < 0 ) {
    210                        if( selectValue != null && selectValue.length() > 0 ) {
    211                                final String errMsg = "時分範囲に存在しない値が指定されました。"
    212                                                        + " value=[" + selectValue + "]"
    213                                                        + CR + ST_ED_STEP ;
    214                                LogWriter.log( errMsg );
    215                        }
    216                        return CACHE;
    217                }
    218                else {
    219                        // "時分" 文字列の位置が、selected なので、時分の文字数＋２までが、前半部分になる。(時分の文字数は４固定のはず)
    220                        final int indx = selected + selectValue.length() + 2 ;
    221
    222                        final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    223                        // 3.6.0.6 (2004/10/22) シーケンスアクセス機能を指定する seqFlag を導入
    224                        if( seqFlag ) {
    225                                buf.append( "<option value=\"" ).append( selectValue ).append( '"' );           // 6.0.2.5 (2014/10/31) char を append する。
    226                        }
    227                        else {
    228                                buf.append( CACHE.substring( 0,indx ) );
    229                        }
    230                        buf.append( " selected=\"selected\"" )
    231                                .append( CACHE.substring( indx ) );
    232                        return buf.toString() ;
    233                }
    234        }
    235
    236        /**
    237         * 選択肢(value)に対するラベルを返します。
    238         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
    239         * このメソッドでは、短縮ラベルを返すかどうかを指定するフラグは使いません。
    240         * getValueLabel( XX,false ) は、getValueLabel( XX ) と同じです。
    241         *
    242         * @param       selectValue     選択肢の値
    243         * @param       isSLbl  短縮ラベルを [true:使用する/false:しない](未使用)
    244         *
    245         * @return  選択肢のラベル
    246         * @see     #getValueLabel( String )
    247         */
    248        @Override
    249        public String getValueLabel( final String selectValue,final boolean isSLbl ) {
    250                // あろうがなかろうが、選択肢そのものを返します。
    251                return selectValue;
    252        }
    253
    254        /**
    255         * オブジェクトのキャッシュが時間切れかどうかを返します。
    256         * キャッシュが時間切れ(無効)であれば、true を、有効であれば、
    257         * false を返します。
    258         *
    259         * @return  キャッシュが時間切れなら true
    260         */
    261        @Override
    262        public boolean isTimeOver() {
    263                return System.currentTimeMillis() > maxCacheTime ;
    264        }
    265}