nablarch.common.web.compositekey

クラス CompositeKeyConvertor

java.lang.Object

nablarch.common.web.compositekey.CompositeKeyConvertor

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

Convertor

public class CompositeKeyConvertor
extends java.lang.Object
implements Convertor

値をCompositeKeyに変換するクラス。

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<T> java.lang.Object	convert(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object value, java.lang.annotation.Annotation format) 変換を行う。
java.lang.Class<?>	getTargetClass() 変換対象のクラスを取得する。
<T> boolean	isConvertible(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.lang.Object value, java.lang.annotation.Annotation format) 変換可否のプレチェックを行う。
void	setConversionFailedMessageId(java.lang.String conversionFailedMessageId) 変換失敗時のデフォルトのエラーメッセージのメッセージIDを設定する。

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

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

コンストラクタの詳細

CompositeKeyConvertor

public CompositeKeyConvertor()

メソッドの詳細

getTargetClass

public java.lang.Class<?> getTargetClass()

変換対象のクラスを取得する。

定義:

getTargetClass インタフェース内 Convertor

戻り値:

変換対象のクラス

setConversionFailedMessageId

public void setConversionFailedMessageId(java.lang.String conversionFailedMessageId)

変換失敗時のデフォルトのエラーメッセージのメッセージIDを設定する。
デフォルトメッセージの例 : "{0}が正しくありません"

パラメータ:

conversionFailedMessageId - 変換失敗時のデフォルトのエラーメッセージのメッセージID

isConvertible

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

変換可否のプレチェックを行う。
変換できない文字列であった場合、エラーメッセージをValidationContextに追加し、falseを返却する。

定義:

isConvertible インタフェース内 Convertor

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

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

value - 変換可否のプレチェックを行う値

format - フォーマットを指定するアノテーション（指定がない場合null)

戻り値:

変換できる場合true

convert

public <T> java.lang.Object convert(ValidationContext<T> context,
                                    java.lang.String propertyName,
                                    java.lang.Object value,
                                    java.lang.annotation.Annotation format)

変換を行う。
変換に失敗した場合、ValidationContextにエラー内容を設定する。

定義:

convert インタフェース内 Convertor

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

value - 変換する値(データ型は様々な形式がありえる。)

format - フォーマットを指定するアノテーション（指定がない場合null)

戻り値:

変換結果のオブジェクト