nablarch.common.date

クラス AbstractDateStringConverter

java.lang.Object

nablarch.common.date.AbstractDateStringConverter

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

Convertor, ExtendedStringConvertor

直系の既知のサブクラス:

YYYYMMConvertor, YYYYMMDDConvertor

public abstract class AbstractDateStringConverter
extends java.lang.Object
implements ExtendedStringConvertor

日付を表す文字列を値に変換する抽象クラス。

関連項目:

YYYYMMDDConvertor, YYYYMMConvertor

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

コンストラクタ

修飾子	コンストラクタと説明
protected	AbstractDateStringConverter(java.lang.String datePattern, java.lang.String dataType) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected java.lang.String	convert(java.lang.String value, FormatSpec formatSpec) 指定されたフォーマット仕様で値を変換する。
<T> java.lang.Object	convert(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object value, java.lang.annotation.Annotation annotation) 変換を行う。
protected abstract nablarch.common.date.AbstractDateStringConverter.AnnotationData	getAnnotationDataFrom(java.lang.annotation.Annotation annotation) アノテーションから値を取得する。
protected <T> FormatSpec	getFormatSpec(ValidationContext<T> context, java.lang.String propertyName, java.lang.String allowFormat) プロパティの変換に使用するフォーマット仕様を取得する。
protected java.lang.String	getNumbersOnlyFormat(java.lang.String format) フォーマット文字列から日付文字列の区切り文字を取り除いた値を返す。
java.lang.Class<?>	getTargetClass() 変換対象のクラスを取得する。
protected boolean	isConvertible(java.lang.String value, FormatSpec formatSpec) 指定されたフォーマット仕様で値が変換可能か否かを判定する。
<T> boolean	isConvertible(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.lang.Object value, java.lang.annotation.Annotation format) 変換可否のプレチェックを行う。
void	setParseFailedMessageId(java.lang.String parseFailedMessageId) 指定された日付文字列への変換失敗時のメッセージIDを設定する。

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

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

インタフェースから継承されたメソッド nablarch.core.validation.convertor.ExtendedStringConvertor

getTargetAnnotation

コンストラクタの詳細

AbstractDateStringConverter

protected AbstractDateStringConverter(java.lang.String datePattern,
                                      java.lang.String dataType)

コンストラクタ。

パラメータ:

datePattern - フォーマットに使用する日付パターン

dataType - "データタイプ{パターン}"形式のデータタイプ

メソッドの詳細

setParseFailedMessageId

public void setParseFailedMessageId(java.lang.String parseFailedMessageId)

指定された日付文字列への変換失敗時のメッセージIDを設定する。

パラメータ:

parseFailedMessageId - 指定された日付文字列への変換失敗時のメッセージID

convert

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

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

値がnullまたは空文字の場合は値をそのまま返す。 値の変換は、#convert(String, String)メソッドに委譲する。

定義:

convert インタフェース内 Convertor

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

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

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

戻り値:

変換結果のオブジェクト

convert

protected java.lang.String convert(java.lang.String value,
                                   FormatSpec formatSpec)

指定されたフォーマット仕様で値を変換する。

はじめに指定されたフォーマット仕様で値の解析を試みる。 指定されたフォーマット仕様で解析できない場合は、 getNumbersOnlyFormat(String)メソッドを使用し、 日付文字列の区切り文字を取り除いたフォーマットで解析する。

最後に解析結果として取得できるDateオブジェクトを、所定のパターン(datePattern)の 文字列に変換する。

パラメータ:

value - 値

formatSpec - フォーマット仕様

戻り値:

変換後の値

getTargetClass

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

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

定義:

getTargetClass インタフェース内 Convertor

戻り値:

変換対象のクラス

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を返却する。

値がnullまたは空文字の場合はconvertメソッドでnullを返すため、本メソッドはtrueを返す。 値の変換可否チェックは、#isConvertible(String, String)メソッドに委譲する。

値が変換不可の場合は、バリデーション結果メッセージを設定しfalseを返す。 メッセージIDは、YYYYMMDDアノテーションのmessageId属性の値を使用する。 YYYYMMDDアノテーションにメッセージIDが指定されていない場合は、 本クラスのparseFailedMessageIdプロパティの値をメッセージIDに使用する。

定義:

isConvertible インタフェース内 Convertor

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

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

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

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

戻り値:

変換できる場合true

isConvertible

protected boolean isConvertible(java.lang.String value,
                                FormatSpec formatSpec)

指定されたフォーマット仕様で値が変換可能か否かを判定する。

 はじめに指定されたフォーマット仕様で値が変換可能か否かを判定する。
 指定されたフォーマット仕様で変換不可の場合は、
 getNumbersOnlyFormat(String)メソッドを使用し、
 日付文字列の区切り文字を取り除いたフォーマットで変換可能か否かを判定する。
 

パラメータ:

value - 値

formatSpec - フォーマット仕様

戻り値:

変換可能な場合はtrue

getFormatSpec

protected <T> FormatSpec getFormatSpec(ValidationContext<T> context,
                                       java.lang.String propertyName,
                                       java.lang.String allowFormat)

プロパティの変換に使用するフォーマット仕様を取得する。

ConversionUtil.getFormatSpec(ValidationContext, String)を呼び出し、 プロパティに対する有効なフォーマット仕様(yyyymmddなど)を取得して返す。

プロパティに対する有効なフォーマット仕様が存在しない場合は、 allowFormatから生成したフォーマット仕様を返す。

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

allowFormat - フォーマット

戻り値:

変換に使用するフォーマット仕様

getNumbersOnlyFormat

protected java.lang.String getNumbersOnlyFormat(java.lang.String format)

フォーマット文字列から日付文字列の区切り文字を取り除いた値を返す。

DateUtil.getNumbersOnlyFormat(String)に処理を委譲する。

パラメータ:

format - フォーマット文字列

戻り値:

フォーマット文字列から年月日の区切り文字を取り除いた値

getAnnotationDataFrom

protected abstract nablarch.common.date.AbstractDateStringConverter.AnnotationData getAnnotationDataFrom(java.lang.annotation.Annotation annotation)

アノテーションから値を取得する。

パラメータ:

annotation - アノテーション

戻り値:

アノテーションに設定された値