nablarch.core.validation.validator

クラス NumberRangeValidator

java.lang.Object

nablarch.core.validation.validator.NumberRangeValidator

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

DirectCallableValidator, Validator

public class NumberRangeValidator
extends java.lang.Object
implements DirectCallableValidator

数値の範囲をチェックするクラス。

入力された値が、NumberRangeアノテーションのプロパティに設定された値の範囲内であるかチェックする。

使用するための設定

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

       <component name="numberRangeValidator" class="nablarch.core.validation.validator.NumberRangeValidator">
          <property name="maxMessageId" value="MSGXXXXXX"/>
          <property name="maxAndMinMessageId" value="MSGXXXXXX"/>
          <property name="minMessageId" value="MSGXXXXXX"/>
      </component>
      
   

プロパティの設定

範囲チェックをしたいプロパティのセッタにNumberRangeアノテーションを次のように設定する。

   入力値が1以上10以下の範囲内であるかチェックする
    @PropertyName("売上高")
    @NumberRange(min = 1, max = 10)
    public void setSales(Integer sales){
      this.sales = sales;
   }

   入力値が-1.5以上1.5以下の範囲内であるかチェックする
    @PropertyName("売上高")
    @NumberRange(min = -1.5, max = 1.5)
    public void setSales(Integer sales){
      this.sales = sales;
   }

   入力値が0以上であるかチェックする
    @PropertyName("売上高")
    @NumberRange(min = 0)
    public void setSales(Integer sales){
      this.sales = sales;
   }
   

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Class<? extends java.lang.annotation.Annotation>	getAnnotationClass() 対応するアノテーションのクラスを取得する。
void	setMaxAndMinMessageId(java.lang.String maxAndMinMessageId) バリデーションの条件に最大値と最小値が指定されていた場合のデフォルトのエラーメッセージのメッセージIDを設定する。
void	setMaxMessageId(java.lang.String maxMessageId) バリデーションの条件に最大値のみが指定されていた場合のデフォルトのエラーメッセージのメッセージID。
void	setMinMessageId(java.lang.String minMessageId) バリデーションの条件に最小値のみが指定されていた場合のデフォルトのエラーメッセージのメッセージIDを設定する。
<T> boolean	validate(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.lang.annotation.Annotation annotation, java.lang.Object value) バリデーションを実行する。
<T> boolean	validate(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.Object value) バリデーションを実行する。

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

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

コンストラクタの詳細

NumberRangeValidator

public NumberRangeValidator()

メソッドの詳細

setMaxMessageId

public void setMaxMessageId(java.lang.String maxMessageId)

バリデーションの条件に最大値のみが指定されていた場合のデフォルトのエラーメッセージのメッセージID。
例 : "{0}は{2}以下で入力してください。"

パラメータ:

maxMessageId - バリデーションの条件に最大値のみが指定されていた場合のデフォルトのエラーメッセージのメッセージID。

setMaxAndMinMessageId

public void setMaxAndMinMessageId(java.lang.String maxAndMinMessageId)

バリデーションの条件に最大値と最小値が指定されていた場合のデフォルトのエラーメッセージのメッセージIDを設定する。
例 : "{0}は{1}以上{2}以下で入力してください。"

パラメータ:

maxAndMinMessageId - バリデーションの条件に最大値と最小値が指定されていた場合のデフォルトのエラーメッセージのメッセージID

setMinMessageId

public void setMinMessageId(java.lang.String minMessageId)

バリデーションの条件に最小値のみが指定されていた場合のデフォルトのエラーメッセージのメッセージIDを設定する。
例 : "{0}は{1}以上で入力してください。"

パラメータ:

minMessageId - バリデーションの条件に最小値のみが指定されていた場合のデフォルトのエラーメッセージのメッセージID

getAnnotationClass

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

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

定義:

getAnnotationClass インタフェース内 Validator

戻り値:

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

validate

public <T> boolean validate(ValidationContext<T> context,
                            java.lang.String propertyName,
                            java.lang.Object propertyDisplayName,
                            java.lang.annotation.Annotation annotation,
                            java.lang.Object value)

バリデーションを実行する。
対応するチェックの結果がNGであった場合、ValidationContextにエラーメッセージを追加し、falseを返す。

定義:

validate インタフェース内 Validator

型パラメータ:

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

パラメータ:

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

propertyName - プロパティ名

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

annotation - アノテーション

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

戻り値:

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

validate

public <T> boolean validate(ValidationContext<T> context,
                            java.lang.String propertyName,
                            java.lang.Object propertyDisplayName,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            java.lang.Object value)

バリデーションを実行する。
対応するチェックの結果がNGであった場合、ValidationContextにエラーメッセージを追加し、falseを返す。

定義:

validate インタフェース内 DirectCallableValidator

型パラメータ:

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

パラメータ:

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

propertyName - プロパティ名

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

params - バリデーション処理に対するパラメータを格納したMap (アノテーションの属性と同内容)

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

戻り値:

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