    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.plugin.column;
    017
    018import org.opengion.hayabusa.common.HybsSystem;
    019import org.opengion.hayabusa.db.AbstractEditor;
    020import org.opengion.hayabusa.db.CellEditor;
    021import org.opengion.hayabusa.db.DBColumn;
    022import org.opengion.hayabusa.db.SelectionCellEditor;                                    // 6.2.2.0 (2015/03/27)
    023import org.opengion.hayabusa.db.Selection;
    024import org.opengion.hayabusa.db.SelectionFactory;                                               // 5.7.3.0 (2014/02/07)
    025import org.opengion.fukurou.util.Attributes;
    026import org.opengion.fukurou.util.TagBuffer;
    027import org.opengion.fukurou.util.XHTMLTag;
    028
    029/**
    030 * BITBOX エディターは、カラムのデータをコードリソースに対応した
    031 * チェックボックスで編集する場合に使用するクラスです。
    032 * このチェックボックスは、複数選択されたコードリソースの値を、
    033 * BIT演算で、論理和した結果のデータで管理します。
    034 *
    035 * 一覧登録する場合は、チェックボックスのみ表示されます。
    036 * ラベル表示が必要な場合は、編集パラメータに、"useLabel"と
    037 * 記述しておくことで、ラベルを出力することが可能です。
    038 *
    039 * 例)
    040 *   コードリソースには、1,2,4,8,… とBitを表す数を指定します。
    041 *   これを、チェックボックスで複数選択し、値を論理和で加算します。
    042 *
    043 * このエディタはeventColumnに対応していません。
    044 *
    045 * カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
    046 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
    047 *
    048 * @og.rev 6.2.2.4 (2015/04/24) 新規作成
    049 * @og.group データ編集
    050 *
    051 * @version  6.2
    052 * @author       Kazuhiko Hasegawa
    053 * @since    JDK8.0,
    054 */
    055public class Editor_BITBOX extends AbstractEditor implements SelectionCellEditor {
    056        /** このプログラムのVERSION文字列を設定します。   {@value} */
    057        private static final String VERSION = "7.0.5.1 (2019/09/27)" ;
    058
    059        private final Selection selection ;
    060        private final boolean writable  ;
    061        private final boolean useLabel  ;               // 4.3.3.0 (2008/10/01)
    062
    063        private String errMsg   ;                               // 6.0.4.0 (2014/11/28)
    064
    065        /**
    066         * デフォルトコンストラクター。
    067         * このコンストラクターで、基本オブジェクトを作成します。
    068         *
    069         * @og.rev 6.2.2.4 (2015/04/24) 新規追加
    070         */
    071        public Editor_BITBOX() {
    072                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    073                selection = null;
    074                writable  = false;
    075                useLabel  = false;              // 4.3.3.0 (2008/10/01)
    076        }
    077
    078        /**
    079         * DBColumnオブジェクトを指定したprivateコンストラクター。
    080         *
    081         * @og.rev 6.2.2.4 (2015/04/24) 新規追加
    082         * @og.rev 6.4.4.2 (2016/04/01) nameのfinal化
    083         * @og.rev 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
    084         *
    085         * @param       clm     DBColumnオブジェクト
    086         */
    087        private Editor_BITBOX( final DBColumn clm ) {
    088        //      super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    089                super( clm );   // 6.4.4.2 (2016/04/01) nameのfinal化
    090        //      name  = clm.getName();
    091
    092                final String addKeyLabel = clm.getAddKeyLabel();                // 6.2.0.0 (2015/02/27) キー:ラベル形式
    093
    094                // 5.7.3.0 (2014/02/07) SelectionFactory 対応
    095                selection = SelectionFactory.newSelection( "BITBOX" , clm.getCodeData(), addKeyLabel );
    096
    097                // 6.0.4.0 (2014/11/28) selection が null の場合、警告表示します。
    098                if( selection == null ) {
    099                        errMsg = "codeData が未設定です。"
    100                                                                + " name="  + name
    101                                                                + " label=" + clm.getLabel()
    102                                                                + " editType="  + clm.getEditor() ;
    103                        System.out.println( errMsg );
    104                }
    105
    106                writable = clm.isWritable();
    107
    108                // 6.1.1.0 (2015/01/17) Attributesの連結記述
    109                attributes = new Attributes()
    110                                        .set( clm.getEditorAttributes() )                               // #addAttributes( Attributes ) の代替え
    111                                        .add( "class","BITBOX" );
    112
    113                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    114                // 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
    115                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
    116//                               .add( attributes.get( "optionAttributes" ) );          // 6.0.4.0 (2014/11/28)
    117
    118                // 4.3.3.0 (2008/10/01)
    119                useLabel = "useLabel".equalsIgnoreCase( clm.getEditorParam() ) ;
    120        }
    121
    122        /**
    123         * 各オブジェクトから自分のインスタンスを返します。
    124         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
    125         * まかされます。
    126         *
    127         * @og.rev 6.2.2.4 (2015/04/24) 新規追加
    128         *
    129         * @param       clm     DBColumnオブジェクト
    130         *
    131         * @return      CellEditorオブジェクト
    132         * @og.rtnNotNull
    133         */
    134        public CellEditor newInstance( final DBColumn clm ) {
    135                return new Editor_BITBOX( clm );
    136        }
    137
    138        /**
    139         * データの編集用文字列を返します。
    140         *
    141         * @og.rev 6.2.2.4 (2015/04/24) 新規追加
    142         *
    143         * @param       value 入力値
    144         *
    145         * @return      データの編集用文字列
    146         * @og.rtnNotNull
    147         */
    148        @Override
    149        public String getValue( final String value ) {
    150                // 6.0.4.0 (2014/11/28) selection が null の場合、警告表示します。
    151                if( selection == null ) {
    152                        return "<span class=\"error\">" + errMsg + " value=" + value + "</span>";
    153                }
    154
    155                // 6.4.1.1 (2016/01/16) ３項演算子で対応。
    156                final String bitbox = writable
    157                                                                ? selection.getOption( name,value,true )
    158                                                                : selection.getValueLabel( value,true );
    159
    160                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    161                return new TagBuffer( "pre" )
    162                                        .add( tagBuffer.makeTag() )
    163                                        .addBody( bitbox )
    164                                        .makeTag();
    165        }
    166
    167        /**
    168         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
    169         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、
    170         * リクエスト情報を１つ毎のフィールドで処理できます。
    171         *
    172         * @og.rev 6.2.2.4 (2015/04/24) 新規追加
    173         *
    174         * @param       row   行番号
    175         * @param       value 入力値
    176         *
    177         * @return      データ表示/編集用の文字列
    178         * @og.rtnNotNull
    179         */
    180        @Override
    181        public String getValue( final int row,final String value ) {
    182                // 6.0.4.0 (2014/11/28) selection が null の場合、警告表示します。
    183                if( selection == null ) {
    184                        return "<span class=\"error\">" + errMsg + " value=" + value + " row=" + row + "</span>";
    185                }
    186
    187                // 6.4.1.1 (2016/01/16) ３項演算子で対応。
    188                final String bitbox = writable
    189                                                                ? selection.getOption( name + HybsSystem.JOINT_STRING + row,value,useLabel )
    190                                                                : selection.getValueLabel( value,useLabel );
    191
    192                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    193                return new TagBuffer( "pre" )
    194                                        .add( tagBuffer.makeTag() )
    195                                        .addBody( bitbox )
    196                                        .makeTag( row,value );
    197        }
    198}