org.seasar.framework.jpa.metadata
インタフェース AttributeDesc

public interface AttributeDesc

エンティティの属性定義を表すインターフェースです。

作成者:

koichik

メソッドの概要

AttributeDesc	getChildAttributeDesc(java.lang.String name) 子属性を表すAttributeDescの配列を返します。
AttributeDesc[]	getChildAttributeDescs() 子属性を表すAttributeDescの配列を返します。
java.lang.Class<?>	getElementType() 属性がコレクションを表している場合に要素の型を返します。
java.lang.String	getName() 属性の名前を返します。
int	getSqlType() 属性にマッピングされたJDBCのSQL型を返します。
TemporalType	getTemporalType() 属性の型がDateもしくはCalendarの場合、属性に注釈されている TemporalTypeを返します。
java.lang.Class<?>	getType() 属性の型を返します。
java.lang.Object	getValue(java.lang.Object owner) 属性の値を返します。
boolean	isAssociation() 属性が関連を表している場合trueを返します。
boolean	isCollection() 属性がコレクションを表している場合trueを返します。
boolean	isComponent() 属性がコンポーネントを表している場合
boolean	isId() 属性がIDを表している場合trueを返します。
boolean	isVersion() 属性がバージョン番号を表している場合trueを返します。
void	setValue(java.lang.Object owner, java.lang.Object value) 属性に値を設定します。

メソッドの詳細

getName

java.lang.String getName()

属性の名前を返します。

戻り値:

名前

getType

java.lang.Class<?> getType()

属性の型を返します。

戻り値:

属性の型

getElementType

java.lang.Class<?> getElementType()

属性がコレクションを表している場合に要素の型を返します。

戻り値:

属性がコレクションを表している場合は要素の型、それ以外の場合はnull

getSqlType

int getSqlType()

属性にマッピングされたJDBCのSQL型を返します。

戻り値:

JDBCのSQL型

getTemporalType

TemporalType getTemporalType()

属性の型がDateもしくはCalendarの場合、属性に注釈されている TemporalTypeを返します。

戻り値:

属性の型がDateもしくはCalendarの場合は属性に注釈されている TemporalType、それ以外の型の場合はnull

getChildAttributeDescs

AttributeDesc[] getChildAttributeDescs()

子属性を表すAttributeDescの配列を返します。

この属性がコンポーネントである場合は長さが1以上の配列、コンポーネントでない場合は長さが0の配列を返します。

戻り値:

子属性を表すAttributeDescの配列

getChildAttributeDesc

AttributeDesc getChildAttributeDesc(java.lang.String name)

子属性を表すAttributeDescの配列を返します。

この属性がコンポーネントである場合は長さが1以上の配列、コンポーネントでない場合は長さが0の配列を返します。

パラメータ:

name - 子属性の名前

戻り値:

子属性を表すAttributeDescの配列

isId

boolean isId()

属性がIDを表している場合trueを返します。

戻り値:

属性がIDを表している場合true、表していない場合false

isAssociation

boolean isAssociation()

属性が関連を表している場合trueを返します。

戻り値:

属性が関連を表している場合true、表していない場合false

isCollection

boolean isCollection()

属性がコレクションを表している場合trueを返します。

戻り値:

属性がコレクションを表している場合true、表していない場合false

isComponent

boolean isComponent()

属性がコンポーネントを表している場合

戻り値:

属性がコンポーネントを表している場合true、表していない場合false

isVersion

boolean isVersion()

属性がバージョン番号を表している場合trueを返します。

戻り値:

属性がバージョン番号を表している場合true、表していない場合false

getValue

java.lang.Object getValue(java.lang.Object owner)

属性の値を返します。

パラメータ:

owner - 属性を所有するエンティティもしくはコンポーネントのインスタンス

戻り値:

属性の値

setValue

void setValue(java.lang.Object owner,
              java.lang.Object value)

属性に値を設定します。

パラメータ:

owner - 属性を所有するエンティティもしくはコンポーネントのインスタンス

value - 値