    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 static org.opengion.fukurou.util.StringUtil.nval ;
    020
    021/**
    022 * case タグは、上位の switch タグの key とマッチした場合に、処理を行います。
    023 *
    024 * case タグの以下の属性について、説明します。
    025 *   match    ： switch_key.match( case_match ) でマッチした場合は、BODY が処理されます。
    026 *   isDefault： trueに設定すると、どのcase にもマッチしなかった場合に処理されます(初期値:false)
    027 *   isBreak  ： 通常、最初にマッチした段階で、switch 処理を抜けます(初期値:true)
    028 *   isNull   ： trueに設定すると、switchのkeyが、null(またはゼロ文字列)の場合、マッチします(初期値:false)
    029 *
    030 * @og.formSample
    031 * ●形式：&lt;og:switch key="･･･" /&gt;
    032 *            &lt;og:case match="A" /&gt; ･･･ &lt;/og:case&gt;
    033 *            &lt;og:case match="B" /&gt; ･･･ &lt;/og:case&gt;
    034 *            &lt;og:case match="C" /&gt; ･･･ &lt;/og:case&gt;
    035 *            &lt;og:case isDefault="true" /&gt; ･･･ &lt;/og:case&gt;
    036 *         &lt;/og:switch&gt;
    037 * ●body：あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{&#064;XXXX} は解析しません)
    038 *
    039 * ●Tag定義：
    040 *   &lt;og:case
    041 *       match              【TAG】switch-case のマッチ条件(case_match)を指定します
    042 *       isDefault          【TAG】どのcase にもマッチしなかった場合に処理する case 文かどうかを指定します(初期値:false)
    043 *       isBreak            【TAG】マッチした以降に継続処理を行わない(ブレイクする)かどうかを指定(初期値:true)
    044 *       isNull             【TAG】switchのkeyが、null(またはゼロ文字列)の場合、マッチするかどうか[true/false]を設定します(初期値:false)
    045 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    046 *   &gt;   ... Body ...
    047 *   &lt;/og:case&gt;
    048 *
    049 * ●使用例
    050 *         &lt;og:switch key="{&#064;PARAM}" /&gt;
    051 *            &lt;og:case match="A" /&gt; 処理A &lt;/og:case&gt;
    052 *            &lt;og:case match="B" /&gt; 処理B &lt;/og:case&gt;
    053 *            &lt;og:case match="C" /&gt; 処理C &lt;/og:case&gt;
    054 *            &lt;og:case isDefault="true" /&gt; 処理X &lt;/og:case&gt;
    055 *         &lt;/og:switch&gt;
    056 *
    057 *          ・switch の key に対して、case の match に指定された値が、マッチ(switch_key.match( case_match ))
    058 *            した場合に、case の BODY 部分が処理されます。
    059 *            マッチしなければ、BODY部は、スキップされます。
    060 *          ・isDefault="true" の場合は、どれとも マッチしなかった場合に、実行されます。
    061 *          ・Javaの switch-case 文は、最初に処理された case 以降を処理します。通常は、break を入れて
    062 *            後続処理を実行されないようにしています。
    063 *            この、switch-case タグは、caseタグの isBreak 属性で制御します。初期値が isBreak="true" に、
    064 *            なっているため、通常は、どれかの case が実行された段階で、switchの処理は、終了されます。
    065 *            isBreak="false" にすると、switchから抜けずに、継続して case との match を実行します。
    066 *            この場合、Java等と異なるのは、直後のcase文が実行されるのではなく、あくまで match 作業が
    067 *            継続されるということです。つまり、複数の case で処理を行いたい場合は、isBreak="false" に
    068 *            すると同時に、match 条件もそれぞれで、マッチするように設定する必要があります。
    069 *
    070 *         &lt;og:switch key="{&#064;PARAM}" /&gt;
    071 *            &lt;og:case match="[1]"   isBreak="false" /&gt; 処理A &lt;/og:case&gt;
    072 *            &lt;og:case match="[12]"  isBreak="false" /&gt; 処理B &lt;/og:case&gt;
    073 *            &lt;og:case match="[123]" isBreak="false" /&gt; 処理C &lt;/og:case&gt;
    074 *            &lt;og:case isNull="true" /&gt; 処理X &lt;/og:case&gt;
    075 *            &lt;og:case isDefault="true" /&gt; 処理Y &lt;/og:case&gt;
    076 *         &lt;/og:switch&gt;
    077 *
    078 *          ・上記指定では、isBreak="false" が指定されているため、マッチした後も継続して判定処理が実施されます。
    079 *          ・上記例で言うと、PARAM が "1" の場合、上記３つともにマッチします。
    080 *          ・isNull="true" は、switch の key が null の場合に成立します。(null とは、ゼロ文字列も含む)
    081 *
    082 * @og.group 画面制御
    083 * @og.rev 5.2.3.0 (2010/12/01) 新規追加
    084 *
    085 * @version  5.2.3.0 (2010/12/01)
    086 * @author       Kazuhiko Hasegawa
    087 * @since    JDK1.6,
    088 */
    089public class CaseTag extends CommonTagSupport {
    090        //* このプログラムのVERSION文字列を設定します。   {@value} */
    091        private static final String VERSION = "5.2.3.0 (2010/12/01)" ;
    092
    093        private static final long serialVersionUID = 523020101201L ;
    094
    095        private String  caseMatch       = null ;        // switch_key.match( case_match ) でマッチした場合は、BODY が処理されます。
    096        private boolean isDefault       = false;        // trueに設定すると、どのcase にもマッチしなかった場合に処理されます(初期値:false)
    097        private boolean isBreak         = true ;        // 通常、最初にマッチした段階で、switch 処理を抜けます(初期値:true)
    098        private boolean isNull          = false;        // trueに設定すると、switchのkeyが、null(またはゼロ文字列)の場合、マッチします(初期値:false)
    099
    100        /**
    101         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    102         *
    103         * @return      後続処理の指示
    104         */
    105        @Override
    106        public int doStartTag() {
    107                SwitchTag switchTag = (SwitchTag)findAncestorWithClass( this,SwitchTag.class );
    108                if( switchTag == null ) {
    109                        String errMsg = "<b>" + getTagName() + "タグは、switch タグの内部におく必要があります。</b>";
    110                        throw new HybsSystemException( errMsg );
    111                }
    112
    113                boolean rtn = false;
    114                if( switchTag.isMatch() ) {
    115                        String key = switchTag.getKey();
    116                        rtn =   ( key != null && caseMatch != null && key.matches( caseMatch ) ) ||
    117                                        ( isNull && key == null ) || isDefault ;
    118
    119                        if( rtn && isBreak ) { switchTag.setBreak(); }
    120                }
    121
    122                if( rtn ) { return EVAL_BODY_INCLUDE ; }
    123                else      { return SKIP_BODY ;         }
    124        }
    125
    126        /**
    127         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    128         *
    129         * @return      後続処理の指示
    130         */
    131        @Override
    132        public int doEndTag() {
    133                debugPrint();           // 4.0.0 (2005/02/28)
    134
    135                return EVAL_PAGE ;
    136        }
    137
    138        /**
    139         * タグリブオブジェクトをリリースします。
    140         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    141         *
    142         */
    143        @Override
    144        protected void release2() {
    145                super.release2();
    146                caseMatch       = null ;        // switch_key.match( case_match ) でマッチした場合は、BODY が処理されます。
    147                isDefault       = false;        // trueに設定すると、どのcase にもマッチしなかった場合に処理されます(初期値:false)
    148                isBreak         = true ;        // 通常、最初にマッチした段階で、switch 処理を抜けます(初期値:true)
    149                isNull          = false;        // trueに設定すると、switchのkeyが、null(またはゼロ文字列)の場合、マッチします(初期値:false)
    150        }
    151
    152        /**
    153         * 【TAG】switch-case のマッチ条件(case_match)を指定します。
    154         *
    155         * @og.tag
    156         * switch_key.match( case_match ) でマッチした場合は、BODY が処理されます。
    157         *
    158         * @param       mkey マッチ条件
    159         */
    160        public void setMatch( final String mkey ) {
    161                caseMatch = nval( getRequestParameter( mkey ),caseMatch );
    162        }
    163
    164        /**
    165         * 【TAG】どのcase にもマッチしなかった場合に処理する case 文かどうかを指定します(初期値:false)。
    166         *
    167         * @og.tag
    168         * trueに設定すると、どのcase にもマッチしなかった場合に処理されます
    169         * このタグそのものがなにも出力しません。(つまり条件から消えます。)
    170         * BODY 部に記述することが可能です。その場合は、value 属性になにも設定できません。
    171         * 初期値は、false：default case 文ではない です。
    172         *
    173         * @param       flag マッチしなかった場合に処理する case 文かどうか[true/false]
    174         */
    175        public void setIsDefault( final String flag ) {
    176                isDefault = nval( getRequestParameter( flag ),isDefault );
    177        }
    178
    179        /**
    180         * 【TAG】マッチした以降に継続処理を行わない(ブレイクする)かどうかを指定(初期値:true)。
    181         *
    182         * @og.tag
    183         * true に設定すると、マッチした段階で、ブレイクします。
    184         * Javaの switch-case 文は、最初に処理された case 以降を処理します。通常は、break を入れて
    185         * 後続処理を実行されないようにしています。
    186         * この、switch-case タグは、caseタグの break 属性で制御します。初期値が break="true" に、
    187         * なっているため、通常は、どれかの case が実行された段階で、switchの処理は、終了されます。
    188         * break="false" にすると、switchから抜けずに、継続して case との match を実行します。
    189         * この場合、Java等と異なるのは、直後のcase文が実行されるのではなく、あくまで match 作業が
    190         * 継続されるということです。つまり、複数の case で処理を行いたい場合は、break="false" に
    191         * すると同時に、match 条件もそれぞれで、マッチするように設定する必要があります。
    192         * 初期値は、true：ブレイクする です。
    193         *
    194         * @param       flag 継続処理を行わないかどうか[true:行わない=ブレイクする/false:継続処理を行う]
    195         */
    196        public void setIsBreak( final String flag ) {
    197                isBreak = nval( getRequestParameter( flag ),isBreak );
    198        }
    199
    200        /**
    201         * 【TAG】switchのkeyが、null(またはゼロ文字列)の場合、マッチするかどうか[true/false]を設定します(初期値:false)。
    202         *
    203         * @og.tag
    204         * trueに設定すると、switchのkeyが、null(またはゼロ文字列)の場合、マッチします。
    205         * 初期値のfalse にすると、キーが null でない場合だけ、マッチ処理を実行します。
    206         * case の条件判定で使用されます。
    207         * 初期値は、 false (null でない) です。
    208         *
    209         * @param       flag nullマッチ判定[true/false]
    210         */
    211        public void setIsNull( final String flag ) {
    212                isNull = nval( getRequestParameter( flag ),isNull );
    213        }
    214
    215        /**
    216         * このオブジェクトの文字列表現を返します。
    217         * 基本的にデバッグ目的に使用します。
    218         *
    219         * @return このクラスの文字列表現
    220         */
    221        @Override
    222        public String toString() {
    223                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
    224                                .println( "VERSION"                     ,VERSION        )
    225                                .println( "caseMatch"           ,caseMatch      )
    226                                .println( "isDefault"           ,isDefault      )
    227                                .println( "isBreak"                     ,isBreak        )
    228                                .println( "isNull"                      ,isNull         )
    229                                .println( "Other..."    ,getAttributes().getAttribute() )
    230                                .fixForm().toString() ;
    231        }
    232}