ReferrerInfo (DBFlute Runtime 1.1.0-sp2-RC1 API)

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

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

RelationInfo
```
public class ReferrerInfo
extends Object
implements RelationInfo
```
The information of referrer relation.

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected String`	`_constraintName`
`protected DBMeta`	`_localDBMeta`
`protected Map<ColumnInfo,ColumnInfo>`	`_localReferrerColumnInfoMap`
`protected Class<?>`	`_objectNativeType`
`protected boolean`	`_oneToOne`
`protected Class<?>`	`_propertyAccessType`
`protected PropertyMethodFinder`	`_propertyMethodFinder`
`protected Method`	`_readMethod`
`protected DBMeta`	`_referrerDBMeta`
`protected Map<ColumnInfo,ColumnInfo>`	`_referrerLocalColumnInfoMap`
`protected String`	`_referrerPropertyName`
`protected String`	`_reversePropertyName`
`protected Method`	`_writeMethod`

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

コンストラクタ
コンストラクタと説明
`ReferrerInfo(String constraintName, String referrerPropertyName, DBMeta localDBMeta, DBMeta referrerDBMeta, Map<ColumnInfo,ColumnInfo> localReferrerColumnInfoMap, Class<?> propertyAccessType, boolean oneToOne, String reversePropertyName, PropertyMethodFinder propertyMethodFinder)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`assertObjectNotNull(String variableName, Object value)`
`boolean`	`containsLocalColumn(ColumnInfo localColumn)`
`boolean`	`containsReferrerColumn(ColumnInfo referrerColumn)`
`protected boolean`	`doContainsLocalColumn(String columnName)`
`protected boolean`	`doContainsReferrerColumn(String columnName)`
`boolean`	`equals(Object obj)`
`ColumnInfo`	`findLocalByReferrer(String referrerColumnDbName)`
`protected Method`	`findReadMethod()`
`ColumnInfo`	`findReferrerByLocal(String localColumnDbName)`
`protected Method`	`findWriteMethod()`
`String`	`getConstraintName()` Get the name of the relation constraint.
`DBMeta`	`getLocalDBMeta()` Get the DB meta of the local table.
`Map<ColumnInfo,ColumnInfo>`	`getLocalReferrerColumnInfoMap()` Get the read-only map, key is a local column info, value is a referrer 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.
`DBMeta`	`getReferrerDBMeta()` Get the DB meta of the referrer table.
`Map<ColumnInfo,ColumnInfo>`	`getReferrerLocalColumnInfoMap()` Get the read-only map, key is a referrer column info, value is a column column info.
`String`	`getReferrerPropertyName()` Get the property name of the foreign 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.
`int`	`hashCode()`
`protected String`	`initCap(String name)`
`protected Object`	`invokeMethod(Method method, Object target, Object[] args)`
`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.
`String`	`toString()`
`void`	`write(Entity localEntity, Object referrerEntityList)` Write the value to the entity.

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

- フィールドの詳細
  - _constraintName
```
protected final String _constraintName
```
  - _referrerPropertyName
```
protected final String _referrerPropertyName
```
  - _localDBMeta
```
protected final DBMeta _localDBMeta
```
  - _referrerDBMeta
```
protected final DBMeta _referrerDBMeta
```
  - _localReferrerColumnInfoMap
```
protected final Map<ColumnInfo,ColumnInfo> _localReferrerColumnInfoMap
```
  - _referrerLocalColumnInfoMap
```
protected final Map<ColumnInfo,ColumnInfo> _referrerLocalColumnInfoMap
```
  - _objectNativeType
```
protected final Class<?> _objectNativeType
```
  - _propertyAccessType
```
protected final Class<?> _propertyAccessType
```
  - _oneToOne
```
protected final boolean _oneToOne
```
  - _reversePropertyName
```
protected final String _reversePropertyName
```
  - _propertyMethodFinder
```
protected final PropertyMethodFinder _propertyMethodFinder
```
  - _readMethod
```
protected final Method _readMethod
```
  - _writeMethod
```
protected final Method _writeMethod
```
- コンストラクタの詳細
  - ReferrerInfo
```
public ReferrerInfo(String constraintName,
                    String referrerPropertyName,
                    DBMeta localDBMeta,
                    DBMeta referrerDBMeta,
                    Map<ColumnInfo,ColumnInfo> localReferrerColumnInfoMap,
                    Class<?> propertyAccessType,
                    boolean oneToOne,
                    String reversePropertyName,
                    PropertyMethodFinder propertyMethodFinder)
```
- メソッドの詳細
  - containsLocalColumn
```
public boolean containsLocalColumn(ColumnInfo localColumn)
```
  - doContainsLocalColumn
```
protected boolean doContainsLocalColumn(String columnName)
```
  - containsReferrerColumn
```
public boolean containsReferrerColumn(ColumnInfo referrerColumn)
```
  - doContainsReferrerColumn
```
protected boolean doContainsReferrerColumn(String columnName)
```
  - findLocalByReferrer
```
public ColumnInfo findLocalByReferrer(String referrerColumnDbName)
```
  - findReferrerByLocal
```
public ColumnInfo findReferrerByLocal(String localColumnDbName)
```
  - read
```
public <PROPERTY> PROPERTY read(Entity localEntity)
```
    Read the value to the entity.
    It returns plain value in entity as property access type.
    
    定義:
    
    read インタフェース内 RelationInfo
    
    型パラメータ:
    
    PROPERTY - The type of property, basically entity list.
    
    パラメータ:
    
    localEntity - The local entity of this column to read. (NotNull)
    
    戻り値:
    
    The read instance of referrer entity. (NullAllowed)
  - 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 referrerEntityList)
```
    Write the value to the entity.
    No converting to anything so check the property access type.
    
    定義:
    
    write インタフェース内 RelationInfo
    
    パラメータ:
    
    localEntity - The local entity of this column to write. (NotNull)
    
    referrerEntityList - The written list of referrer entity. (NullAllowed: if null, null written)
  - getWriteMethod
```
public Method getWriteMethod()
```
    Get the write method for entity reflection.
    
    戻り値:
    
    The writer method, cached in this instance. (NotNull)
  - 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)
  - getReferrerPropertyName
```
public String getReferrerPropertyName()
```
    Get the property name of the foreign relation.
    This is unique name in the table.
    For example, if the relation MEMBER and PURCHASE, this returns 'purchaseList'.
    
    戻り値:
    
    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)
  - getReferrerDBMeta
```
public DBMeta getReferrerDBMeta()
```
    Get the DB meta of the referrer table.
    For example, if the relation MEMBER and PURCHASE, this returns PURCHASE's one.
    
    戻り値:
    
    The DB meta singleton instance. (NotNull)
  - getLocalReferrerColumnInfoMap
```
public Map<ColumnInfo,ColumnInfo> getLocalReferrerColumnInfoMap()
```
    Get the read-only map, key is a local column info, value is a referrer column info.
    
    戻り値:
    
    The read-only map. (NotNull)
  - getReferrerLocalColumnInfoMap
```
public Map<ColumnInfo,ColumnInfo> getReferrerLocalColumnInfoMap()
```
    Get the read-only map, key is a referrer column info, value is a column column info.
    
    戻り値:
    
    The read-only map. (NotNull)
  - 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?
    But basically this returns false because DBFlute treats one-to-one relations as a foreign relation.
    
    定義:
    
    isOneToOne インタフェース内 RelationInfo
    
    戻り値:
    
    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)
  - isCompoundKey
```
public boolean isCompoundKey()
```
    Is the relation key compound key?
    
    定義:
    
    isCompoundKey インタフェース内 RelationInfo
    
    戻り値:
    
    The determination, true or false.

クラス ReferrerInfo

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_constraintName

_referrerPropertyName

_localDBMeta

_referrerDBMeta

_localReferrerColumnInfoMap

_referrerLocalColumnInfoMap

_objectNativeType

_propertyAccessType

_oneToOne

_reversePropertyName

_propertyMethodFinder

_readMethod

_writeMethod

コンストラクタの詳細

ReferrerInfo

メソッドの詳細

containsLocalColumn

doContainsLocalColumn

containsReferrerColumn

doContainsReferrerColumn

findLocalByReferrer

findReferrerByLocal

read

getReadMethod

write

getWriteMethod

findReadMethod

findWriteMethod

invokeMethod

getRelationPropertyName

getTargetDBMeta

getLocalTargetColumnInfoMap

isReferrer

initCap

assertObjectNotNull

hashCode

equals

toString

getConstraintName

getReferrerPropertyName

getLocalDBMeta

getReferrerDBMeta

getLocalReferrerColumnInfoMap

getReferrerLocalColumnInfoMap

getObjectNativeType

getPropertyAccessType

isOneToOne

getReverseRelation

isCompoundKey