org.seasar.extension.dxo.converter
インタフェース ConversionContext

既知の実装クラスの一覧:

ConversionContextImpl

public interface ConversionContext

変換中のコンテキストを表すインターフェースです。

変換コンテキストは評価済みのオブジェクトを持ちます。 評価済みのオブジェクトとは、 DxoConstants.CONVERSION_RULEアノテーションで 指定されたOGNL式の評価結果であるMapです。

作成者:

koichik

メソッドの概要

void	addConvertedObject(java.lang.Object source, java.lang.Object dest) 変換済みのオブジェクトを変換コンテキストに追加します。
void	addEvaluatedValue(java.lang.String name, java.lang.Object value) 評価済みのオブジェクトを追加します。
java.lang.Object	getContextInfo(java.lang.String key) コンテキスト情報からキーにマッピングされている値を返します。
java.lang.Object	getConvertedObject(java.lang.Object source) 変換元オブジェクトから変換済みのオブジェクトがあればそれを返します。
Converter	getConverter(java.lang.Class destClass, java.lang.String destPropertyName) 変換先クラスのdestPropertyNameで示されるプロパティにコンバータが指定されていれば返します。
ConverterFactory	getConverterFactory() コンバータファクトリを返します。
java.text.DateFormat	getDateFormat() コンテキスト情報から日付用のDateFormatを返します。
java.text.DateFormat	getDateFormat(java.lang.String format) 現在のスレッドでフォーマット文字列を扱うDateFormatを返します。
DatePropertyInfo	getDatePropertyInfo(java.lang.Class srcClass, java.lang.String propertyName) 日時プロパティの情報を返します。
java.lang.Object	getEvaluatedValue(java.lang.String name) 名前に対応する評価済みのオブジェクトを返します。
NestedPropertyInfo	getNestedPropertyInfo(java.lang.Class srcClass, java.lang.String propertyName) ネストしたプロパティの情報を返します。
java.lang.String	getSourcePrefix() 変換元JavaBeansのプロパティのprefixを返します。
java.lang.String	getSourcePropertyName(java.lang.String destPropertyName) コピー先のプロパティ名からコピー元のプロパティ名を求めて返します。
java.text.DateFormat	getTimeFormat() コンテキスト情報から時刻用のDateFormatを返します。
java.text.DateFormat	getTimestampFormat() コンテキスト情報から日時用のDateFormatを返します。
boolean	hasEvalueatedValue(java.lang.String name) 名前に対応する評価済みのオブジェクトがあればtrueを返します。
boolean	isExcludeNull() 変換先のJavaBeansにnullの値を設定しない場合はtrueを返します。
boolean	isExcludeWhitespace() 変換先のJavaBeansに空白(スペース，復帰，改行，タブ文字のみ)の値を設定しない場合はtrueを返します。
boolean	isIncludeNull() 変換先のJavaBeansにnullの値を設定する場合はtrueを返します。
boolean	isIncludeWhitespace() 変換先のJavaBeansに空白(スペース，復帰，改行，タブ文字のみ)の値を設定する場合はtrueを返します。

メソッドの詳細

getConverterFactory

public ConverterFactory getConverterFactory()

コンバータファクトリを返します。

戻り値:

コンバータファクトリ

getConverter

public Converter getConverter(java.lang.Class destClass,
                              java.lang.String destPropertyName)

変換先クラスのdestPropertyNameで示されるプロパティにコンバータが指定されていれば返します。 コンバータが指定されていない場合はnullを返します。

パラメータ:

destClass - 変換先のクラス

destPropertyName - 変換先クラスのプロパティ名

戻り値:

コンバータ

getConvertedObject

public java.lang.Object getConvertedObject(java.lang.Object source)

変換元オブジェクトから変換済みのオブジェクトがあればそれを返します。 変換済みのオブジェクトがない場合はnullを返します。

このメソッドは、 循環を含むオブジェクトグラフの変換で無限ループになることを防ぐために使用されます。 このメソッドがnullを返した場合は変換元の変換を行い、 変換したオブジェクトをaddConvertedObject(Object, Object)によりコンテキストに登録します。 次に同じソースオブジェクトでこのメソッドが呼び出された場合は変換済みのオブジェクトが返されます。

パラメータ:

source - 変換元のオブジェクト

戻り値:

変換済みのオブジェクト

addConvertedObject

public void addConvertedObject(java.lang.Object source,
                               java.lang.Object dest)

変換済みのオブジェクトを変換コンテキストに追加します。

パラメータ:

source - 変換元のオブジェクト

dest - 変換済みのオブジェクト

getContextInfo

public java.lang.Object getContextInfo(java.lang.String key)

コンテキスト情報からキーにマッピングされている値を返します。

パラメータ:

key - キー

戻り値:

値。キーにマッピングされている値がない場合はnull

関連項目:

DxoConstants

getDateFormat

public java.text.DateFormat getDateFormat()

コンテキスト情報から日付用のDateFormatを返します。

戻り値:

日付用のDateFormat。コンテキスト情報に日付用のフォーマットが指定されていない場合はnull

関連項目:

DxoConstants

getTimeFormat

public java.text.DateFormat getTimeFormat()

コンテキスト情報から時刻用のDateFormatを返します。

戻り値:

時刻用のDateFormat。コンテキスト情報に時刻用のフォーマットが指定されていない場合はnull

関連項目:

DxoConstants

getTimestampFormat

public java.text.DateFormat getTimestampFormat()

コンテキスト情報から日時用のDateFormatを返します。

戻り値:

日時用のDateFormat。コンテキスト情報に日時用のフォーマットが指定されていない場合はnull

関連項目:

DxoConstants

hasEvalueatedValue

public boolean hasEvalueatedValue(java.lang.String name)

名前に対応する評価済みのオブジェクトがあればtrueを返します。

パラメータ:

name - 名前

戻り値:

評価済みのオブジェクトがあればtrue、そうでない場合はfalse

getEvaluatedValue

public java.lang.Object getEvaluatedValue(java.lang.String name)

名前に対応する評価済みのオブジェクトを返します。 評価結果がnullの場合もあります。

パラメータ:

name - 名前

戻り値:

評価済みのオブジェクト

addEvaluatedValue

public void addEvaluatedValue(java.lang.String name,
                              java.lang.Object value)

評価済みのオブジェクトを追加します。

パラメータ:

name - 名前

value - 評価済みのオブジェクト

isExcludeNull

public boolean isExcludeNull()

変換先のJavaBeansにnullの値を設定しない場合はtrueを返します。

この値はDxoインターフェースのDxoConstants.EXCLUDE_NULLアノテーションに trueが指定された場合にのみtrueとなります。 その場合、変換元のプロパティがnullだと変換先のプロパティには値を設定しません。

戻り値:

変換先のJavaBeansにnullの値を設定しない場合はtrue、そうでない場合はfalse

isIncludeNull

public boolean isIncludeNull()

変換先のJavaBeansにnullの値を設定する場合はtrueを返します。

この値はisExcludeNull()の否定です。

戻り値:

変換先のJavaBeansにnullの値を設定する場合はtrue、そうでない場合はfalse

isExcludeWhitespace

public boolean isExcludeWhitespace()

変換先のJavaBeansに空白(スペース，復帰，改行，タブ文字のみ)の値を設定しない場合はtrueを返します。

この値はDxoインターフェースのDxoConstants.EXCLUDE_WHITESPACEアノテーションに trueが指定された場合にのみtrueとなります。 その場合、変換元のプロパティが空白だと変換先のプロパティには値を設定しません。

戻り値:

変換先のJavaBeansに空白(スペース，復帰，改行，タブ文字のみ)の値を設定しない場合はtrue、そうでない場合はfalse

isIncludeWhitespace

public boolean isIncludeWhitespace()

変換先のJavaBeansに空白(スペース，復帰，改行，タブ文字のみ)の値を設定する場合はtrueを返します。

この値はisExcludeWhitespace()の否定です。

戻り値:

変換先のJavaBeansに空白(スペース，復帰，改行，タブ文字のみ)の値を設定する場合はtrue、そうでない場合はfalse

getNestedPropertyInfo

public NestedPropertyInfo getNestedPropertyInfo(java.lang.Class srcClass,
                                                java.lang.String propertyName)

ネストしたプロパティの情報を返します。 該当するプロパティが存在しない場合はnullを返します。

パラメータ:

srcClass - 変換元のクラス

propertyName - 変換元のプロパティ名

戻り値:

ネストしたプロパティの情報

getDatePropertyInfo

public DatePropertyInfo getDatePropertyInfo(java.lang.Class srcClass,
                                            java.lang.String propertyName)

日時プロパティの情報を返します。 該当するプロパティが存在しない場合はnullを返します。

パラメータ:

srcClass - 変換元のクラス

propertyName - プロパティ名

戻り値:

日時プロパティの情報

getDateFormat

public java.text.DateFormat getDateFormat(java.lang.String format)

現在のスレッドでフォーマット文字列を扱うDateFormatを返します。

パラメータ:

format - フォーマット文字列

戻り値:

フォーマット文字列を持つDateFormat

getSourcePrefix

public java.lang.String getSourcePrefix()

変換元JavaBeansのプロパティのprefixを返します。

戻り値:

変換先JavaBeansのプロパティのprefix

getSourcePropertyName

public java.lang.String getSourcePropertyName(java.lang.String destPropertyName)

コピー先のプロパティ名からコピー元のプロパティ名を求めて返します。

SOURCE_PREFIX定数アノテーションまたは@SourcePrefixアノテーションで コピー元プロパティのprefixが指定されている場合は、コピー先プロパティ名にprefixを付加した名前を返します。

prefixが'_'以外の文字で終了している場合は、コピー先プロパティ名をキャピタライズしてからprefixを付加します。

パラメータ:

destPropertyName - コピー先プロパティ名

戻り値:

コピー元のプロパティ名