ForeignInfo (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.dbmeta.info.ForeignInfo

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

RelationInfo
```
public class ForeignInfo
extends Object
implements RelationInfo
```
The information of foreign relation.

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`_additionalFK`
`protected boolean`	`_bizOneToOne`
`protected boolean`	`_canBeNullObject`
`protected String`	`_constraintName`
`protected List<String>`	`_dynamicParameterList`
`protected String`	`_fixedCondition`
`protected boolean`	`_fixedInline`
`protected DBMeta`	`_foreignDBMeta`
`protected Map<ColumnInfo,ColumnInfo>`	`_foreignLocalColumnInfoMap`
`protected String`	`_foreignPropertyName`
`protected DBMeta`	`_localDBMeta`
`protected Map<ColumnInfo,ColumnInfo>`	`_localForeignColumnInfoMap`
`protected Class<?>`	`_objectNativeType`
`protected boolean`	`_oneToOne`
`protected Class<?>`	`_propertyAccessType`
`protected PropertyGateway`	`_propertyGateway`
`protected PropertyMethodFinder`	`_propertyMethodFinder`
`protected Method`	`_readMethod`
`protected boolean`	`_referrerAsOne`
`protected int`	`_relationNo`
`protected String`	`_reversePropertyName`
`protected Method`	`_writeMethod`

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

コンストラクタ
コンストラクタと説明
`ForeignInfo(String constraintName, String foreignPropertyName, DBMeta localDBMeta, DBMeta foreignDBMeta, Map<ColumnInfo,ColumnInfo> localForeignColumnInfoMap, int relationNo, Class<?> propertyAccessType, boolean oneToOne, boolean bizOneToOne, boolean referrerAsOne, boolean additionalFK, String fixedCondition, List<String> dynamicParameterList, boolean fixedInline, String reversePropertyName, boolean canBeNullObject, PropertyMethodFinder propertyMethodFinder)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`assertObjectNotNull(String variableName, Object value)`
`boolean`	`canBeNullObject()` Can the relation be null object?
`boolean`	`containsForeignColumn(ColumnInfo foreignColumn)`
`boolean`	`containsLocalColumn(ColumnInfo localColumn)`
`protected boolean`	`doContainsForeignColumn(String columnName)`
`protected boolean`	`doContainsLocalColumn(String columnName)`
`boolean`	`equals(Object obj)`
`ColumnInfo`	`findForeignByLocal(String localColumnDbName)`
`ColumnInfo`	`findLocalByForeign(String foreignColumnDbName)`
`protected PropertyGateway`	`findPropertyGateway()`
`protected Method`	`findReadMethod()`
`protected Method`	`findWriteMethod()`
`String`	`getConstraintName()` Get the name of the relation constraint.
`List<String>`	`getDynamicParameterList()` Get the read-only list of dynamic parameter name for fixed-condition if it's additional foreign key.
`String`	`getFixedCondition()` Get the fixed-condition if it's additional foreign key.
`DBMeta`	`getForeignDBMeta()` Get the DB meta of the foreign table.
`Map<ColumnInfo,ColumnInfo>`	`getForeignLocalColumnInfoMap()` Get the read-only map, key is a foreign column info, value is a local column info.
`String`	`getForeignPropertyName()` Get the property name of the foreign relation.
`DBMeta`	`getLocalDBMeta()` Get the DB meta of the local table.
`Map<ColumnInfo,ColumnInfo>`	`getLocalForeignColumnInfoMap()` Get the read-only map, key is a local column info, value is a foreign column info.
`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.
`Method`	`getReadMethod()` Get the read method for entity reflection.
`int`	`getRelationNo()` Get the number of a 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.
`Method`	`getWriteMethod()` Get the write method for entity reflection.
`boolean`	`hasFixedCondition()` Does it have fixed-condition for this relation?
`boolean`	`hasFixedConditionDynamicParameter()` Does it have dynamic parameter of fixed-condition?
`int`	`hashCode()`
`protected String`	`initCap(String name)`
`protected Object`	`invokeMethod(Method method, Object target, Object[] args)`
`boolean`	`isAdditionalFK()` Does the relation is from additional foreign key?
`boolean`	`isBizOneToOne()` Does the relation is biz-one-to-one?
`boolean`	`isCompoundKey()` Is the relation key compound key?
`boolean`	`isFixedConditionDynamicParameterRequired()` Is the dynamic parameters of fixed condition required?
`boolean`	`isFixedInline()` Does the fixed condition is for in-line view?
`boolean`	`isNotNullFKColumn()` Do the FK columns have not null constraint?
`boolean`	`isOneToOne()` Does the relation is one-to-one?
`boolean`	`isPureFK()` Does the relation is from pure foreign key?
`boolean`	`isReferrer()` Does the relation is referrer?
`boolean`	`isReferrerAsOne()` Does the relation is referrer-as-one?
`<PROPERTY> PROPERTY`	`read(Entity localEntity)` Read the value to the entity by its gateway (means no reflection).
`String`	`toString()`
`void`	`write(Entity localEntity, Object foreignEntity)` Write the value to the entity by its gateway (means no reflection).

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - _constraintName
```
protected final String _constraintName
```
  - _foreignPropertyName
```
protected final String _foreignPropertyName
```
  - _localDBMeta
```
protected final DBMeta _localDBMeta
```
  - _foreignDBMeta
```
protected final DBMeta _foreignDBMeta
```
  - _localForeignColumnInfoMap
```
protected final Map<ColumnInfo,ColumnInfo> _localForeignColumnInfoMap
```
  - _foreignLocalColumnInfoMap
```
protected final Map<ColumnInfo,ColumnInfo> _foreignLocalColumnInfoMap
```
  - _relationNo
```
protected final int _relationNo
```
  - _objectNativeType
```
protected final Class<?> _objectNativeType
```
  - _propertyAccessType
```
protected final Class<?> _propertyAccessType
```
  - _oneToOne
```
protected final boolean _oneToOne
```
  - _bizOneToOne
```
protected final boolean _bizOneToOne
```
  - _referrerAsOne
```
protected final boolean _referrerAsOne
```
  - _additionalFK
```
protected final boolean _additionalFK
```
  - _fixedCondition
```
protected final String _fixedCondition
```
  - _dynamicParameterList
```
protected final List<String> _dynamicParameterList
```
  - _fixedInline
```
protected final boolean _fixedInline
```
  - _reversePropertyName
```
protected final String _reversePropertyName
```
  - _canBeNullObject
```
protected final boolean _canBeNullObject
```
  - _propertyGateway
```
protected final PropertyGateway _propertyGateway
```
  - _propertyMethodFinder
```
protected final PropertyMethodFinder _propertyMethodFinder
```
  - _readMethod
```
protected final Method _readMethod
```
  - _writeMethod
```
protected final Method _writeMethod
```
- コンストラクタの詳細
  - ForeignInfo
```
public ForeignInfo(String constraintName,
                   String foreignPropertyName,
                   DBMeta localDBMeta,
                   DBMeta foreignDBMeta,
                   Map<ColumnInfo,ColumnInfo> localForeignColumnInfoMap,
                   int relationNo,
                   Class<?> propertyAccessType,
                   boolean oneToOne,
                   boolean bizOneToOne,
                   boolean referrerAsOne,
                   boolean additionalFK,
                   String fixedCondition,
                   List<String> dynamicParameterList,
                   boolean fixedInline,
                   String reversePropertyName,
                   boolean canBeNullObject,
                   PropertyMethodFinder propertyMethodFinder)
```
- メソッドの詳細
  - containsLocalColumn
```
public boolean containsLocalColumn(ColumnInfo localColumn)
```
  - doContainsLocalColumn
```
protected boolean doContainsLocalColumn(String columnName)
```
  - containsForeignColumn
```
public boolean containsForeignColumn(ColumnInfo foreignColumn)
```
  - doContainsForeignColumn
```
protected boolean doContainsForeignColumn(String columnName)
```
  - findLocalByForeign
```
public ColumnInfo findLocalByForeign(String foreignColumnDbName)
```
  - findForeignByLocal
```
public ColumnInfo findForeignByLocal(String localColumnDbName)
```
  - read
```
public <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.
    
    定義:
    
    read インタフェース内 RelationInfo
    
    型パラメータ:
    
    PROPERTY - The type of property, might be optional.
    
    パラメータ:
    
    localEntity - The local entity of this column to read. (NotNull)
    
    戻り値:
    
    The read instance of foreign entity, might be optional. (NotNull: when optional, NullAllowed: when native type)
  - getReadMethod
```
public Method getReadMethod()
```
    Get the read method for entity reflection.
    
    戻り値:
    
    The read method, cached in this instance. (NotNull)
  - write
```
public 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.
    
    定義:
    
    write インタフェース内 RelationInfo
    
    パラメータ:
    
    localEntity - The local entity of this column to write. (NotNull)
    
    foreignEntity - The written instance of foreign entity, might be optional. (NullAllowed: if null, null written)
  - getWriteMethod
```
public Method getWriteMethod()
```
    Get the write method for entity reflection.
    
    戻り値:
    
    The writer method, cached in this instance. (NotNull)
  - findPropertyGateway
```
protected PropertyGateway findPropertyGateway()
```
  - findReadMethod
```
protected Method findReadMethod()
```
  - findWriteMethod
```
protected Method findWriteMethod()
```
  - invokeMethod
```
protected Object invokeMethod(Method method,
                              Object target,
                              Object[] args)
```
  - getRelationPropertyName
```
public String getRelationPropertyName()
```
    インタフェースからコピーされた説明: RelationInfo
    
    Get the property name of the relation.
    This is unique name in the table.
    
    定義:
    
    getRelationPropertyName インタフェース内 RelationInfo
    
    戻り値:
    
    The property name of the relation. (NotNull)
  - getTargetDBMeta
```
public DBMeta getTargetDBMeta()
```
    インタフェースからコピーされた説明: RelationInfo
    
    Get the DB meta of the target table.
    For example, if the relation MEMBER and MEMBER_STATUS, this returns MEMBER_STATUS's one.
    
    定義:
    
    getTargetDBMeta インタフェース内 RelationInfo
    
    戻り値:
    
    The DB meta singleton instance. (NotNull)
  - getLocalTargetColumnInfoMap
```
public Map<ColumnInfo,ColumnInfo> getLocalTargetColumnInfoMap()
```
    インタフェースからコピーされた説明: RelationInfo
    
    Get the read-only map, key is a local column info, value is a target column info.
    
    定義:
    
    getLocalTargetColumnInfoMap インタフェース内 RelationInfo
    
    戻り値:
    
    The read-only map. (NotNull)
  - isReferrer
```
public boolean isReferrer()
```
    インタフェースからコピーされた説明: RelationInfo
    
    Does the relation is referrer?
    
    定義:
    
    isReferrer インタフェース内 RelationInfo
    
    戻り値:
    
    The determination, true or false.
  - initCap
```
protected String initCap(String name)
```
  - assertObjectNotNull
```
protected void assertObjectNotNull(String variableName,
                                   Object value)
```
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - getConstraintName
```
public String getConstraintName()
```
    Get the name of the relation constraint.
    The foreign info and the referrer info of the same relation have the same name.
    
    定義:
    
    getConstraintName インタフェース内 RelationInfo
    
    戻り値:
    
    The name of the relation constraint. (NotNull)
  - getForeignPropertyName
```
public String getForeignPropertyName()
```
    Get the property name of the foreign relation.
    This is unique name in the table.
    For example, if the member entity has getMemberStatus(), this returns 'memberStatus'.
    
    戻り値:
    
    The string for property name. (NotNull)
  - getLocalDBMeta
```
public DBMeta getLocalDBMeta()
```
    Get the DB meta of the local table.
    For example, if the relation MEMBER and MEMBER_STATUS, this returns MEMBER's one.
    
    定義:
    
    getLocalDBMeta インタフェース内 RelationInfo
    
    戻り値:
    
    The DB meta singleton instance. (NotNull)
  - getForeignDBMeta
```
public DBMeta getForeignDBMeta()
```
    Get the DB meta of the foreign table.
    For example, if the relation MEMBER and MEMBER_STATUS, this returns MEMBER_STATUS's one.
    
    戻り値:
    
    The DB meta singleton instance. (NotNull)
  - getLocalForeignColumnInfoMap
```
public Map<ColumnInfo,ColumnInfo> getLocalForeignColumnInfoMap()
```
    Get the read-only map, key is a local column info, value is a foreign column info.
    
    戻り値:
    
    The read-only map. (NotNull, EmptyAllowed: only when fixedOnlyJoin)
  - getForeignLocalColumnInfoMap
```
public Map<ColumnInfo,ColumnInfo> getForeignLocalColumnInfoMap()
```
    Get the read-only map, key is a foreign column info, value is a local column info.
    
    戻り値:
    
    The read-only map. (NotNull, EmptyAllowed: only when fixedOnlyJoin)
  - getRelationNo
```
public int getRelationNo()
```
    Get the number of a relation. (internal property)
    
    戻り値:
    
    The number of a relation. (NotNull, NotMinus)
  - getObjectNativeType
```
public 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.
    
    定義:
    
    getObjectNativeType インタフェース内 RelationInfo
    
    戻り値:
    
    The class type for the relation entity. (NotNull)
  - getPropertyAccessType
```
public 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.
    
    定義:
    
    getPropertyAccessType インタフェース内 RelationInfo
    
    戻り値:
    
    The class type to access the property, e.g. Entity or Optional. (NotNull)
  - isOneToOne
```
public boolean isOneToOne()
```
    Does the relation is one-to-one?
    
    定義:
    
    isOneToOne インタフェース内 RelationInfo
    
    戻り値:
    
    The determination, true or false.
  - isBizOneToOne
```
public boolean isBizOneToOne()
```
    Does the relation is biz-one-to-one?
    
    戻り値:
    
    The determination, true or false.
  - isReferrerAsOne
```
public boolean isReferrerAsOne()
```
    Does the relation is referrer-as-one?
    
    戻り値:
    
    The determination, true or false.
  - isAdditionalFK
```
public boolean isAdditionalFK()
```
    Does the relation is from additional foreign key?
    
    戻り値:
    
    The determination, true or false.
  - getFixedCondition
```
public String getFixedCondition()
```
    Get the fixed-condition if it's additional foreign key.
    
    戻り値:
    
    The string of fixed-condition. (NullAllowed)
  - getDynamicParameterList
```
public List<String> getDynamicParameterList()
```
    Get the read-only list of dynamic parameter name for fixed-condition if it's additional foreign key.
    
    戻り値:
    
    The read-only list. (NotNull: if no fixed-condition, returns empty list)
  - isFixedInline
```
public boolean isFixedInline()
```
    Does the fixed condition is for in-line view?
    
    戻り値:
    
    The determination, true or false.
  - getReverseRelation
```
public RelationInfo getReverseRelation()
```
    Get the relation info of reverse relation.
    
    定義:
    
    getReverseRelation インタフェース内 RelationInfo
    
    戻り値:
    
    The instance of relation info. (NullAllowed: if null, means one-way reference)
  - canBeNullObject
```
public boolean canBeNullObject()
```
    Can the relation be null object?
    
    戻り値:
    
    The determination, true or false.
  - isCompoundKey
```
public boolean isCompoundKey()
```
    Is the relation key compound key?
    
    定義:
    
    isCompoundKey インタフェース内 RelationInfo
    
    戻り値:
    
    The determination, true or false.
  - isPureFK
```
public boolean isPureFK()
```
    Does the relation is from pure foreign key?
    
    戻り値:
    
    The determination, true or false.
  - isNotNullFKColumn
```
public boolean isNotNullFKColumn()
```
    Do the FK columns have not null constraint?
    
    戻り値:
    
    The determination, true or false.
  - hasFixedCondition
```
public boolean hasFixedCondition()
```
    Does it have fixed-condition for this relation?
    
    戻り値:
    
    The determination, true or false.
  - hasFixedConditionDynamicParameter
```
public boolean hasFixedConditionDynamicParameter()
```
    Does it have dynamic parameter of fixed-condition?
    
    戻り値:
    
    The determination, true or false.
  - isFixedConditionDynamicParameterRequired
```
public boolean isFixedConditionDynamicParameterRequired()
```
    Is the dynamic parameters of fixed condition required?
    
    戻り値:
    
    The determination, true or false. (true if NOT contains IF comment)

クラス ForeignInfo

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_constraintName

_foreignPropertyName

_localDBMeta

_foreignDBMeta

_localForeignColumnInfoMap

_foreignLocalColumnInfoMap

_relationNo

_objectNativeType

_propertyAccessType

_oneToOne

_bizOneToOne

_referrerAsOne

_additionalFK

_fixedCondition

_dynamicParameterList

_fixedInline

_reversePropertyName

_canBeNullObject

_propertyGateway

_propertyMethodFinder

_readMethod

_writeMethod

コンストラクタの詳細

ForeignInfo

メソッドの詳細

containsLocalColumn

doContainsLocalColumn

containsForeignColumn

doContainsForeignColumn

findLocalByForeign

findForeignByLocal

read

getReadMethod

write

getWriteMethod

findPropertyGateway

findReadMethod

findWriteMethod

invokeMethod

getRelationPropertyName

getTargetDBMeta

getLocalTargetColumnInfoMap

isReferrer

initCap

assertObjectNotNull

hashCode

equals

toString

getConstraintName

getForeignPropertyName

getLocalDBMeta

getForeignDBMeta

getLocalForeignColumnInfoMap

getForeignLocalColumnInfoMap

getRelationNo

getObjectNativeType

getPropertyAccessType

isOneToOne

isBizOneToOne

isReferrerAsOne

isAdditionalFK

getFixedCondition

getDynamicParameterList

isFixedInline

getReverseRelation

canBeNullObject

isCompoundKey

isPureFK

isNotNullFKColumn

hasFixedCondition

hasFixedConditionDynamicParameter

isFixedConditionDynamicParameterRequired