/*
 * 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.plugin.column;

import org.opengion.hayabusa.common.HybsSystem;
import org.opengion.hayabusa.common.HybsSystemException;
import org.opengion.hayabusa.db.AbstractEditor;
import org.opengion.hayabusa.db.CellEditor;
import org.opengion.hayabusa.db.DBColumn;
import org.opengion.hayabusa.db.SelectionCellEditor;                                    // 6.2.2.0 (2015/03/27)
import org.opengion.hayabusa.db.Selection;
import org.opengion.hayabusa.db.SelectionFactory;
import org.opengion.fukurou.util.StringFormat;
import org.opengion.fukurou.util.XHTMLTag;
import org.opengion.fukurou.util.Attributes;
import org.opengion.fukurou.util.TagBuffer;
import org.opengion.fukurou.util.StringUtil;                                                    // 8.5.4.2 (2024/01/12) import static … を個別に記述

// import static org.opengion.fukurou.util.StringUtil.isNull;                   // 6.1.1.0 (2015/01/17)

/**
 * ｶﾗﾑの編集ﾊﾟﾗﾒｰﾀｰのSQL文の実行結果より、ﾌﾟﾙﾀﾞｳﾝﾒﾆｭｰを作成して
 * 編集する場合に使用するｴﾃﾞｨﾀｰｸﾗｽです。
 *
 * 編集ﾊﾟﾗﾒｰﾀには、ﾌﾟﾙﾀﾞｳﾝﾒﾆｭｰを作成するための、SQL文を記述します。
 * このSQL文は、select KEY,LABEL from xx ･･･ という構文で、KEY部分とLABEL部分が
 * 選択されます。
 * 第一ｶﾗﾑはｷｰ、第二ｶﾗﾑはﾗﾍﾞﾙでこの２つは必須です。第三ｶﾗﾑは短縮ﾗﾍﾞﾙ、
 * 第四ｶﾗﾑはｸﾞﾙｰﾌﾟ(optgroup)、第五ｶﾗﾑは色付け等に使うｸﾗｽです。
 * 第五ｶﾗﾑの指定方法には、３通りあります。
 * ここでは、
 *   ① "=" を含む場合は、そのままｾｯﾄ。(style='AAAA' など)
 *   ② disabled 単体の場合は、disabled="disabled" をｾｯﾄ
 *   ③ それ以外は、class= の後に、引数をｾｯﾄ
 * します。
 * 短縮ﾗﾍﾞﾙが設定されている場合、一覧でこのｴﾃﾞｨﾀが適用されると短縮ﾗﾍﾞﾙ表示を
 * した上でﾏｳｽｵｰﾊﾞｰ時はﾂｰﾙﾁｯﾌﾟで通常のﾗﾍﾞﾙを表示します。
 *
 * 各ｶﾗﾑの値(value値)に、AAA:BBB:CCC:DDD という値を設定できます。これは、
 * $1,$2,$3,$4 に割り当てなおして、QUERYを実行します。また、$1 は、本来の値として、
 * ﾒﾆｭｰの初期値設定等に使用します。上記の例では、AAA が値で、それ以降は、
 * 引数になります。
 * 又、$Cには自分自身のｶﾗﾑ名を割り当てます。
 * この機能を使用すれば、動的ﾒﾆｭｰを行ごとに条件を変えて作成することが
 * 可能になります。
 * 例：select KEY,LABEL from xx where KUBUN='$2' and CDK='$3'
 * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない
 * 変数は、""(ｾﾞﾛ文字列)として、扱われます。
 *
 * 編集ﾊﾟﾗﾒｰﾀに"SEQ"と記述することで正方向にしか選べないｼｰｸﾒﾆｭｰを実現できます。
 * これにより、ｼｰｹﾝｽにｽﾃｰﾀｽを順に挙げていくような、ﾌﾟﾙﾀﾞｳﾝﾒﾆｭｰ
 * を作成することが出来ます。(逆に戻れないﾒﾆｭｰ)
 *
 * ｶﾗﾑの表示に必要な属性は、DBColumn ｵﾌﾞｼﾞｪｸﾄ より取り出します。
 * このｸﾗｽは、DBColumn ｵﾌﾞｼﾞｪｸﾄ毎に1つ作成されます。
 *
 * 8.0.0.1 (2021/10/08)
 * 検索機能(絞り機能)付きのﾌﾟﾙﾀﾞｳﾝﾒﾆｭｰを作成する為には、文字ﾊﾟﾗﾒｰﾀに
 * "class=sel2sel" と入力してください。
 *
 * @og.rev 3.2.3.0 (2003/06/06) 新規作成
 * @og.rev 3.4.0.1 (2003/09/03) ＤＢ検索をﾘｱﾙﾀｲﾑに変更。
 * @og.rev 4.3.6.0 (2009/04/01) eventColumn対応
 * @og.rev 5.4.3.6 (2012/01/19) ｺﾒﾝﾄ変更
 * @og.rev 6.2.2.0 (2015/03/27) SelectionCellEditor I/Fを追加
 * @og.group ﾃﾞｰﾀ編集
 *
 * @version     4.0
 * @author      Kazuhiko Hasegawa
 * @since       JDK5.0,
 */
// 8.5.5.1 (2024/02/29) spotbugs CT_CONSTRUCTOR_THROW(ｺﾝｽﾄﾗｸﾀで、Excweptionを出さない) class を final にすれば、警告は消える。
// public class Editor_DBMENU extends AbstractEditor implements SelectionCellEditor {
public final class Editor_DBMENU extends AbstractEditor implements SelectionCellEditor {
        /** このﾌﾟﾛｸﾞﾗﾑのVERSION文字列を設定します。 {@value} */
        private static final String VERSION = "8.5.3.0 (2023/09/08)" ;

        private static final String STR_CLS = "class=" ;                                                        // 8.0.0.1 (2021/10/08)
        private static final int LEN_CLS = STR_CLS.length() ;                                           // 8.0.0.1 (2021/10/08)

        private final String query ;
        private final String dbid ;
        private final String lang ;                             // 4.0.0 (2006/11/15)
        private final boolean addNoValue ;              // 3.5.5.7 (2004/05/10)
        private final boolean seqFlag ;                 // 3.6.0.6 (2004/10/22)
        private final String useSLabel ;                // 5.5.1.0 (2012/04/03)
        private final String addKeyLabel ;              // 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式

        /**
         * ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ。
         * このｺﾝｽﾄﾗｸﾀｰで、基本ｵﾌﾞｼﾞｪｸﾄを作成します。
         *
         * @og.rev 3.4.0.1 (2003/09/03) 初期値でQUERY文をｷｰﾌﾟする。
         * @og.rev 3.6.0.6 (2004/10/22) ｼｰｹﾝｽｱｸｾｽ機能(seqFlag)を追加します
         * @og.rev 5.5.1.0 (2012/04/03) Slabel対応
         * @og.rev 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式で表示するかどうかを、指定できるようにします。
         */
        public Editor_DBMENU() {
                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
                // 4.3.4.4 (2009/01/01)
                query           = null;
                dbid            = null;
                lang            = null;                 // 4.0.0 (2006/11/15)
                addNoValue      = false;                // 3.5.5.7 (2004/05/10)
                seqFlag         = false;                // 3.6.0.6 (2004/10/22)
                useSLabel       = "auto";               // 5.5.1.0 (2012/04/03)
                addKeyLabel     = null;                 // 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式
        }

        /**
         * DBColumnｵﾌﾞｼﾞｪｸﾄを指定したprivateｺﾝｽﾄﾗｸﾀｰ。
         *
         * @og.rev 3.3.1.1 (2003/07/03) name , attributes 属性を final にする。
         * @og.rev 3.4.0.1 (2003/09/03) 継承の親元の変更に伴う実装の移動。
         * @og.rev 3.5.5.7 (2004/05/10) addNoValue 属性を追加します。
         * @og.rev 3.5.5.9 (2004/06/07) editorParam 属性が null の場合は、ｴﾗｰとします。
         * @og.rev 3.5.6.0 (2004/06/18) XHTMLTag の 内部配列 SELECT_KEY を隠蔽します。
         * @og.rev 3.6.0.6 (2004/10/22) ｼｰｹﾝｽｱｸｾｽ機能(seqFlag)を追加します
         * @og.rev 5.1.7.0 (2010/06/01) 動的ﾌﾟﾙﾀﾞｳﾝ実装見直し
         * @og.rev 5.5.1.0 (2012/04/03) Slabel対応
         * @og.rev 6.0.4.0 (2014/11/28) optionAttributes は、ｺﾝｽﾄﾗｸﾀで設定します。
         * @og.rev 6.0.4.0 (2014/11/28) useMultiSelect は、selection ではなく、colomn から取得する。
         * @og.rev 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式で表示するかどうかを、指定できるようにします。
         * @og.rev 6.4.4.2 (2016/04/01) nameのfinal化
         * @og.rev 6.9.5.0 (2018/04/23) useMultiSelect 廃止
         * @og.rev 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
         * @og.rev 8.0.0.1 (2021/10/08) dbType ﾊﾟﾗﾒｰﾀのclass属性対応
         * @og.rev 8.5.3.0 (2023/09/08) DynamicAttributes対応
         *
         * @param       clm     DBColumnｵﾌﾞｼﾞｪｸﾄ
         */
        private Editor_DBMENU( final DBColumn clm ) {
        //      super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
                super( clm );   // 6.4.4.2 (2016/04/01) nameのfinal化
        //      name            = clm.getName();
                addNoValue      = clm.isAddNoValue() ;          // 3.5.5.7 (2004/05/10)
                query           = clm.getEditorParam();
                dbid            = clm.getDbid();
                lang            = clm.getLang();                        // 4.0.0.0 (2006/11/15)
                seqFlag         = false;                                        // 3.6.0.6 (2004/10/22)
                useSLabel       = clm.getUseSLabel() ;          // 5.5.1.0 (2012/04/03)
                addKeyLabel     = clm.getAddKeyLabel();         // 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式

                // 3.5.5.9 (2004/06/07)
                if( query == null || query.isEmpty() ) {
                        final String errMsg = "DBMENU Editor では、編集パラメータは必須です。"
                                        + " name=[" + name + "]" + CR ;
                        throw new HybsSystemException( errMsg );
                }

                final String disabled = clm.isWritable() ? null : "disabled" ;

                // 6.1.1.0 (2015/01/17) Attributesの連結記述
                attributes = new Attributes()
                                        .set( "disabled"        ,disabled )
                                        .set( "size"            ,clm.getRawSize() )             // 8.5.3.0 (2023/09/08) Add
                                        .set( clm.getEditorAttributes() );                      // #addAttributes( Attributes ) の代替え

                // class設定 8.0.0.1 (2021/10/08)
                final String dbTypeParam = clm.getDbTypeParam();
                if( dbTypeParam != null ) {
                        final int st = dbTypeParam.indexOf( STR_CLS );
                        if( st >= 0 ) {
                                String newTypePram = dbTypeParam;
                                final int ed = newTypePram.indexOf( ';' , st );
                                // 文字ﾊﾟﾗﾒｰﾀの文字列から class属性の文字列を取得する
                                if( ed >= 0 ) {
                                        // [0-9]|class=sel2sel;[A-z] の場合、sel2sel を取得
                                        newTypePram = newTypePram.substring( st + LEN_CLS , ed );
                                }
                                else {
                                        // [0-9A-z]class=sel2sel の場合、sel2sel を取得
                                        newTypePram = newTypePram.substring( st + LEN_CLS );
                                }
                                // attributes に class 付与
                                attributes.add( "class" , newTypePram );
                        }
                }

//              // 6.9.5.0 (2018/04/23) useMultiSelect 廃止
//              // 6.1.1.0 (2015/01/17) TagBufferの連結記述
//              tagBuffer.add( XHTMLTag.selectAttri( attributes ) )
//                                      .add( attributes.get( "optionAttributes" ) )                                            // 6.0.4.0 (2014/11/28)
//                                      .add( "onkeydown" , "setKeySelect(this);" , clm.useMultiSelect() );     // 6.0.4.0 (2014/11/28)

                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
                // 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
                tagBuffer.add( XHTMLTag.selectAttri( attributes ) );
//                                      .add( attributes.get( "optionAttributes" ) );                                           // 6.0.4.0 (2014/11/28)
        }

        /**
         * 各ｵﾌﾞｼﾞｪｸﾄから自分のｲﾝｽﾀﾝｽを返します。
         * 自分自身をｷｬｯｼｭするのか、新たに作成するのかは、各ｻﾌﾞｸﾗｽの実装に
         * まかされます。
         *
         * @param       clm     DBColumnｵﾌﾞｼﾞｪｸﾄ
         *
         * @return      CellEditorｵﾌﾞｼﾞｪｸﾄ
         * @og.rtnNotNull
         */
        public CellEditor newInstance( final DBColumn clm ) {
                return new Editor_DBMENU( clm );
        }

        /**
         * ﾃﾞｰﾀの編集用文字列を返します。
         *
         * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、
         * QUERYを実行します。また、$1 は、本来の値として、ﾒﾆｭｰの初期値設定等に
         * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。
         * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない
         * 変数は、""(ｾﾞﾛ文字列)として、扱われます。
         * 又、$Cには自分自身のｶﾗﾑ名を割り当てます。
         *
         * @og.rev 3.4.0.1 (2003/09/03) ﾘｱﾙﾀｲﾑで値を作成する様に変更。
         * @og.rev 3.5.5.5 (2004/04/23) 新規に Attributes ｵﾌﾞｼﾞｪｸﾄを作成する方式を止めます。
         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
         * @og.rev 5.1.3.0 (2010/02/01) 一覧表示のみで、ﾂｰﾙﾁｯﾌﾟ表示を行う。
         * @og.rev 5.1.7.0 (2010/06/01) 動的ﾌﾟﾙﾀﾞｳﾝ実装見直し
         * @og.rev 5.5.1.0 (2012/04/03) Slabel対応
         *
         * @param       value   入力値
         *
         * @return      ﾃﾞｰﾀの編集用文字列
         * @og.rtnNotNull
         */
        @Override
        public String getValue( final String value ) {
                final boolean useSlbl = "true".equalsIgnoreCase( useSLabel );                   // 5.5.1.0 (2012/04/03)

                // select ﾀｸﾞの作成
                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
                return getOption(
                                new TagBuffer( "select" )
                                        .add( "name"    , name )                                                                        // 4.3.6.0 (2009/04/01)
                                        // 8.5.4.2 (2024/01/12) import static … を個別に記述
                                        .add( "id"              , name , StringUtil.isNull( attributes.get( "id" ) ) )  // 4.3.7.2 (2009/06/15)
                                        .add( tagBuffer.makeTag() )
                                , value
                                , useSlbl
                        ).makeTag() ;
        }

        /**
         * name属性を変えた、ﾃﾞｰﾀ表示/編集用のHTML文字列を作成します。
         * ﾃｰﾌﾞﾙ上の name に 行番号を付加して、名前_行番号 で登録するｷｰを作成し、
         * ﾘｸｴｽﾄ情報を1つ毎のﾌｨｰﾙﾄﾞで処理できます。
         *
         * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、
         * QUERYを実行します。また、$1 は、本来の値として、ﾒﾆｭｰの初期値設定等に
         * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。
         * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない
         * 変数は、""(ｾﾞﾛ文字列)として、扱われます。
         * 又、$Cには自分自身のｶﾗﾑ名を割り当てます。
         *
         * @og.rev 2.0.0.3 (2002/09/26) optionAttributes 属性に "$i" を使うとその行数に置き換る機能を追加。
         * @og.rev 3.4.0.1 (2003/09/03) ﾘｱﾙﾀｲﾑで値を作成する様に変更。
         * @og.rev 3.5.5.0 (2004/03/12) 名前と行番号の区切り記号("__")を、HybsSystem.JOINT_STRING に変更。
         * @og.rev 3.5.5.5 (2004/04/23) 新規に Attributes ｵﾌﾞｼﾞｪｸﾄを作成する方式を止めます。
         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
         * @og.rev 5.1.3.0 (2010/02/01) 一覧表示のみで、ﾂｰﾙﾁｯﾌﾟ表示を行う。
         * @og.rev 5.1.7.0 (2010/06/01) 動的ﾌﾟﾙﾀﾞｳﾝ実装見直し
         * @og.rev 5.5.1.0 (2012/04/03) Slabel対応
         * @og.rev 6.4.5.3 (2016/05/13) value は、ｺﾛﾝ区切りの先頭だけ分離する。
         *
         * @param       row             行番号
         * @param       value   入力値
         *
         * @return      ﾃﾞｰﾀ表示/編集用の文字列
         * @og.rtnNotNull
         */
        @Override
        public String getValue( final int row,final String value ) {
                final boolean useSlbl = "auto".equalsIgnoreCase( useSLabel ) || "true".equalsIgnoreCase( useSLabel );   // 5.5.1.0 (2012/04/03)
                final String newName = name + HybsSystem.JOINT_STRING + row;    // 4.3.6.0 (2009/04/01)
                final String newValue = StringFormat.getValue( value );                 // 6.4.5.3 (2016/05/13) ｺﾛﾝ区切りの先頭だけ

                // select ﾀｸﾞの作成
                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
                return getOption(
                                new TagBuffer( "select" )
                                        .add( "name"    , newName )                                                                             // 4.3.6.0 (2009/04/01)
                                        // 8.5.4.2 (2024/01/12) import static … を個別に記述
                                        .add( "id"              , newName , StringUtil.isNull( attributes.get( "id" ) ) )       // 4.3.7.2 (2009/06/15)
                                        .add( tagBuffer.makeTag() )
                                , value
                                , useSlbl
                        ).makeTag( row,newValue ) ;             // 6.4.5.3 (2016/05/13) ※ 元は、makeTag() でしたが、ﾊﾞｸﾞ？ の可能性がある。
        }

        /**
         * 初期値が選択済みの 選択肢(ｵﾌﾟｼｮﾝ)をTagBuffer に反映します。
         * このｵﾌﾟｼｮﾝは、引数の値を初期値とするｵﾌﾟｼｮﾝﾀｸﾞ作成し、TagBuffer
         * に値を設定して返します。
         *
         * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、
         * QUERYを実行します。また、$1 は、本来の値として、ﾒﾆｭｰの初期値設定等に
         * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。
         * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない
         * 変数は、""(ｾﾞﾛ文字列)として、扱われます。
         * 又、$Cには自分自身のｶﾗﾑ名を割り当てます。
         *
         * @og.rev 3.5.5.7 (2004/05/10) getOption( String value )の廃止を受けて、新規作成
         * @og.rev 3.6.0.6 (2004/10/22) ｼｰｹﾝｽｱｸｾｽ機能(seqFlag)を追加します
         * @og.rev 4.0.0.0 (2006/11/15) SelectionFactory に lang 属性を追加します。
         * @og.rev 4.3.4.0 (2008/12/01) $Cのｶﾗﾑ名置換えを追加
         * @og.rev 5.1.3.0 (2010/02/01) 一覧表示のみで、ﾂｰﾙﾁｯﾌﾟ表示を行う。
         * @og.rev 6.0.4.0 (2014/11/28) useMultiSelect は、selection ではなく、colomn から取得する。
         * @og.rev 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式で表示するかどうかを、指定できるようにします。
         *
         * @param       buf             ﾀｸﾞ文字列のﾊﾞｯﾌｧｰ
         * @param       value   選択されている値
         * @param       useSlbl ﾗﾍﾞﾙ(短)をﾍﾞｰｽとしたｵﾌﾟｼｮﾝ表示を行うかどうか。
         *
         * @return      ｵﾌﾟｼｮﾝﾀｸﾞ
         * @og.rtnNotNull
         */
        private TagBuffer getOption( final TagBuffer buf,final String value,final boolean useSlbl ) {

                // StringFormat format = new StringFormat( query,value);
                final StringFormat format = new StringFormat( query, value, name ); // 4.3.4.0 (2008/12/01)
                final String newQuery = format.format();
                final String newValue = format.getValue();

                // 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式
                final Selection selection = SelectionFactory.newDBSelection( newQuery, dbid, lang, addKeyLabel );
                // 6.0.4.0 (2014/11/28) useMultiSelect は、selection ではなく、colomn から取得する。

                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
                return buf.addBody( Selection.NO_VALUE_OPTION , addNoValue )                    // 5.5.1.0 (2012/04/03)
                                  .addBody( selection.getOption( newValue, seqFlag, useSlbl ) );
        }
}