クラス BindTag

  • すべての実装されたインタフェース:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

    public class BindTag
    extends javax.servlet.jsp.tagext.TagSupport
    implements javax.servlet.jsp.tagext.TryCatchFinally

    Beanに格納されている値、関連するエラーをpageContextにバインドするJSPタグです。

    JSPでの利用例を以下に示します。

     <%@page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
     <%@taglib prefix="m" uri="http://iplass.org/tags/mtp"%>
     
     :
     
     <form>
     <!-- formBeanという名前で参照(RequestやSessionから)されるBeanをバインドします -->
     <m:bind bean="${formBean}">
     
       <!-- formBeanのプロパティuserNameをバインドします。
           ${value}、${name}でformに指定すべきvalue, nameが取得できます。
           また、<m:errors/>を指定することにより、BeanParamMapperでのマッピングエラー、バリデーションエラーを表示可能です。 -->
       <m:bind prop="userName">
       user name : <input type="text" value="${value}" name="${name}"> <m:errors />
       </m:bind>
       
       :
       
       <m:bind prop="mailAddress">
       mail address : <input type="text" value="${value}" name="${name}"> <m:errors />
       </m:bind>
     
     :
     
     </m:bind>
     </form>
     
     

    指定可能な属性の説明

    属性名Script可デフォルト値説明
    bean○  バインドするBeanのインスタンスを指定します。
    バインドされたBeanは、beanという変数名でpageContextに公開されます。 公開する際の変数名を変更したい場合は、beanVariableNameにて変数名を変更可能です。
    beanVariableName beanバインドされたBeanをpageContextに公開する際の変数名を指定可能です。
    mappingResult○  BeanParamMapperでのバインド結果であるMappingResultのインスタンスを指定可能です。 mappingResultが指定された場合、当該Bean、プロパティに紐付くエラーがバインドされます。
    当該属性が未指定の場合、かつautoDetectErrorsがtrueの場合、mappingResultは自動解決されます。
    バインドされたMappingResultはmappingResultという変数名でpageContextに公開されます。 公開する際の変数名を変更したい場合は、mappingResultVariableNameにて変数名を変更可能です。
    autoDetectErrors trueエラー(mappingResult)を自動解決するか否かを指定可能です。 trueが指定された場合、requestからWebRequestConstants.EXCEPTIONをキーにMappingExceptionを取得し、 存在した場合、その例外からMappingResultのインスタンスを自動的に解決します。
    mappingResultVariableName mappingResultバインドされたMappingResultをpageContextに公開する際の変数名を指定可能です。
    prop○ バインドされているBeanのプロパティのパスを指定します。 EL式の記法によって、ネストされたプロパティを指定可能です。
    例)
     userName
     accout.mail
     details[0].id
     
    当該パスが指定されたbindタグの内側ではpageContextにプロパティ名、値、当該プロパティに関連するエラーがバインドされます。
    pageContextに公開される際の変数名は、デフォルトでは以下の名前で公開されます。
    • name : HTTPのパラメータ名として利用可能な形のプロパティのパス。BeanParamMapperのパラメータ名と一致
    • value : プロパティの値の文字列表現。文字列表現はhtmlEscape、formatter設定にて制御可能
    • rawValue : 生のプロパティの値
    • errors : 当該プロパティに関するエラーが存在する場合、エラーメッセージのList<String>
    公開する際の変数名を変更したい場合は、propertyNameVariableName、propertyValueVariableName、 propertyRawValueVariableName、errorsVariableNameにて変数名を変更可能です。
    また、propには、scriptでの指定が可能なので、Bean内にネストされたリストをバインドしたい場合、例えば次のような記述が可能です。
    JSTLのforEachを利用する例
     <m:bind bean="${bean}">
     
     :
     
     <c:forEach var="item" items="${bean.children}" varStatus="stat">
       ${stat.index}.
       <m:bind prop="children[${stat.index}].name">
       child name : <input type="text" value="${value}" name="${name}"> <m:errors />
       </m:bind>
     </c:forEach>
     
     </m:bind>
     
     
    prop指定と同時にbeanが指定された場合は、そのbeanのプロパティをバインドします。 beanが未指定の場合は、親タグに指定されるbeanのプロパティをバインドします。
    htmlEscape truevalue(プロパティ値の文字列表現)を出力する際にhtmlエスケープ処理をするか否かを指定可能です。
    このフラグによってエスケープ処理されるのはvalueのみです。name、errorsの値はエスケープされません。
    formatter○DefaultValueFormatterのインスタンス value(プロパティ値の文字列表現)を出力する際のフォーマット処理を行うValueFormatterのインスタンスを指定します。
    このformatterをbeanが指定される親のbindタグに指定することにより個別のプロパティがバインドされる値に一律の処理が可能ですが、 次のように個別にrawValueからフォーマットすることも可能です。 以下例では、エラーが発生した場合は、エラー値を出力するようにnvl関数を利用しています。
     <m:bind prop="dateProp">
     :
     <input type="text" value="${m:nvl(errorValue, m:fmt(rawValue, 'yyyy/MM/dd'))}" name="${name}">
     </m:bind>
     
    propertyNameVariableName nameバインドされたプロパティのHTTPパラメータ名をpageContextに公開する際の変数名を指定可能です。
    propertyValueVariableName valueバインドされたプロパティの値の文字列表現をpageContextに公開する際の変数名を指定可能です。
    propertyRawValueVariableName rawValueバインドされたプロパティの生の値をpageContextに公開する際の変数名を指定可能です。
    propertyErrorValueVariableName errorValueバインドされたプロパティがエラーの場合、そのエラー値が格納される変数名を指定可能です。
    errorsVariableName errorsバインドされたプロパティに関連するエラーをpageContextに公開する際の変数名を指定可能です。
    prefix  name(HTTPパラメータ名)を出力する際のprefixを指定します。 HTTPリクエストをBeanParamMapperでマッピングする場合、BeanParamMapperのparamPrefixの値と一致させる必要があります。
    propertyDelimiter .name(HTTPパラメータ名)を出力する際のネストされたプロパティのデリミタを指定します。 HTTPリクエストをBeanParamMapperでマッピングする場合、BeanParamMapperのpropertyDelimiterの値と一致させる必要があります。
    indexPrefix [name(HTTPパラメータ名)を出力する際のインデックス指定のプレフィックス文字を指定します。 HTTPリクエストをBeanParamMapperでマッピングする場合、BeanParamMapperのindexPrefixの値と一致させる必要があります。
    indexPostfix ]name(HTTPパラメータ名)を出力する際のインデックス指定のポストフィックス文字を指定します。 HTTPリクエストをBeanParamMapperでマッピングする場合、BeanParamMapperのindexPostfixの値と一致させる必要があります。

    関連項目:
    直列化された形式
    • フィールドの詳細

      • DEFAULT_PROPERTY_DELIMITER

        public static final java.lang.String DEFAULT_PROPERTY_DELIMITER
        関連項目:
        定数フィールド値
      • DEFAULT_INDEX_PREFIX

        public static final java.lang.String DEFAULT_INDEX_PREFIX
        関連項目:
        定数フィールド値
      • DEFAULT_INDEX_POSTFIX

        public static final java.lang.String DEFAULT_INDEX_POSTFIX
        関連項目:
        定数フィールド値
      • DEFAULT_BEAN_VARIABLE_NAME

        public static final java.lang.String DEFAULT_BEAN_VARIABLE_NAME
        関連項目:
        定数フィールド値
      • DEFAULT_MAPPING_RESULT_VARIABLE_NAME

        public static final java.lang.String DEFAULT_MAPPING_RESULT_VARIABLE_NAME
        関連項目:
        定数フィールド値
      • DEFAULT_PROPERTY_NAME_VARIABLE_NAME

        public static final java.lang.String DEFAULT_PROPERTY_NAME_VARIABLE_NAME
        関連項目:
        定数フィールド値
      • DEFAULT_PROPERTY_VALUE_VARIABLE_NAME

        public static final java.lang.String DEFAULT_PROPERTY_VALUE_VARIABLE_NAME
        関連項目:
        定数フィールド値
      • DEFAULT_PROPERTY_RAW_VALUE_VARIABLE_NAME

        public static final java.lang.String DEFAULT_PROPERTY_RAW_VALUE_VARIABLE_NAME
        関連項目:
        定数フィールド値
      • DEFAULT_PROPERTY_ERROR_VALUE_VARIABLE_NAME

        public static final java.lang.String DEFAULT_PROPERTY_ERROR_VALUE_VARIABLE_NAME
        関連項目:
        定数フィールド値
      • DEFAULT_ERROR_VARIABLE_NAME

        public static final java.lang.String DEFAULT_ERROR_VARIABLE_NAME
        関連項目:
        定数フィールド値
    • コンストラクタの詳細

      • BindTag

        public BindTag()
    • メソッドの詳細

      • getPropertyErrorValueVariableName

        public java.lang.String getPropertyErrorValueVariableName()
      • setPropertyErrorValueVariableName

        public void setPropertyErrorValueVariableName​(java.lang.String propertyErrorValueVariableName)
      • setFormatter

        public void setFormatter​(ValueFormatter formatter)
      • isHtmlEscape

        public boolean isHtmlEscape()
      • setHtmlEscape

        public void setHtmlEscape​(boolean htmlEscape)
      • getPropertyDelimiter

        public java.lang.String getPropertyDelimiter()
      • setPropertyDelimiter

        public void setPropertyDelimiter​(java.lang.String propertyDelimiter)
      • getIndexPrefix

        public java.lang.String getIndexPrefix()
      • setIndexPrefix

        public void setIndexPrefix​(java.lang.String indexPrefix)
      • getIndexPostfix

        public java.lang.String getIndexPostfix()
      • setIndexPostfix

        public void setIndexPostfix​(java.lang.String indexPostfix)
      • getBeanVariableName

        public java.lang.String getBeanVariableName()
      • setBeanVariableName

        public void setBeanVariableName​(java.lang.String beanVariableName)
      • getMappingResultVariableName

        public java.lang.String getMappingResultVariableName()
      • setMappingResultVariableName

        public void setMappingResultVariableName​(java.lang.String mappingResultVariableName)
      • getPropertyNameVariableName

        public java.lang.String getPropertyNameVariableName()
      • setPropertyNameVariableName

        public void setPropertyNameVariableName​(java.lang.String propertyNameVariableName)
      • getPropertyValueVariableName

        public java.lang.String getPropertyValueVariableName()
      • setPropertyValueVariableName

        public void setPropertyValueVariableName​(java.lang.String propertyValueVariableName)
      • getPropertyRawValueVariableName

        public java.lang.String getPropertyRawValueVariableName()
      • setPropertyRawValueVariableName

        public void setPropertyRawValueVariableName​(java.lang.String propertyRawValueVariableName)
      • getErrorsVariableName

        public java.lang.String getErrorsVariableName()
      • setErrorsVariableName

        public void setErrorsVariableName​(java.lang.String errorsVariableName)
      • getBean

        public java.lang.Object getBean()
      • setBean

        public void setBean​(java.lang.Object bean)
      • getAutoDetectErrors

        public java.lang.Boolean getAutoDetectErrors()
      • setAutoDetectErrors

        public void setAutoDetectErrors​(java.lang.Boolean autoDetectErrors)
      • setMappingResult

        public void setMappingResult​(MappingResult mappingResult)
      • getProp

        public java.lang.String getProp()
      • setProp

        public void setProp​(java.lang.String prop)
      • getPrefix

        public java.lang.String getPrefix()
      • setPrefix

        public void setPrefix​(java.lang.String prefix)
      • isSetBean

        boolean isSetBean()
      • getBeanBindTag

        BindTag getBeanBindTag()
      • doStartTag

        public int doStartTag()
                       throws javax.servlet.jsp.JspException
        定義:
        doStartTag インタフェース内 javax.servlet.jsp.tagext.Tag
        オーバーライド:
        doStartTag クラス内 javax.servlet.jsp.tagext.TagSupport
        例外:
        javax.servlet.jsp.JspException
      • doEndTag

        public int doEndTag()
                     throws javax.servlet.jsp.JspException
        定義:
        doEndTag インタフェース内 javax.servlet.jsp.tagext.Tag
        オーバーライド:
        doEndTag クラス内 javax.servlet.jsp.tagext.TagSupport
        例外:
        javax.servlet.jsp.JspException
      • doCatch

        public void doCatch​(java.lang.Throwable t)
                     throws java.lang.Throwable
        定義:
        doCatch インタフェース内 javax.servlet.jsp.tagext.TryCatchFinally
        例外:
        java.lang.Throwable
      • doFinally

        public void doFinally()
        定義:
        doFinally インタフェース内 javax.servlet.jsp.tagext.TryCatchFinally