    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.hayabusa.resource.LabelInterface;
    020import org.opengion.fukurou.util.StringUtil;
    021
    022import static org.opengion.fukurou.util.StringUtil.nval ;
    023
    024/**
    025 * 画面にラベルリソース等のメッセージを表示させるタグです。
    026 *
    027 * lbl 属性に ラベルリソース のキーを与えることで、 ロケールにあわせたリソースを使用して、
    028 * 画面に表示します。
    029 * 違う値をセットした場合は、 セットした値が、そのまま出力されます。これは、ロケールが
    030 * 見つからなかった場合の標準の対応方法です。
    031 * ロケールは、ユーザー情報の lang 属性を初期値で使用し、 セットされていない場合は、
    032 * リクエスト情報のロケールから取得します。
    033 * lbl 属性を使用する場合、val0 ～ val9 までの引数を使用することができます。これは、
    034 * メッセージフォーマットの、引数 {0} ～ {9} に対応して割り付けられます。
    035 *
    036 * @og.formSample
    037 * ●形式：&lt;og:message lbl="…" val0=[…] … /&gt;
    038 * ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{&#064;XXXX} を解析します)
    039 *
    040 * ●Tag定義：
    041 *   &lt;og:message
    042 *       lbl                【TAG】ラベルリソースのラベルIDを指定します
    043 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
    044 *       command            【TAG】コマンド(INSERT,COPY,MODIFY,DELETE)をセットします
    045 *       comment            【TAG】コメントを指定します
    046 *       type               【TAG】タイプを(Label,Short,Tips,Description)から指定します(初期値:Label)
    047 *       val0               【TAG】メッセージの引数{0}を指定します
    048 *       val1               【TAG】メッセージの引数{1}を指定します
    049 *       val2               【TAG】メッセージの引数{2}を指定します
    050 *       val3               【TAG】メッセージの引数{3}を指定します
    051 *       val4               【TAG】メッセージの引数{4}を指定します
    052 *       val5               【TAG】メッセージの引数{5}を指定します
    053 *       val6               【TAG】メッセージの引数{6}を指定します
    054 *       val7               【TAG】メッセージの引数{7}を指定します
    055 *       val8               【TAG】メッセージの引数{8}を指定します
    056 *       val9               【TAG】メッセージの引数{9}を指定します
    057 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
    058 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
    059 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:true)
    060 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:true)
    061 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    062 *   &gt;   ... Body ...
    063 *   &lt;/og:message&gt;
    064 *
    065 * ●使用例
    066 *     &lt;og:message lbl=&quot;MSG0032&quot; language=&quot;ja&quot; /&gt;
    067 *
    068 *        lbl       : MessageResource.properties のキー
    069 *        language  : ロケール(オプション)
    070 *
    071 *     例１)
    072 *         &lt;og:message lbl=&quot;MSG0032&quot; &gt;検索条件&lt;/og:message&gt;
    073 *
    074 *        BODY 部分は、無視されます。コメント等に使用できます。
    075 *        HTMLファイルには、コメント部分は出力されません。
    076 *
    077 * @og.group 画面部品
    078 *
    079 * @version  4.0
    080 * @author   Kazuhiko Hasegawa
    081 * @since    JDK5.0,
    082 */
    083public class MessageTag extends CommonTagSupport {
    084        //* このプログラムのVERSION文字列を設定します。   {@value} */
    085        private static final String VERSION = "5.2.2.0 (2010/11/01)" ;
    086
    087        private static final long serialVersionUID = 522020101101L ;
    088
    089        private String          comment = null;
    090        private String[]        values  = null;
    091        // 4.0.0 (2005/01/31) メッセージの種類を指定できるようにします。
    092        private String          type    = "Label" ;     // Label,Short,Tips,Description が指定できます。
    093        private String          cmdMsg  = null;
    094
    095        private static final String[] TYPE_LIST = new String[] { "Label","Short","Tips","Description" };
    096
    097        /**
    098         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    099         *
    100         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    101         *
    102         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
    103         */
    104        @Override
    105        public int doStartTag() {
    106                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    107                if( useTag() ) {
    108                        return EVAL_BODY_BUFFERED ;     // Body を評価する。( extends BodyTagSupport 時)
    109                }
    110                return SKIP_BODY ;                              // Body を評価しない
    111        }
    112
    113        /**
    114         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    115         *
    116         * @og.rev 3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。
    117         *
    118         * @return      後続処理の指示(SKIP_BODY)
    119         */
    120        @Override
    121        public int doAfterBody() {
    122                String str = getBodyString();
    123
    124                if( str != null && str.length() > 0 ) {
    125                        comment = StringUtil.htmlFilter( str );
    126                }
    127
    128                return SKIP_BODY ;
    129        }
    130
    131        /**
    132         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    133         *
    134         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    135         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    136         *
    137         * @return      後続処理の指示
    138         */
    139        @Override
    140        public int doEndTag() {
    141                debugPrint();           // 4.0.0 (2005/02/28)
    142                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    143                if( useTag() ) {
    144                        jspPrint( makeTag() );
    145                }
    146                return EVAL_PAGE ;
    147        }
    148
    149        /**
    150         * タグリブオブジェクトをリリースします。
    151         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    152         *
    153         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
    154         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    155         *
    156         */
    157        @Override
    158        protected void release2() {
    159                super.release2();
    160                comment = null;
    161                values  = null;
    162                type    = "Label" ;     // Label,Short,Tips,Description が指定できます。
    163                cmdMsg  = null;
    164        }
    165
    166        /**
    167         * 表示用の文字列を指定します。
    168         *
    169         * @og.rev 4.0.0.0 (2005/01/31) タイプ別メッセージ情報を返します。
    170         * @og.rev 4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage ⇒ getResource().getLabel )
    171         *
    172         * @return  変換後の文字列
    173         */
    174        private String makeTag() {
    175                String val  = null;
    176
    177                LabelInterface label = getLabelInterface();
    178
    179                char ch = type.charAt( 0 );     // Label,Short,Tips,Description
    180                if( label != null ) {
    181                        switch( ch ) {
    182                                case 'L': val = label.getMessage( values ); break;
    183                                case 'S': val = label.getShortLabel(); break;
    184                                case 'T': val = label.getLongLabel(); break;
    185                                case 'D': val = label.getDescription(); break;
    186                                default : break;
    187                        }
    188                }
    189                else {
    190                        if( cmdMsg != null ) {
    191                                // cmdMsg = INSERT,COPY,MODIFY,DELETE,null
    192                                val = getResource().getLabel( cmdMsg );
    193                        }
    194                        else {
    195                                val = comment;
    196                        }
    197                }
    198
    199                return val;
    200        }
    201
    202        /**
    203         * 【TAG】コメントを指定します。
    204         *
    205         * @og.tag
    206         * msg 属性でメッセージリソースから読み取りますが,開発途中で
    207         * リソース登録を済ましていない状態でコメントを入れる場合に、
    208         * 直接コメントをかけるようにします。
    209         *
    210         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
    211         * @og.rev 3.0.0.0 (2002/12/25) StringUtil#changeString 廃止
    212         *
    213         * @param   cmnt コメント文字列
    214         */
    215        public void setComment( final String cmnt ) {
    216                comment = cmnt;
    217        }
    218
    219        /**
    220         * 【TAG】タイプを(Label,Short,Tips,Description)から指定します(初期値:Label)。
    221         *
    222         * @og.tag
    223         * タイプは、ラベル／メッセージリソースのどの情報を取得したいかを指定できます。
    224         * 従来のラベル／メッセージは、Label に相当します。
    225         * なお、指定は、それぞれの頭文字('L','S','T','D')のみでも可能です。
    226         * 初期値は、"Label" です。
    227         * ・Label  : ラベル／メッセージ表示
    228         * ・Short  : 表形式で使用する短いラベル表示
    229         * ・Tips   : ラベルの上にTips表示
    230         * ・Description : 概要説明を表示
    231         *
    232         * @og.rev 4.0.0.0 (2005/01/31) 新規登録
    233         *
    234         * @param   tp タイプ文字列('L','S','T','D','B')
    235         */
    236        public void setType( final String tp ) {
    237                type = nval( getRequestParameter( tp ),type );
    238
    239                char ch = type.charAt( 0 );     // Label,Short,Tips,Description
    240
    241                if( "LSTD".indexOf( ch ) < 0 ) {
    242                        String errMsg = "type に、指定不可能な文字が設定されました。type=[" + type
    243                                        + "] TYPE_LIST=[" + StringUtil.array2csv( TYPE_LIST ) + "]";
    244                        throw new HybsSystemException( errMsg );
    245                }
    246        }
    247
    248        /**
    249         * 【TAG】メッセージの引数{0}を指定します。
    250         *
    251         * @og.tag メッセージの引数を指定します。
    252         *
    253         * @param   value メッセージの引数
    254         */
    255        public void setVal0( final String value ) { setValues( 0, value ); }
    256
    257        /**
    258         * 【TAG】メッセージの引数{1}を指定します。
    259         *
    260         * @og.tag メッセージの引数を指定します。
    261         *
    262         * @param   value メッセージの引数
    263         */
    264        public void setVal1( final String value ) { setValues( 1, value ); }
    265
    266        /**
    267         * 【TAG】メッセージの引数{2}を指定します。
    268         *
    269         * @og.tag メッセージの引数を指定します。
    270         *
    271         * @param   value メッセージの引数
    272         */
    273        public void setVal2( final String value ) { setValues( 2, value ); }
    274
    275        /**
    276         * 【TAG】メッセージの引数{3}を指定します。
    277         *
    278         * @og.tag メッセージの引数を指定します。
    279         *
    280         * @param   value メッセージの引数
    281         */
    282        public void setVal3( final String value ) { setValues( 3, value ); }
    283
    284        /**
    285         * 【TAG】メッセージの引数{4}を指定します。
    286         *
    287         * @og.tag メッセージの引数を指定します。
    288         *
    289         * @param   value メッセージの引数
    290         */
    291        public void setVal4( final String value ) { setValues( 4, value ); }
    292
    293        /**
    294         * 【TAG】メッセージの引数{5}を指定します。
    295         *
    296         * @og.tag メッセージの引数を指定します。
    297         *
    298         * @param   value メッセージの引数
    299         */
    300        public void setVal5( final String value ) { setValues( 5, value ); }
    301
    302        /**
    303         * 【TAG】メッセージの引数{6}を指定します。
    304         *
    305         * @og.tag メッセージの引数を指定します。
    306         *
    307         * @param   value メッセージの引数
    308         */
    309        public void setVal6( final String value ) { setValues( 6, value ); }
    310
    311        /**
    312         * 【TAG】メッセージの引数{7}を指定します。
    313         *
    314         * @og.tag メッセージの引数を指定します。
    315         *
    316         * @param   value メッセージの引数
    317         */
    318        public void setVal7( final String value ) { setValues( 7, value ); }
    319
    320        /**
    321         * 【TAG】メッセージの引数{8}を指定します。
    322         *
    323         * @og.tag メッセージの引数を指定します。
    324         *
    325         * @param   value メッセージの引数
    326         */
    327        public void setVal8( final String value ) { setValues( 8, value ); }
    328
    329        /**
    330         * 【TAG】メッセージの引数{9}を指定します。
    331         *
    332         * @og.tag メッセージの引数{9}を指定します。
    333         *
    334         * @param   value メッセージの引数
    335         */
    336        public void setVal9( final String value ) { setValues( 9, value ); }
    337
    338        /**
    339         * メッセージの引数を指定します。
    340         *
    341         * @param   no    メッセージの引数の配列番号
    342         * @param   value メッセージの引数
    343         */
    344        private void setValues( final int no,final String val ) {
    345                if( values == null ) { values = new String[10]; }
    346                values[no] = getRequestParameter( val );
    347        }
    348
    349        /**
    350         * 【TAG】コマンド(INSERT,COPY,MODIFY,DELETE)をセットします。
    351         *
    352         * @og.tag
    353         * コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される
    354         * フィールド定数値のいづれかを、指定できます。
    355         * コマンド(INSERT,COPY,MODIFY,DELETE)に対応したメッセージを表示します。
    356         * INSERT : MSG0044  追加処理を行います。
    357         * COPY   : MSG0045  複写処理を行います。
    358         * MODIFY : MSG0046  変更処理を行います。
    359         * DELETE : MSG0047  削除処理を行います。
    360         *
    361         * なお、command によるメッセージの自動選択は、lbl ともにセットされていない
    362         * 場合にのみ有効になります。
    363         *
    364         * @og.rev 4.0.0.0 (2006/11/31) 新規登録
    365         *
    366         * @param       cmd コマンド(public static final 宣言されている文字列)
    367         */
    368        public void setCommand( final String cmd ) {
    369                String cmd2 = nval( getRequestParameter( cmd ),null );
    370                if(      "INSERT".equalsIgnoreCase( cmd2 ) ) { cmdMsg = "MSG0044"; }
    371                else if( "COPY".equalsIgnoreCase(   cmd2 ) ) { cmdMsg = "MSG0045"; }
    372                else if( "MODIFY".equalsIgnoreCase( cmd2 ) ) { cmdMsg = "MSG0046"; }
    373                else if( "DELETE".equalsIgnoreCase( cmd2 ) ) { cmdMsg = "MSG0047"; }
    374                else { cmdMsg = null; }
    375        }
    376
    377        /**
    378         * このオブジェクトの文字列表現を返します。
    379         * 基本的にデバッグ目的に使用します。
    380         *
    381         * @return このクラスの文字列表現
    382         */
    383        @Override
    384        public String toString() {
    385                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
    386                                .println( "VERSION"             ,VERSION        )
    387                                .println( "comment"             ,comment        )
    388                                .println( "values"              ,values         )
    389                                .println( "type"                ,type           )
    390                                .println( "TYPE_LIST"   ,TYPE_LIST      )
    391                                .println( "Other..."    ,getAttributes().getAttribute() )
    392                                .fixForm().toString() ;
    393        }
    394}