    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         * @og.rev 7.2.9.4 (2020/11/20) String.format でゼロ埋め対応
    066         *
    067         * @param       editPrm 開始、終了、ステップ、開始前設定値、終了後設定値 を表す引数(例：0800,2000,30)
    068         */
    069        public Selection_HM( final String editPrm ) {
    070                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    071        //      if( param.length < 3 ) {
    072        //      final String errMsg = "引数は、開始、終了、ステップ、[開始前設定値]、[終了後設定値]です。最低でも３個必要です。";
    073        //              throw new IllegalArgumentException( errMsg );
    074        //      }
    075
    076                final String[] param = editPrm == null ? new String[0] : editPrm.split( "," ) ;
    077                final String step  = param.length > 2 ? param[2].trim() : "30" ;
    078
    079                final int stepTime      = Integer.parseInt( step );
    080                if( stepTime == 0 ) {
    081                        final String errMsg = "ステップ に ０ は指定できません。無限ループします。";
    082                        throw new IllegalArgumentException( errMsg );
    083                }
    084
    085                final String start = param.length > 0 ? param[0].trim() : "0700" ;
    086                final String end   = param.length > 1 ? param[1].trim() : "1900" ;
    087                final String stOp  = param.length > 3 ? param[3].trim() : null ;
    088                final String enOp  = param.length > 4 ? param[4].trim() : null ;
    089
    090                final Calendar cal = Calendar.getInstance();
    091                calendarCalc( cal, start );
    092
    093                final Calendar endCal = Calendar.getInstance();
    094                calendarCalc( endCal, end );
    095
    096                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    097
    098                addOption( buf,stOp );          // 開始前設定値 の追加
    099
    100                // cal.before( endCal ) では、同一時刻の場合に false になる為、ここの判定では使えません。
    101                // sign を掛け算しているのは、逆順対応
    102                final int sign = stepTime > 0 ? 1 : -1 ;        // ステップの符号。
    103                while( endCal.compareTo( cal ) * sign >= 0 ) {
    104                        final int hh = cal.get( Calendar.HOUR_OF_DAY ); // 時
    105                        final int mm = cal.get( Calendar.MINUTE );              // 分
    106
    107                        // 7.2.9.4 (2020/11/20) String.format でゼロ埋め対応
    108//                      final String hVal = hh < 10 ? "0" + hh : String.valueOf( hh ) ;
    109//                      final String mVal = mm < 10 ? "0" + mm : String.valueOf( mm ) ;
    110
    111                        final String hVal = String.format( "%02d", hh );
    112                        final String mVal = String.format( "%02d", mm );
    113
    114                        // 6.0.2.5 (2014/10/31) char を append する。
    115                        buf.append( "<option value=\"" ).append( hVal ).append( mVal )
    116                                .append( "\">" ).append( hVal ).append( ':' ).append( mVal ).append( "</option>" );
    117
    118                        cal.add( Calendar.MINUTE,stepTime );            // 時刻に加えるのは、分
    119                }
    120
    121                addOption( buf,enOp );          // 終了後設定値 の追加
    122
    123                CACHE = buf.toString();
    124                ST_ED_STEP = "Start=" + start + " , End=" + end + " , Step=" + step + " , StartBefore=" + stOp + " , EndAfter=" + enOp ;
    125
    126                // キャシュの有効期間を求めるための時刻を作成します。キャッシュは、時間指定があれば、同一時間内のみ有効です。
    127                final Calendar now   = Calendar.getInstance();
    128                final boolean nowBase = start.charAt(0) == 'H' || end.charAt(0) == 'H' ;
    129                if( nowBase ) {
    130                        now.add( Calendar.HOUR   , 1 );                         // １時間進めます。
    131                        now.set( Calendar.MINUTE , 0 );                         // 分、秒 をリセットします。
    132                        now.set( Calendar.SECOND , 0 );
    133                }
    134                else {
    135                        now.add( Calendar.YEAR   , 1 );                         // １年間進めます。(現在時刻をベースに指定ない為、無制限キャッシュの意味)
    136                }
    137
    138                maxCacheTime = now.getTimeInMillis() ;
    139        }
    140
    141        /**
    142         * 開始、または 終了の文字列から、カレンダオブジェクトを作成します。
    143         * 基準となる日付に計算した結果を反映させます。
    144         *
    145         * prmB は、日付についての加減算処理を行うためのコマンドを指定します。
    146         * ・数字       ：HHMM 形式の時分です。
    147         * ・H1 ～ HXXX ：現在時刻に数字部分を＋－します。分は０に初期化されます。
    148         *
    149         * @param   cal     基準となる日付（Calendarオブジェクト）
    150         * @param   prmB        処理コマンド
    151         *
    152         */
    153        private void calendarCalc( final Calendar cal,final String prmB ) {
    154                final boolean nowBase = prmB.charAt(0) == 'H' ;
    155
    156                if( nowBase ) {
    157                        final int hour  = Integer.parseInt( prmB.substring( 1 ) );
    158                        cal.add( Calendar.HOUR_OF_DAY,hour );
    159                        cal.set( Calendar.MINUTE     ,0 );
    160                        cal.set( Calendar.SECOND     ,0 );
    161                }
    162                else {
    163                        final int hour  = Integer.parseInt( prmB.substring( 0,2 ) );
    164                        final int minute        = Integer.parseInt( prmB.substring( 2,4 ) );
    165                        cal.set( Calendar.HOUR_OF_DAY,hour );
    166                        cal.set( Calendar.MINUTE     ,minute );
    167                        cal.set( Calendar.SECOND     ,0 );
    168                }
    169        }
    170
    171        /**
    172         * 開始前設定値、または 終了後設定値の文字列から、オプション文字列を合成します。
    173         * このオプションは、引数のStringBuilder に、オプションタグを追加して返します。
    174         * optVal が null の場合は、処理しません。
    175         *
    176         * @param   buf     文字列連結する StringBuilderオブジェクト。このオブジェクトに追加します。
    177         * @param   optVal  開始前設定値、または 終了後設定値 文字列（"0000:△" 形式）
    178         *
    179         */
    180        private void addOption( final StringBuilder buf,final String optVal ) {
    181                if( optVal != null ) {
    182                        final int adrs = optVal.indexOf( ':' );
    183                        if( adrs > 0 ) {
    184                                // 6.0.2.5 (2014/10/31) char を append する。
    185                                buf.append( "<option value=\"" ).append( optVal.substring( 0,adrs ) )
    186                                        .append( "\">" ).append( optVal.substring( adrs+1 ) ).append( "</option>" );
    187                        }
    188                        // 開始前設定値 が存在する場合、"0000:△" 形式必須
    189                        else {
    190                                final String errMsg = "引数は、0000:△ 形式です。";
    191                                throw new IllegalArgumentException( errMsg );
    192                        }
    193                }
    194        }
    195
    196        /**
    197         * 初期値が選択済みの 選択肢(オプション)を返します。
    198         * このオプションは、引数の値を初期値とするオプションタグを返します。
    199         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
    200         * ツールチップ表示を行います。
    201         *
    202         * @param   selectValue  選択されている値
    203         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
    204         * @param   useShortLabel ラベル(短)をベースとしたオプション表示を行うかどうか。(未使用)
    205         *
    206         * @return  オプションタグ
    207         * @og.rtnNotNull
    208         */
    209        @Override
    210        public String getOption( final String selectValue,final boolean seqFlag, final boolean useShortLabel ) {
    211                // マッチするアドレスを探す。
    212                final int selected = CACHE.indexOf( "\"" + selectValue + "\"" );
    213
    214                if( selected < 0 ) {
    215                        if( selectValue != null && selectValue.length() > 0 ) {
    216                                final String errMsg = "時分範囲に存在しない値が指定されました。"
    217                                                        + " value=[" + selectValue + "]"
    218                                                        + CR + ST_ED_STEP ;
    219                                LogWriter.log( errMsg );
    220                        }
    221                        return CACHE;
    222                }
    223                else {
    224                        // "時分" 文字列の位置が、selected なので、時分の文字数＋２までが、前半部分になる。(時分の文字数は４固定のはず)
    225                        final int indx = selected + selectValue.length() + 2 ;
    226
    227                        final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    228                        // 3.6.0.6 (2004/10/22) シーケンスアクセス機能を指定する seqFlag を導入
    229                        if( seqFlag ) {
    230                                buf.append( "<option value=\"" ).append( selectValue ).append( '"' );           // 6.0.2.5 (2014/10/31) char を append する。
    231                        }
    232                        else {
    233                                buf.append( CACHE.substring( 0,indx ) );
    234                        }
    235                        buf.append( " selected=\"selected\"" )
    236                                .append( CACHE.substring( indx ) );
    237                        return buf.toString() ;
    238                }
    239        }
    240
    241        /**
    242         * 選択肢(value)に対するラベルを返します。
    243         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
    244         * このメソッドでは、短縮ラベルを返すかどうかを指定するフラグは使いません。
    245         * getValueLabel( XX,false ) は、getValueLabel( XX ) と同じです。
    246         *
    247         * @param       selectValue     選択肢の値
    248         * @param       isSLbl  短縮ラベルを [true:使用する/false:しない](未使用)
    249         *
    250         * @return  選択肢のラベル
    251         * @see     #getValueLabel( String )
    252         */
    253        @Override
    254        public String getValueLabel( final String selectValue,final boolean isSLbl ) {
    255                // あろうがなかろうが、選択肢そのものを返します。
    256                return selectValue;
    257        }
    258
    259        /**
    260         * オブジェクトのキャッシュが時間切れかどうかを返します。
    261         * キャッシュが時間切れ(無効)であれば、true を、有効であれば、
    262         * false を返します。
    263         *
    264         * @return  キャッシュが時間切れなら true
    265         */
    266        @Override
    267        public boolean isTimeOver() {
    268                return System.currentTimeMillis() > maxCacheTime ;
    269        }
    270}