org.dbflute.dbmeta.info

インタフェース RelationInfo

既知の実装クラスのリスト:

ForeignInfo, ReferrerInfo

public interface RelationInfo

The class of relation information.

作成者:

jflute

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getConstraintName() Get the name of the relation constraint.
DBMeta	getLocalDBMeta() Get the DB meta of the local table.
Map<ColumnInfo,ColumnInfo>	getLocalTargetColumnInfoMap() Get the read-only map, key is a local column info, value is a target column info.
Class<?>	getObjectNativeType() Get the native type mapped to object for the column.
Class<?>	getPropertyAccessType() Get the type of property access for the relation.
String	getRelationPropertyName() Get the property name of the relation.
RelationInfo	getReverseRelation() Get the relation info of reverse relation.
DBMeta	getTargetDBMeta() Get the DB meta of the target table.
boolean	isCompoundKey() Is the relation key compound key?
boolean	isOneToOne() Does the relation is one-to-one?
boolean	isReferrer() Does the relation is referrer?
<PROPERTY> PROPERTY	read(Entity localEntity) Read the value to the entity by its gateway (means no reflection).
void	write(Entity localEntity, Object foreignEntity) Write the value to the entity by its gateway (means no reflection).

メソッドの詳細

getConstraintName

String getConstraintName()

Get the name of the relation constraint.
The foreign info and the referrer info of the same relation have the same name.

戻り値:

The name of the relation constraint. (NotNull)

getRelationPropertyName

String getRelationPropertyName()

Get the property name of the relation.
This is unique name in the table.

戻り値:

The property name of the relation. (NotNull)

getLocalDBMeta

DBMeta getLocalDBMeta()

Get the DB meta of the local table.
For example, if the relation MEMBER and MEMBER_STATUS, this returns MEMBER's one.

戻り値:

The DB meta singleton instance. (NotNull)

getTargetDBMeta

DBMeta getTargetDBMeta()

Get the DB meta of the target table.
For example, if the relation MEMBER and MEMBER_STATUS, this returns MEMBER_STATUS's one.

戻り値:

The DB meta singleton instance. (NotNull)

getLocalTargetColumnInfoMap

Map<ColumnInfo,ColumnInfo> getLocalTargetColumnInfoMap()

Get the read-only map, key is a local column info, value is a target column info.

戻り値:

The read-only map. (NotNull)

getObjectNativeType

Class<?> getObjectNativeType()

Get the native type mapped to object for the column. (NOT property access type)
It returns basically relation entity type even if the property type is optional.
And also there is the other method that returns property access type.

戻り値:

The class type for the relation entity. (NotNull)

getPropertyAccessType

Class<?> getPropertyAccessType()

Get the type of property access for the relation.
It is defined at getter/setter in entity. (e.g. Entity or Optional)
And also there is the other method that always returns object native type.

戻り値:

The class type to access the property, e.g. Entity or Optional. (NotNull)

isOneToOne

boolean isOneToOne()

Does the relation is one-to-one?

戻り値:

The determination, true or false.

isReferrer

boolean isReferrer()

Does the relation is referrer?

戻り値:

The determination, true or false.

isCompoundKey

boolean isCompoundKey()

Is the relation key compound key?

戻り値:

The determination, true or false.

getReverseRelation

RelationInfo getReverseRelation()

Get the relation info of reverse relation.

戻り値:

The instance of relation info. (NullAllowed: if null, means one-way reference)

read

<PROPERTY> PROPERTY read(Entity localEntity)

Read the value to the entity by its gateway (means no reflection).
It returns plain value in entity as property access type.

型パラメータ:

PROPERTY - The type of property, might be optional or list.

パラメータ:

localEntity - The local entity of this column to read. (NotNull)

戻り値:

The read instance of relation entity, might be optional or list. (NotNull: when optional or list, NullAllowed: when native type)

write

void write(Entity localEntity,
           Object foreignEntity)

Write the value to the entity by its gateway (means no reflection).
No converting to optional so check the property access type.

パラメータ:

localEntity - The local entity of this column to write. (NotNull)

foreignEntity - The written instance of relation entity, might be optional or list. (NullAllowed: if null, null written)