ValidationManager (Nablarch-API)

java.lang.Object
- nablarch.core.validation.ValidationManager

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

Initializable
```
public class ValidationManager
extends java.lang.Object
implements Initializable
```
バリデーションとデータの変換を行うクラス。
実際のバリデーションとデータの変換はバリデータとコンバータに委譲する。

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

コンストラクタ
コンストラクタと説明

ValidationManager()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`protected <T> java.lang.Object`	`createPropertyDisplayNameObject(ValidationContext<T> context, PropertyValidationDefinition propertyDef)` プロパティの表示名を表すオブジェクトを作成する。
`<T> ValidationContext<T>`	`createValidationContext(java.lang.Class<T> targetClass, java.util.Map<java.lang.String,?> params, java.lang.String innerPrefix, java.lang.String validateFor)` `ValidationContext`を生成する。
`protected java.lang.annotation.Annotation`	`getFormatAnnotation(java.lang.annotation.Annotation convertorFormatAnnotation)` `Convertor`に渡すフォーマットを指定するアノテーションを取得する。
`void`	`initialize()` 初期化処理を行う。
`void`	`setConvertors(java.util.List<Convertor> convertors)` コンバータのリストをセットする。
`void`	`setDomainValidationHelper(DomainValidationHelper domainValidationHelper)` ドメイン定義によるバリデーションをサポートするヘルパークラスを設定する。
`void`	`setFormArraySizeValueMaxLength(int formArraySizeKeyMaxLength)` フォーム配列サイズ文字列の最大長を設定する。
`void`	`setFormCreator(FormCreator formCreator)` フォームの生成クラスをセットする。
`void`	`setFormDefinitionCache(StaticDataCache<FormValidationDefinition> formDefinitionCache)` FormValidationDefinitionをキャッシュするStaticDataCacheをセットする。
`void`	`setInvalidSizeKeyMessageId(java.lang.String invalidSizeKeyLengthMessageId)` ValidationTargetアノテーションのsizeKeyに不正な長さを指定した際のエラーメッセージIDを設定する。
`void`	`setMessageResource(StringResourceHolder stringResourceHolder)` 非推奨です。本プロパティは、仕様変更に伴い使用しなくなりました。(値を設定しても、意味が無い)
`void`	`setUseFormPropertyNameAsMessageId(boolean useFormPropertyNameAsMessageId)` フォームのプロパティ名をデフォルトのメッセージIDとして使用するかどうかの設定値を設定する。
`void`	`setValidators(java.util.List<Validator> validators)` バリデータのリストをセットする。
`<T> void`	`validate(ValidationContext<T> context, java.lang.String[] propertyNames)` バリデーション対象のプロパティを指定してバリデーションを行う。
`<T> void`	`validate(ValidationContext<T> context, java.lang.String propertyName, java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.util.Map<java.lang.String,java.lang.Object> params)` 指定されたバリデーションアノテーションに沿ったバリデーション処理を行う。
`<T> ValidationContext<T>`	`validateAndConvert(java.lang.String prefix, java.lang.Class<T> targetClass, java.util.Map<java.lang.String,?> params, java.lang.String validateFor)` バリデーションと値の変換を行う。
`protected <T> void`	`validateAndConvertAllProperty(ValidationContext<T> context, FormValidationDefinition formValidationDefinition)` フォームのバリデーションと変換を行う。
`protected <T> void`	`validateAndConvertProperty(ValidationContext<T> context, FormValidationDefinition formDef, PropertyValidationDefinition propertyDef)` プロパティに対するバリデーションと変換を行う。
`<T> void`	`validateWithout(ValidationContext<T> context, java.lang.String[] propertyNames)` バリデーション対象外のプロパティを指定してバリデーションを行う。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ValidationManager
```
public ValidationManager()
```
- メソッドの詳細
  - setFormDefinitionCache
```
public void setFormDefinitionCache(StaticDataCache<FormValidationDefinition> formDefinitionCache)
```
    FormValidationDefinitionをキャッシュするStaticDataCacheをセットする。
    
    パラメータ:
    
    formDefinitionCache - FormValidationDefinitionを保持するStaticDataCache
  - setFormCreator
```
public void setFormCreator(FormCreator formCreator)
```
    フォームの生成クラスをセットする。
    セットしなかった場合、MapConstructorFormCreatorが使用される。
    
    パラメータ:
    
    formCreator - フォームの生成クラス
  - setMessageResource
```
@IgnoreProperty(value="MessageUtil\u306e\u30e1\u30c3\u30bb\u30fc\u30b8\u30ea\u30bd\u30fc\u30b9\u3092\u4f7f\u7528\u3059\u308b\u3088\u3046\u4ed5\u69d8\u5909\u66f4\u3092\u884c\u3063\u305f\u305f\u3081\u672c\u30d7\u30ed\u30d1\u30c6\u30a3\u306f\u5ec3\u6b62")
 @Deprecated
public void setMessageResource(StringResourceHolder stringResourceHolder)
```
    非推奨です。本プロパティは、仕様変更に伴い使用しなくなりました。(値を設定しても、意味が無い)
    
    メッセージリソースをセットする。
    
    パラメータ:
    
    stringResourceHolder - メッセージリソース
  - setConvertors
```
public void setConvertors(java.util.List<Convertor> convertors)
```
    コンバータのリストをセットする。
    
    パラメータ:
    
    convertors - セットするコンバータのリスト
  - setValidators
```
public void setValidators(java.util.List<Validator> validators)
```
    バリデータのリストをセットする。
    
    パラメータ:
    
    validators - バリデータのリスト
  - setUseFormPropertyNameAsMessageId
```
public void setUseFormPropertyNameAsMessageId(boolean useFormPropertyNameAsMessageId)
```
    フォームのプロパティ名をデフォルトのメッセージIDとして使用するかどうかの設定値を設定する。
    
    パラメータ:
    
    useFormPropertyNameAsMessageId - フォームのプロパティ名をデフォルトのメッセージIDとして使用するかどうかの設定値。
  - setFormArraySizeValueMaxLength
```
public void setFormArraySizeValueMaxLength(int formArraySizeKeyMaxLength)
```
    フォーム配列サイズ文字列の最大長を設定する。
    
    パラメータ:
    
    formArraySizeKeyMaxLength - フォーム配列サイズ文字列の最大長
  - setInvalidSizeKeyMessageId
```
public void setInvalidSizeKeyMessageId(java.lang.String invalidSizeKeyLengthMessageId)
```
    ValidationTargetアノテーションのsizeKeyに不正な長さを指定した際のエラーメッセージIDを設定する。
    
    パラメータ:
    
    invalidSizeKeyLengthMessageId - ValidationTargetアノテーションのsizeKeyに不正な長さを指定した際のエラーメッセージID
  - initialize
```
public void initialize()
```
    初期化処理を行う。
    
    定義:
    
    initialize インタフェース内 Initializable
    
    関連項目:
    
    Initializable.initialize()
  - validateAndConvert
```
@Published(tag="architect")
public <T> ValidationContext<T> validateAndConvert(java.lang.String prefix,
                                                                               java.lang.Class<T> targetClass,
                                                                               java.util.Map<java.lang.String,?> params,
                                                                               java.lang.String validateFor)
```
    バリデーションと値の変換を行う。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    prefix - Mapに入ったキーのプレフィクス
    
    targetClass - バリデーション対象のフォームのクラス
    
    params - バリデーション対象のデータ
    
    validateFor - バリデーション対象メソッド
    
    戻り値:
    
    バリデーション結果の入ったValidationContext
  - createValidationContext
```
@Published(tag="architect")
public <T> ValidationContext<T> createValidationContext(java.lang.Class<T> targetClass,
                                                                                    java.util.Map<java.lang.String,?> params,
                                                                                    java.lang.String innerPrefix,
                                                                                    java.lang.String validateFor)
```
    ValidationContextを生成する。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    targetClass - バリデーション対象のフォームのクラス
    
    params - バリデーション対象のデータ
    
    innerPrefix - Mapに入ったキーのプレフィクス
    
    validateFor - バリデーション対象メソッド
    
    戻り値:
    
    ValidationContext
  - validateAndConvertAllProperty
```
protected <T> void validateAndConvertAllProperty(ValidationContext<T> context,
                                                 FormValidationDefinition formValidationDefinition)
```
    フォームのバリデーションと変換を行う。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    formValidationDefinition - FormValidationDefinition
  - validateAndConvertProperty
```
protected <T> void validateAndConvertProperty(ValidationContext<T> context,
                                              FormValidationDefinition formDef,
                                              PropertyValidationDefinition propertyDef)
```
    プロパティに対するバリデーションと変換を行う。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    formDef - FormValidationDefinition
    
    propertyDef - PropertyValidationDefinition
  - setDomainValidationHelper
```
public void setDomainValidationHelper(DomainValidationHelper domainValidationHelper)
```
    ドメイン定義によるバリデーションをサポートするヘルパークラスを設定する。
    
    パラメータ:
    
    domainValidationHelper - ドメイン定義によるバリデーションをサポートするヘルパークラス
  - getFormatAnnotation
```
protected java.lang.annotation.Annotation getFormatAnnotation(java.lang.annotation.Annotation convertorFormatAnnotation)
```
    Convertorに渡すフォーマットを指定するアノテーションを取得する。
    指定されたコンバータのアノテーションがドメイン定義の場合は、ドメイン定義に指定されたコンバータアノテーションを返す。それ以外の場合は、指定されたコンバータのアノテーションをそのまま返す。
    
    パラメータ:
    
    convertorFormatAnnotation - コンバータのアノテーション
    
    戻り値:
    
    Convertorに渡すフォーマットを指定するアノテーション
  - validate
```
public <T> void validate(ValidationContext<T> context,
                         java.lang.String propertyName,
                         java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                         java.util.Map<java.lang.String,java.lang.Object> params)
```
    指定されたバリデーションアノテーションに沿ったバリデーション処理を行う。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyName - バリデーション対象のプロパティ名
    
    annotation - バリデーションアノテーションクラス
    
    params - バリデーションアノテーションのパラメータ
  - createPropertyDisplayNameObject
```
protected <T> java.lang.Object createPropertyDisplayNameObject(ValidationContext<T> context,
                                                               PropertyValidationDefinition propertyDef)
```
    プロパティの表示名を表すオブジェクトを作成する。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyDef - PropertyValidationDefinition
    
    戻り値:
    
    プロパティの表示名を表すオブジェクト
  - validate
```
@Published(tag="architect")
public <T> void validate(ValidationContext<T> context,
                                                     java.lang.String[] propertyNames)
```
    バリデーション対象のプロパティを指定してバリデーションを行う。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyNames - バリデーション対象とするプロパティ名の配列
  - validateWithout
```
@Published(tag="architect")
public <T> void validateWithout(ValidationContext<T> context,
                                                            java.lang.String[] propertyNames)
```
    バリデーション対象外のプロパティを指定してバリデーションを行う。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyNames - バリデーション対象としないプロパティ名の配列

クラス ValidationManager

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

メソッドのサマリー

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

コンストラクタの詳細

ValidationManager

メソッドの詳細

setFormDefinitionCache

setFormCreator

setMessageResource

setConvertors

setValidators

setUseFormPropertyNameAsMessageId

setFormArraySizeValueMaxLength

setInvalidSizeKeyMessageId

initialize

validateAndConvert

createValidationContext

validateAndConvertAllProperty

validateAndConvertProperty

setDomainValidationHelper

getFormatAnnotation

validate

createPropertyDisplayNameObject

validate

validateWithout