    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.taglib;
    017
    018import org.opengion.hayabusa.common.HybsSystemException;
    019import org.opengion.fukurou.util.Attributes;
    020import org.opengion.fukurou.util.StringUtil;
    021import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
    022
    023import static org.opengion.fukurou.util.StringUtil.nval ;
    024
    025/**
    026 * 検索結果の DBTableModelオブジェクトのカラム値を操作(設定、変換、ADDなど)するタグです。
    027 *
    028 * entry タグの子タグとして使用します。entryタグと、このcolumnSetタグの command
    029 * が同じ場合のみ、実行されます。
    030 * 処理方法は、action で指定します。
    031 *
    032 * @og.formSample
    033 * ●形式：&lt;og:entry command="…"&gt;
    034 *             &lt;og:setColumn
    035 *                 command   ="…"          : entryタグのcommandと一致する場合に実行
    036 *                 columnId  ="…"          : 処理を行うカラムＩＤを指定(必須,複数指定可)
    037 *                 action    ="…"          : 処理方法を指定
    038 *                 value     ="…"          : 設定する値を指定(action="TBLSET"のみ[カラム名]使用可能)
    039 *                 conditionKey  ="…"      : 条件判定するカラムＩＤを指定(初期値は columnId )
    040 *                 conditionList ="…"      : 条件判定する値のリストを、"|"で区切って登録(初期値は、無条件)
    041 *             /&gt;
    042 *         &lt;/og:entry&gt;
    043 * ●body：なし
    044 *
    045 * ●Tag定義：
    046 *   &lt;og:columnSet
    047 *       command            【TAG】コマンド (INSERT/COPY/MODIFY/DELETE/ENTRY/CHANGE/RESET/ALLRESET/ALLACTION/RESETDATA/INSERTONE/REALDELETE/REQENTRY/RAWSET)を設定します
    048 *       columnId         ○【TAG】カラムＩＤをセットします(複数指定時は、CSV形式で設定する)(必須)。
    049 *       value              【TAG】値をセットします
    050 *       action             【TAG】アクション(DEFAULT/CLEAR/ADD/SET/NULLSET/LOWER/UPPER/COPY/TBLSET/TBLNULLSET/WRTCTRL/DBMENU/REQSET/SEQSET)をセットします
    051 *       conditionKey       【TAG】条件判定するカラムＩＤを指定します(初期値は columnId )
    052 *       conditionList      【TAG】条件判定する値のリストを、"|"で区切って登録します(初期値:無条件)
    053 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
    054 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
    055 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
    056 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
    057 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
    058 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    059 *   /&gt;
    060 *
    061 * ●使用例
    062 *    &lt;og:entry command="{&#064;command}"  &gt;
    063 *        &lt;og:columnSet command="{&#064;command}" columnId="ECNO"   action="CLEAR" /&gt;
    064 *        &lt;og:columnSet command="{&#064;command}" columnId="JYOKYO" action="SET" value="1" /&gt;
    065 *    &lt;/og:entry&gt;
    066 *
    067 *    &lt;og:entry command="MODIFY" rows="1" &gt;
    068 *        &lt;og:columnSet command="MODIFY" columnId="key" action="TBLSET" value ="[key][lang]"/&gt;
    069 *    &lt;/og:entry&gt;
    070 *
    071 *    command属性 は、entryタグのcommand属性と同一の場合のみ、処理します。
    072 *    [command属性]
    073 *      INSERT     新規
    074 *      COPY       複写
    075 *      MODIFY     変更
    076 *      DELETE     削除
    077 *      ENTRY      エントリー
    078 *      CHANGE     チェンジ
    079 *      RESET      リセット
    080 *      ALLRESET   全件リセット
    081 *      ALLACTION  オールアクション
    082 *      RESETDATA  リセットデータ
    083 *      INSERTONE  新規(1行のみ)
    084 *      REALDELETE 物理削除
    085 *      REQENTRY   リクエスト変数設定
    086 *      RAWSET     DBTableModelに直接セット                   7.2.9.0 (2020/10/12)
    087 *
    088 *    [action属性]
    089 *      DEFAULT カラムリソースで定義した初期値をセットします。
    090 *      CLEAR   値をクリア(ゼロストリング &quot;&quot; )します。
    091 *      ADD     現在の値を ＋１ します。  0 ⇒ 1 , A ⇒ B , 9 ⇒ 10。value属性と併用すれば、指定の値を加算できます。
    092 *      SET     value で設定した値を 新しい値として登録します。
    093 *      NULLSET 元の値が NULL の場合だけ、value で設定した新しい値を登録します。
    094 *      LOWER   小文字に変換します。
    095 *      UPPER   大文字に変換します。
    096 *      COPY    value にコピー元のカラムIDをセットすれば、その値を代入します。
    097 *      TBLSET  DBTableModel の内容を取り込んで指定の columnId カラムに設定します。
    098 *              [カラム名] で指定できます。
    099 *              また、これは文字列を解析して、 value を作成しますので,文字列連結等に使用できます。
    100 *      TBLNULLSET 元の値が NULL の場合だけ、TBLSETを実行します。         6.9.9.0 (2018/08/20) 追加
    101 *      WRTCTRL writableControl を使用したカラムデータの先頭アンダーバーを削除します。
    102 *      DBMENU  DBMENUでパラメータ設定(コロン連結文字)を使用したカラムデータの先頭データのみにします。
    103 *      REQSET  valueで指定したカラムの値をキーに、リクエスト変数から値を取出し、セットします。
    104 *      SEQSET  valueの初期値を利用して、１レコードごとに、＋１した値をセットします。
    105 *      PREFIX  valueの値を後ろから検索し、指定のカラム値の前半部分を取得します(記号は含みません)。
    106 *      SUFIX   valueの値を後ろから検索し、指定のカラム値の後半部分を取得します(記号は含みません)。
    107 *      その他  カラムのDBType の valueAction メソッドを呼び出します。自由に設定可能です。
    108 *
    109 * @og.group 画面登録
    110 *
    111 * @version  4.0
    112 * @author       Kazuhiko Hasegawa
    113 * @since    JDK5.0,
    114 */
    115public class ColumnSetTag extends CommonTagSupport {
    116        /** このプログラムのVERSION文字列を設定します。   {@value} */
    117        private static final String VERSION = "6.7.4.1 (2017/02/17)" ;
    118        private static final long serialVersionUID = 674120170217L ;
    119
    120        private String columnId         ;
    121        private String conditionKey ;
    122
    123        /**
    124         * デフォルトコンストラクター
    125         *
    126         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    127         */
    128        public ColumnSetTag() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    129
    130        /**
    131         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    132         *
    133         * @og.rev 3.6.0.6 (2004/10/22) columnNo に伴なう削除
    134         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
    135         *
    136         * @return      後続処理の指示(SKIP_BODY)
    137         */
    138        @Override
    139        public int doStartTag() {
    140                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
    141                if( useTag() ) {
    142                        final EntryTag entry = (EntryTag)findAncestorWithClass( this,EntryTag.class );
    143                        if( entry == null ) {
    144                                final String errMsg = "<b>" + getTagName() + "タグは、EntryTag のBODY部に記述される必要があります。</b>";
    145                                throw new HybsSystemException( errMsg );
    146                        }
    147
    148                        final Attributes standardAttri = getAttributes();
    149                        final String[] clms = StringUtil.csv2Array( columnId );
    150                        for( int i=0; i<clms.length; i++ ) {
    151                                // 6.1.1.0 (2015/01/17) Attributesの連結記述
    152                                entry.setAttributes(
    153                                        new Attributes( standardAttri )
    154                                                .set( "columnId"        , clms[i] )
    155                                                .set( "conditionKey", nval( conditionKey,clms[i] ) )    // conditionKey が null の場合は、columnId が設定される。
    156                                );
    157                        }
    158                }
    159
    160                return SKIP_BODY ;
    161        }
    162
    163        /**
    164         * タグリブオブジェクトをリリースします。
    165         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    166         *
    167         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
    168         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    169         * @og.rev 3.6.0.6 (2004/10/22) columnNo に伴なう変更
    170         *
    171         */
    172        @Override
    173        protected void release2() {
    174                super.release2();
    175                columnId         = null;
    176                conditionKey = null;
    177        }
    178
    179        /**
    180         * 【TAG】コマンド (INSERT/COPY/MODIFY/DELETE/ENTRY/CHANGE/RESET/ALLRESET/ALLACTION/RESETDATA/INSERTONE/REALDELETE/REQENTRY/RAWSET)を設定します。
    181         *
    182         * @og.tag
    183         * 上位の EntryTag のコマンドと一致した場合のみ、処理されます。
    184         * ここでは、コマンド文字列の整合性チェックは行っていません。
    185         *
    186         * @param       command コマンド
    187         * @see         <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.EntryTag.CMD_INSERT">コマンド定数</a>
    188         */
    189        public void setCommand( final String command ) {
    190                set( "command",getRequestParameter( command ) );
    191        }
    192
    193        /**
    194         * 【TAG】値をセットします。
    195         *
    196         * @og.tag
    197         * 設定する値をセットします。
    198         * 曖昧検索可能フィールド(aimai)の影響で、パラメータに、"%" がくるので、前後の "%" を削除します。
    199         * 今は、"%" を前後にセットする方法は、ありません(無条件削除のみ)。
    200         *
    201         * @og.rev 6.7.4.1 (2017/02/17) 曖昧検索可能フィールドで、"%" がそのままセットされてしまうため、削除します。
    202         *
    203         * @param       value 値
    204         */
    205        public void setValue( final String value ) {
    206
    207                String reqVal = getRequestParameter( value );
    208
    209                if( reqVal != null ) {
    210                        int len = reqVal.length();
    211                        if( len > 0 && reqVal.charAt(0) == '%' ) {
    212                                reqVal = reqVal.substring(1);                           // 先頭の "%" を削除
    213                                len-- ;
    214                        }
    215
    216                        if( len > 0 && reqVal.charAt(len-1) == '%' ) {
    217                                reqVal = reqVal.substring( 0,len-1 );           // 末尾の "%" を削除
    218                        }
    219                }
    220
    221                set( "value" , reqVal );
    222        }
    223
    224        /**
    225         * 【TAG】アクション(DEFAULT/CLEAR/ADD/SET/NULLSET/LOWER/UPPER/COPY/TBLSET/TBLNULLSET/WRTCTRL/DBMENU/REQSET/SEQSET/PREFIX/SUFIX)をセットします。
    226         *
    227         * @og.tag
    228         * ここでは、アクション文字列の整合性チェックを行っておりません。
    229         *
    230         * DEFAULT カラムリソースで定義した初期値をセットします。
    231         * CLEAR   値をクリア(ゼロストリング &quot;&quot; )します。
    232         * ADD     現在の値を ＋１ します。  0 ⇒ 1 , A ⇒ B , 9 ⇒ 10。value属性と併用すれば、指定の値を加算できます。
    233         * SET     value で設定した値を 新しい値として登録します。
    234         * NULLSET 元の値が NULL の場合だけ、value で設定した新しい値を登録します。
    235         * LOWER   小文字に変換します。
    236         * UPPER   大文字に変換します。
    237         * COPY    value にコピー元のカラムIDをセットすれば、その値を代入します。
    238         * TBLSET  DBTableModel の内容を取り込んで指定の columnId カラムに設定します。[カラム名] で指定できます。
    239         * TBLNULLSET 元の値が NULL の場合だけ、TBLSETを実行します。      6.9.9.0 (2018/08/20) 追加
    240         * WRTCTRL writableControl を使用したカラムデータの先頭アンダーバーを削除します。
    241         * DBMENU  DBMENUでパラメータ設定(コロン連結文字)を使用したカラムデータの先頭データのみにします。
    242         * REQSET  valueで指定したカラムの値をキーに、リクエスト変数から値を取出し、セットします。
    243         * SEQSET  valueの初期値を利用して、１レコードごとに、＋１した値をセットします。
    244         * PREFIX  valueの値を後ろから検索し、指定のカラム値の前半部分を取得します(記号は含みません)。
    245         * SUFIX   valueの値を後ろから検索し、指定のカラム値の後半部分を取得します(記号は含みません)。
    246         * その他  カラムのDBType の valueAction メソッドを呼び出します。自由に設定可能です。
    247         *
    248         * @param       action アクション文字列
    249         * @see         <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.EntryTag.ACT_DEFAULT">アクション定数</a>
    250         */
    251        public void setAction( final String action ) {
    252                set( "action",getRequestParameter( action ) );
    253        }
    254
    255        /**
    256         * 【TAG】カラムＩＤをセットします(複数指定時は、CSV形式で設定する)。
    257         *
    258         * @og.tag
    259         * 処理を適用するカラムＩＤを指定します。
    260         * 全く同じ内容を設定する場合には、カラム名をCSV形式で
    261         * 複数指定することが可能です。
    262         *
    263         * @og.rev 3.6.0.6 (2004/10/22) columnNo に伴なう変更
    264         *
    265         * @param       clmid カラムＩＤ
    266         */
    267        public void setColumnId( final String clmid ) {
    268                columnId = getRequestParameter( clmid );
    269        }
    270
    271        /**
    272         * 【TAG】条件判定するカラムＩＤを指定します(初期値:null)。
    273         *
    274         * @og.tag
    275         * 指定のカラムＩＤの値と、conditionList の値を比較して、
    276         * 存在する場合は、action処理を実行します。
    277         * 例えば、初期値設定(action="DEFAULT")で、値が "0" の場合だけ適用するような
    278         * ケースに使用できます。
    279         * 指定しない場合は、columnId と同じキーになります。
    280         * 注意：columnId は、CSV形式で複数同時に指定できます。その場合は、
    281         * conditionKey には、複数設定する機能はありませんので、全カラムに
    282         * 同一カラムを使用する場合は、conditionKey に値を設定できます。
    283         * 値を設定しない場合は、自動的に、columnId と同一になります。
    284         *
    285         * @og.rev 3.6.0.6 (2004/10/22) 新規追加
    286         *
    287         * @param       key カラムＩＤ
    288         * @see         #setConditionList( String )
    289         */
    290        public void setConditionKey( final String key ) {
    291                conditionKey = nval( getRequestParameter( key ),null ) ;
    292        }
    293
    294        /**
    295         * 【TAG】条件判定する値のリストを、"|"で区切って登録します(初期値:無条件)。
    296         *
    297         * @og.tag
    298         * conditionKey とペアで指定します。ここには、カラムの設定値のリストを
    299         * 指定することで、複数条件(ＯＲ結合)での比較を行い、リストにカラム値が
    300         * 存在する場合のみ、action処理を実行します。
    301         * 設定しない場合は、無条件に実行します。
    302         *
    303         * @og.rev 3.6.0.6 (2004/10/22) 新規追加
    304         *
    305         * @param       list 条件判定する値("|"区切)
    306         * @see         #setConditionKey( String )
    307         */
    308        public void setConditionList( final String list ) {
    309                set( "conditionList","|" + getRequestParameter( list ) + "|" );
    310        }
    311
    312        /**
    313         * 【TAG】(通常は使いません)カラムＩＤが存在しないときに無視するかどうかを指定します(初期値:true)。
    314         *
    315         * @og.tag
    316         * カラムセットする場合は、DBTableModel に存在するカラムに対してのみ、
    317         * 処理を適用するべきで、通常存在しないカラムを使用した場合は、Exception が
    318         * throw されます。(strictCheck="true" 初期値の動作です。)
    319         * ところが、動的テーブル検索などでカラムが不特定な場合、DBTableModel に
    320         * 存在しない場合に、無視したい場合があります。その場合は、strictCheck="false"
    321         * に設定すると、カラムが存在しない場合は、エラーにせず、無視します。
    322         * 初期値は、true:厳格に処理する です。
    323         *
    324         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
    325         *
    326         * @param       strict 厳格処理 [true:厳格に処理する/false:エラーを無視する]
    327         */
    328        public void setStrictCheck( final String strict ) {
    329                set( "strictCheck",getRequestParameter( strict ) );
    330        }
    331
    332        /**
    333         * このオブジェクトの文字列表現を返します。
    334         * 基本的にデバッグ目的に使用します。
    335         *
    336         * @return このクラスの文字列表現
    337         * @og.rtnNotNull
    338         */
    339        @Override
    340        public String toString() {
    341                return ToString.title( this.getClass().getName() )
    342                                .println( "VERSION"             ,VERSION                )
    343                                .println( "columnId"    ,columnId               )
    344                                .println( "conditionKey",conditionKey   )
    345                                .println( "Other..."    ,getAttributes().getAttribute() )
    346                                .fixForm().toString() ;
    347        }
    348}