nablarch.common.code.validator

クラス CodeValueValidator

java.lang.Object

nablarch.core.validation.validator.StringValidatorSupport<CodeValue>

nablarch.common.code.validator.CodeValueValidator

すべての実装されたインタフェース:

DirectCallableValidator, Validator

public class CodeValueValidator
extends StringValidatorSupport<CodeValue>

コード値をチェックするクラス。

CodeValueで指定したコード値と、プロパティの値が合致するかチェックする。

使用するための設定

本バリデータを使用するためにはデフォルトのメッセージIDを指定する必要がある。

      <component name="codeValueValidator" class="nablarch.common.code.validator.CodeValueValidator">
         <property name="messageId" value="MSGXXXXXX"/>
     </component>
   

プロパティの設定

プロパティのセッタにCodeValueアノテーションを次のように設定する。

     genderがcodeIdとpatternで選択された値と合致するかチェック
      @PropertyName("性別")
      @CodeValue(codeId="0001", pattern="PATTERN1")
      public String setGender(String gender) {
       this.gender = gender;
     }

     genderがコード値として有効であるかのみをチェック
      @PropertyName("性別")
      @CodeValue(codeId="0001")
      public String setGender(String gender) {
       this.gender = gender;
     }
   

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
CodeValueValidator()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
CodeValue	createAnnotation(java.util.Map<java.lang.String,java.lang.Object> params) 指定されたパラメータを属性値とするアノテーションオブジェクトを作成する。
java.lang.Class<? extends java.lang.annotation.Annotation>	getAnnotationClass() 対応するアノテーションのクラスを取得する。
void	setMessageId(java.lang.String messageId) コードに含まれない値が指定された場合のデフォルトのエラーメッセージのメッセージIDを設定する。
<T> boolean	validateSingleValue(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayObject, CodeValue codeValue, java.lang.String value) 1つの入力値に対するバリデーションを行う。

クラスから継承されたメソッド nablarch.core.validation.validator.StringValidatorSupport

validate, validate

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

CodeValueValidator

public CodeValueValidator()

メソッドの詳細

setMessageId

public void setMessageId(java.lang.String messageId)

コードに含まれない値が指定された場合のデフォルトのエラーメッセージのメッセージIDを設定する。
例 : "{0}には\"{1}\"のいずれかの値を指定してください。"

※通常コードは画面上のドロップダウンやセレクトボックスで選択することが多い。 この場合、このエラーメッセージはプログラムバグかユーザによるプログラム改竄以外に表示されることはない。 このため、本エラーメッセージはインプットボックスでコードを入力するという特殊な入力を行う画面以外では使用されない。

パラメータ:

messageId - コードに含まれない値が指定された場合のデフォルトのエラーメッセージのメッセージID

getAnnotationClass

public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationClass()

対応するアノテーションのクラスを取得する。

戻り値:

対応するアノテーションのクラス

validateSingleValue

public <T> boolean validateSingleValue(ValidationContext<T> context,
                                       java.lang.String propertyName,
                                       java.lang.Object propertyDisplayObject,
                                       CodeValue codeValue,
                                       java.lang.String value)

1つの入力値に対するバリデーションを行う。
コード値の有効性をチェックするバリデーションを行なう。

定義:

validateSingleValue クラス内 StringValidatorSupport<CodeValue>

型パラメータ:

T - バリデーション結果で取得できる型

パラメータ:

context - バリデーションコンテキスト

propertyName - プロパティ名

propertyDisplayObject - プロパティの表示名オブジェクト

codeValue - アノテーション

value - バリデーション対象の値

戻り値:

バリデーションに通った場合true

createAnnotation

public CodeValue createAnnotation(java.util.Map<java.lang.String,java.lang.Object> params)

クラスからコピーされた説明: StringValidatorSupport

指定されたパラメータを属性値とするアノテーションオブジェクトを作成する。

定義:

createAnnotation クラス内 StringValidatorSupport<CodeValue>

パラメータ:

params - アノテーションの属性値を格納したMap

戻り値:

アノテーション