/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.hayabusa.db;

import org.opengion.fukurou.system.LogWriter;                                           // 8.5.6.1 (2024/03/29)
import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 8.5.6.1 (2024/03/29)

/**
 * データのコード情報を取り扱うSelectionクラスの、NULL時オブジェクトです。
 *
 * 以前は、Selection オブジェクトが null の場合に、NullPointerException で
 * いきなりエラーで停止していましたが、この、NULLセレクションを作成することで、
 * 取りあえず、どういう状況なのか、判るようにします。
 *
 * @og.rev 5.7.3.0 (2014/02/07) 新規追加
 * @og.rev 5.7.7.1 (2014/06/13) Selectionオブジェクトの基本実装とします。
 * @og.rev 8.5.6.1 (2024/03/29) 継承で使える実装を、getOption ﾒｿｯﾄﾞに設定しておきます。
 * @og.group 選択データ制御
 *
 * @version  4.0
 * @author   Kazuhiko Hasegawa
 * @since    JDK5.0,
 */
public class Selection_NULL implements Selection {
        private final String    initMsg ;

        /** ｻﾌﾞｸﾗｽで作成される ｷｬｯｼｭ情報 */
        protected String                cache;                                  // 8.5.6.1 (2024/03/29) 親ｸﾗｽで定義

        /**
         * デフォルトコンストラクター
         * 継承元のクラスから、呼び出させるように、作成しておきます。
         *
         * @og.rev 5.7.7.1 (2014/06/13) 新規追加
         */
        public Selection_NULL() {
                initMsg = null;
                cache = "";
        }

        /**
         * 引数に初期メッセージを指定して作成する、コンストラクター
         *
         * @og.rev 5.7.3.0 (2014/02/07) 新規追加
         * @og.rev 6.2.6.0 (2015/06/19) type別Selectionの場合、ラベルリソースを使用する為、言語を引数で渡す。
         * @og.rev 6.3.4.0 (2015/08/01) Selection_NULL の引数から、lang 属性を削除します。
         *
         * @param       strCode 初期メッセージ文字列
         */
        public Selection_NULL( final String strCode ) {
                initMsg = strCode ;
                cache = "";
        }

        /**
         * 初期値が選択済みの 選択肢(オプション)を返します。
         * このオプションは、引数の値を初期値とするオプションタグを返します。
         * このクラスでは、useShortLabel は、無視されます。(常に、false です)
         *
         * @og.rev 5.7.3.0 (2014/02/07) 新規追加
         * @og.rev 8.5.6.1 (2024/03/29) 継承で使える実装を、getOption ﾒｿｯﾄﾞに設定しておきます。
         *
         * @param   selectValue  選択されている値
         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
         * @param   useShortLabel ラベル(短)をベースとしたオプション表示を行うかどうか(未使用)。
         *
         * @return  オプションタグ
         * @og.rtnNotNull
         */
        @Override       // Selection
        public String getOption( final String selectValue,final boolean seqFlag, final boolean useShortLabel ) {
                final int addIndx = findIndex( selectValue );   // 選択肢があれば、そのアドレス、なければ、-1

                if( addIndx < 0 ) { return cache; }                             // 引数の値が選択肢に存在しなかった。

                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );

                if( seqFlag ) {
                        buf.append( "<option value=\"" ).append( selectValue ).append( '"' );           // 6.0.2.5 (2014/10/31) char を append する。
                }
                else {
                        buf.append( cache.substring( 0,addIndx ) );
                }

                return buf.append( " selected=\"selected\"" )
                                        .append( cache.substring( addIndx ) )
                                        .toString() ;
        }

        /**
         * 初期値が選択済みの 選択肢(オプション)を返します。
         * このオプションは、引数の値を初期値とするオプションタグを返します。
         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
         * ツールチップ表示を行います。
         * これは、ラジオボタンやチェックボックスなど、１コードデータ単位に name を指定する
         * 場合に使います。
         * 旧 #getRadio( String , String , boolean ) メソッドの代替えです。
         * ※ このクラスでは実装されていません。→ 実装を入れます。
         *
         * @og.rev 6.0.4.0 (2014/11/28) 実装を入れます。
         * @og.rev 6.2.2.4 (2015/04/24) メソッド変更。旧 #getRadio( String , String , boolean )
         *
         * @param   name         ラジオの name
         * @param   selectValue  選択されている値
         * @param   useLabel     ラベル表示の有無 [true:有/false:無]
         *
         * @return  オプションタグ
         * @og.rtnNotNull
         */
        @Override       // Selection
        public String getOption( final String name,final String selectValue,final boolean useLabel ) {
                return initMsg + " name=[" + name + "] value=[" + selectValue + "]";
        }

        /**
         * 選択肢(value)に対するラベルを返します。
         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
         * getValueLabel( XX ) は、getValueLabel( XX,false ) と同じです。
         *
         * @param   selectValue 選択肢の値
         *
         * @return  選択肢のラベル
         * @see     #getValueLabel( String,boolean )
         */
        @Override       // Selection
        public String getValueLabel( final String selectValue ) {
                return getValueLabel( selectValue,false );
        }

        /**
         * 選択肢(value)に対するラベルを返します。
         * 無条件で、初期メッセージを返します。
         *
         * @og.rev 5.7.3.0 (2014/02/07) 新規追加
         *
         * @param       selectValue     選択肢の値
         * @param       isSLbl  短縮ラベルを [true:使用する/false:しない](未使用)
         *
         * @return  選択肢のラベル
         * @og.rtnNotNull
         * @see     #getValueLabel( String )
         */
        @Override       // Selection
        public String getValueLabel( final String selectValue,final boolean isSLbl ) {
//              return initMsg + " value=[" + selectValue + "]";

                final int addIndx = findIndex( selectValue );   // 選択肢があれば、そのアドレス、なければ、-1

                // マッチしなければ、選択肢そのものを返す。
                if( addIndx < 0 ) { return selectValue; }               // 引数の値が選択肢に存在しなかった。

                final int stIdx = addIndx + 1 ;                                 // ＋１ は、">" の位置
                final int edIdx = cache.indexOf( '<',stIdx );   // 終了アドレス

                return cache.substring( stIdx,edIdx );
        }

        /**
         * オブジェクトのキャッシュが時間切れかどうかを返します。
         * キャッシュが時間切れ(無効)であれば、true を、有効であれば、
         * false を返します。
         *
         * ※ ここでは、常に false を返します。
         *
         * @return  キャッシュが時間切れなら true
         */
        @Override       // Selection
        public boolean isTimeOver() {
                return false;
        }

        /**
         * 引数の値が選択肢(オプション)に存在しているか判定します。
         * 存在している場合は、キャッシュに対する位置(発見位置 + 引数の文字数)
         * を返し、存在しない場合は、-1 を返すとともに、LogWriter にエラー情報を
         * 書き込みます。
         *
         * PMD 7.0.0 OnlyOneReturn 用に判定と処理を一つにまとめました。
         *
         * @og.rev 8.5.6.1 (2024/03/29) 継承で使えるように、一部修正します。
         *
         * @param   selectValue  選択されている値
         * @return  キャッシュに対する位置(発見位置 + 引数の文字数)
         */
        protected int findIndex( final String selectValue ) {
                // マッチするアドレスを探す。キーの前後のダブルクオートを加味して検索
                final String selVal = "\"" + selectValue + "\"" ;

                final int rtnIdx ;
                final int indx = cache.indexOf( selVal );
                if( indx < 0 ) {
                        if( selectValue != null && selectValue.length() > 0 ) {
                                final String errMsg = "指定の値は、選択肢に存在していません。"
                                                                        + " value=[" + selectValue + "]"
                                                                        + " initMsg=[" + initMsg + "]" ;
                                LogWriter.log( errMsg );
                        }
                        rtnIdx = -1;
                }
                else {
                        rtnIdx = indx + selVal.length() ;       // selected の挿入位置
                }

                return rtnIdx;
        }

        /**
         * コードリソースのパラメータを適切な文字列に変換して返します。
         * 通常であれば、そのままセットすればよいのですが、既存の処理が、
         * class属性にセットするという仕様だったので、互換性を考慮した変換を行います。
         * ここでは、
         *   ① "=" を含む場合は、そのままセット
         *   ② disabled 単体の場合は、disabled="disabled" をセット
         *   ③ 『:』と『;』の両方が存在する場合は、style属性としてセット
         *   ④ それ以外は、class= の後に、引数をセット
         * します。
         * 今後は、パラメータに、class="AAA" とセットすることで、徐々に
         * この変換処理を無くしていきます。
         *
         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
         * @og.rev 7.4.1.0 (2021/04/23) 『:』と『;』の両方が存在する場合は、style属性としてセットする。
         * @og.rev 8.5.3.2 (2023/10/13) JDK21対応。警告: デフォルトのコンストラクタの使用で、コメントが指定されていません。 を消すため、static化。
         * @og.rev 8.5.4.2 (2024/01/12) PMD 7.0.0 LinguisticNaming 対応
         *
         * @param       buf                     変換結果を格納するStringBuilder
         * @param       paramKey        変換処理の対象となるパラメータ
//       * @return  引数と同じ、StringBuilder
         */
//      protected StringBuilder setCodeParam( final StringBuilder buf , final String paramKey ) {
//      final static protected StringBuilder setCodeParam( final StringBuilder buf , final String paramKey ) {
        final static protected void setCodeParam( final StringBuilder buf , final String paramKey ) {   // 8.5.4.2 (2024/01/12)
                if( paramKey != null && !paramKey.isEmpty() ) {
                        if( paramKey.indexOf( '=' ) > 0 ) {                                                     // ①
                                buf.append( ' ' ).append( paramKey );
                        }
                        else if( "disabled".equalsIgnoreCase( paramKey ) ) {            // ②
                                buf.append( " disabled=\"" ).append( paramKey ).append( '"' );
                        }
                        else if( paramKey.indexOf( ':' ) >=0 && paramKey.indexOf( ';' ) >=0 ) {         // ③ 7.4.1.0 (2021/04/23)
                                buf.append( " style=\"" ).append( paramKey ).append( '"' );
                        }
                        else {                                                                                                          // ④
                                buf.append( " class=\"" ).append( paramKey ).append( '"' );
                        }
                }
//              return buf ;            // 8.5.4.2 (2024/01/12) PMD 7.0.0 LinguisticNaming 対応
        }
}