TnRelationRowCreationResource (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.s2dao.rowcreator.TnRelationRowCreationResource

```
public class TnRelationRowCreationResource
extends Object
```
The resource for relation row creation.
S2Dao logics are modified for DBFlute.

作成者:

modified by jflute (originated in S2Dao)

プロパティのサマリー

All Methods Instance Methods Concrete Methods
タイププロパティと説明

protected boolean hasNextRelation

All Methods Instance Methods Concrete Methods
タイプ	プロパティと説明
`protected boolean`	`hasNextRelation`

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected String`	`_baseSuffix` The suffix of base object.
`protected Stack<String>`	`_baseSuffixBackup` The backup of base suffix.
`protected boolean`	`_createDeadLink` Does it create dead link?
`protected TnPropertyMapping`	`_currentPropertyMapping` Current property mapping.
`protected int`	`_currentRelationNestLevel` The current relation nest level.
`protected int`	`_limitRelationNestLevel` The limit of relation nest level.
`protected TnRelationKey`	`_relationKey` The relation key, which has key values, of the relation.
`protected Stack<TnRelationKey>`	`_relationKeyBackup` The backup of relation key.
`protected String`	`_relationNoSuffix` The suffix of relation no, e.g. _0, _1_3.
`protected TnRelationPropertyType`	`_relationPropertyType` Relation property type.
`protected Stack<TnRelationPropertyType>`	`_relationPropertyTypeBackup` The backup of relation property type.
`protected Stack<String>`	`_relationSuffixBackup` The backup of base suffix.
`protected Map<String,Map<String,TnPropertyMapping>>`	`_relPropCache` The map of relation property cache.
`protected TnRelationRowCache`	`_relRowCache` The cache of relation row.
`protected TnRelationSelector`	`_relSelector` The selector of relation.
`protected ResultSet`	`_resultSet` Result set.
`protected Object`	`_row` Relation row.
`protected Map<String,String>`	`_selectColumnMap` The name map of select column (exists in select clause).
`protected Map<String,Map<String,Integer>>`	`_selectIndexMap` The map of select index. map:{ localAlias or relationNoSuffix = map:{ selectColumnKeyName = selectIndex } } (NullAllowed)
`protected int`	`_validValueCount` The count of valid value.

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

コンストラクタ
コンストラクタと説明

TnRelationRowCreationResource()

コンストラクタ
コンストラクタと説明
`TnRelationRowCreationResource()`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`addRelationNoSuffix(String additionalRelationNoSuffix)`
`protected void`	`backupBaseSuffix()`
`protected void`	`backupRelationKey()`
`protected void`	`backupRelationNoSuffix()`
`protected void`	`backupRelationPropertyType()`
`String`	`buildRelationColumnName()`
`boolean`	`canUseRelationCache()` Can it use the relation cache for entity mapping?
`void`	`clearRowInstance()`
`void`	`clearValidValueCount()`
`void`	`closeNextLevelMapping()`
`void`	`closeNextRelationProperty()`
`boolean`	`containsRelationKeyColumn(String columnName)`
`boolean`	`containsSelectColumn(String columnKeyName)` Does the column name contain in selected columns?
`protected void`	`decrementCurrentRelationNestLevel()`
`protected TnRelationKey`	`doCreateRelationKey()`
`Map<String,TnPropertyMapping>`	`extractPropertyCacheElement()`
`Object`	`extractRelationKeyValue(String columnName)`
`String`	`getBaseSuffix()`
`protected Stack<String>`	`getBaseSuffixBackup()`
`TnPropertyMapping`	`getCurrentPropertyMapping()`
`int`	`getCurrentRelationNestLevel()`
`int`	`getLimitRelationNestLevel()`
`TnBeanMetaData`	`getRelationBeanMetaData()`
`TnRelationKey`	`getRelationKey()`
`protected Stack<TnRelationKey>`	`getRelationKeyBackup()`
`String`	`getRelationNoSuffix()`
`protected Stack<String>`	`getRelationNoSuffixBackup()`
`TnRelationPropertyType`	`getRelationPropertyType()`
`protected Stack<TnRelationPropertyType>`	`getRelationPropertyTypeBackup()`
`TnRelationSelector`	`getRelationSelector()`
`Map<String,Map<String,TnPropertyMapping>>`	`getRelPropCache()`
`TnRelationRowCache`	`getRelRowCache()`
`ResultSet`	`getResultSet()`
`Object`	`getRow()`
`Map<String,String>`	`getSelectColumnMap()`
`Map<String,Map<String,Integer>>`	`getSelectIndexMap()`
`protected boolean`	`hasNextRelationProperty()`
`boolean`	`hasPropertyCacheElement()`
`boolean`	`hasRowInstance()`
`boolean`	`hasValidValueCount()`
`protected void`	`incrementCurrentRelationNestLevel()`
`void`	`incrementValidValueCount()`
`void`	`initializePropertyCacheElement()`
`boolean`	`isCreateDeadLink()`
`protected boolean`	`isNextRelationUnderLimit()`
`protected boolean`	`isNonLimitMapping()` Does the mapping has non-limit of relation nest level?
`protected boolean`	`isNonSelectedNextConnectingRelation()` Does the relation (of current relation No suffix) non-connect to selected next relation?
`protected boolean`	`isNonSelectedRelation()` Is the relation (of current relation No suffix) non-selected?
`boolean`	`isNonSpecifiedColumnAccessAllowed()` Is the access to non-specified column allowed?
`boolean`	`isStopCurrentRelationMapping()` Does it stop the mapping of the current relation?
`boolean`	`isStopNextRelationMapping()` Does it stop the mapping of the next level relation?
`boolean`	`isUsingSpecifyColumnInRelation()` Does the relation use SpecifyColumn?
`void`	`prepareNextLevelMapping()`
`void`	`prepareNextRelationProperty(TnRelationPropertyType nextRpt)`
`TnRelationKey`	`prepareRelationKey()` Prepare the relation key of the current relation.
`protected void`	`restoreBaseSuffix()`
`protected void`	`restoreRelationKey()`
`protected void`	`restoreRelationNoSuffix()`
`protected void`	`restoreRelationPropertyType()`
`void`	`savePropertyCacheElement()`
`void`	`setBaseSuffix(String baseSuffix)`
`void`	`setCreateDeadLink(boolean createDeadLink)`
`void`	`setCurrentPropertyType(TnPropertyMapping propertyType)`
`void`	`setCurrentRelationNestLevel(int currentRelationNestLevel)`
`void`	`setLimitRelationNestLevel(int limitRelationNestLevel)`
`void`	`setRelationKey(TnRelationKey relationKey)`
`void`	`setRelationNoSuffix(String relationNoSuffix)`
`void`	`setRelationPropertyType(TnRelationPropertyType rpt)`
`void`	`setRelationSelector(TnRelationSelector relSelector)`
`void`	`setRelPropCache(Map<String,Map<String,TnPropertyMapping>> relPropCache)`
`void`	`setRelRowCache(TnRelationRowCache relRowCache)`
`void`	`setResultSet(ResultSet resultSet)`
`void`	`setRow(Object row)`
`void`	`setSelectColumnMap(Map<String,String> selectColumnMap)`
`void`	`setSelectIndexMap(Map<String,Map<String,Integer>> selectIndexMap)`

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

プロパティの詳細

hasNextRelation

protected boolean hasNextRelationProperty

フィールドの詳細
- _resultSet
```
protected ResultSet _resultSet
```
  Result set. (NotNull)
- _row
```
protected Object _row
```
  Relation row. (TemporaryUsed)
- _relationPropertyType
```
protected TnRelationPropertyType _relationPropertyType
```
  Relation property type. (NotNull)
- _selectColumnMap
```
protected Map<String,String> _selectColumnMap
```
  The name map of select column (exists in select clause). (NotNull)
- _selectIndexMap
```
protected Map<String,Map<String,Integer>> _selectIndexMap
```
  The map of select index. map:{ localAlias or relationNoSuffix = map:{ selectColumnKeyName = selectIndex } } (NullAllowed)
- _relationKey
```
protected TnRelationKey _relationKey
```
  The relation key, which has key values, of the relation. (NotNull)
- _relPropCache
```
protected Map<String,Map<String,TnPropertyMapping>> _relPropCache
```
  The map of relation property cache. Keys are relationNoSuffix, columnName. (NotNull)
- _relRowCache
```
protected TnRelationRowCache _relRowCache
```
  The cache of relation row. (NotNull)
- _relSelector
```
protected TnRelationSelector _relSelector
```
  The selector of relation. (NotNull)
- _baseSuffix
```
protected String _baseSuffix
```
  The suffix of base object. (NotNull, EmptyAllowed: empty means base relation is base point)
- _relationNoSuffix
```
protected String _relationNoSuffix
```
  The suffix of relation no, e.g. _0, _1_3. (NotNull)
- _limitRelationNestLevel
```
protected int _limitRelationNestLevel
```
  The limit of relation nest level.
- _currentRelationNestLevel
```
protected int _currentRelationNestLevel
```
  The current relation nest level. Default is one.
- _currentPropertyMapping
```
protected TnPropertyMapping _currentPropertyMapping
```
  Current property mapping. (TemporaryUsed)
- _validValueCount
```
protected int _validValueCount
```
  The count of valid value.
- _createDeadLink
```
protected boolean _createDeadLink
```
  Does it create dead link?
- _relationPropertyTypeBackup
```
protected Stack<TnRelationPropertyType> _relationPropertyTypeBackup
```
  The backup of relation property type. The element type is TnRelationPropertyType.
- _relationKeyBackup
```
protected Stack<TnRelationKey> _relationKeyBackup
```
  The backup of relation key. The element type is TnRelationKey.
- _baseSuffixBackup
```
protected Stack<String> _baseSuffixBackup
```
  The backup of base suffix. The element type is String.
- _relationSuffixBackup
```
protected Stack<String> _relationSuffixBackup
```
  The backup of base suffix. The element type is String.

コンストラクタの詳細
- TnRelationRowCreationResource
```
public TnRelationRowCreationResource()
```

メソッドの詳細

hasRowInstance
```
public boolean hasRowInstance()
```

clearRowInstance
```
public void clearRowInstance()
```

getRelationBeanMetaData

public TnBeanMetaData getRelationBeanMetaData()

hasNextRelationProperty

protected boolean hasNextRelationProperty()

backupRelationPropertyType

protected void backupRelationPropertyType()

restoreRelationPropertyType

protected void restoreRelationPropertyType()

getRelationPropertyTypeBackup

protected Stack<TnRelationPropertyType> getRelationPropertyTypeBackup()

containsSelectColumn
```
public boolean containsSelectColumn(String columnKeyName)
```
Does the column name contain in selected columns? (exists in select clause?)

パラメータ:

columnKeyName - The key name of column. e.g. FOO, FOO_0_2 (NotNull)

戻り値:

The determination, true or false.

containsRelationKeyColumn

public boolean containsRelationKeyColumn(String columnName)

extractRelationKeyValue

public Object extractRelationKeyValue(String columnName)

backupRelationKey
```
protected void backupRelationKey()
```

restoreRelationKey
```
protected void restoreRelationKey()
```

getRelationKeyBackup

protected Stack<TnRelationKey> getRelationKeyBackup()

initializePropertyCacheElement

public void initializePropertyCacheElement()

hasPropertyCacheElement

public boolean hasPropertyCacheElement()

extractPropertyCacheElement

public Map<String,TnPropertyMapping> extractPropertyCacheElement()

savePropertyCacheElement

public void savePropertyCacheElement()

prepareRelationKey
```
public TnRelationKey prepareRelationKey()
                                 throws SQLException
```
Prepare the relation key of the current relation.
The created relation key is returned and saved in this resource if the key is created.

戻り値:

The created relation key. (NullAllowed: null means the relation has no data)

例外:

SQLException - When it fails to handle the SQL.

doCreateRelationKey

protected TnRelationKey doCreateRelationKey()
                                     throws SQLException

例外:: SQLException

buildRelationColumnName

public String buildRelationColumnName()

addRelationNoSuffix

protected void addRelationNoSuffix(String additionalRelationNoSuffix)

backupBaseSuffix
```
protected void backupBaseSuffix()
```

restoreBaseSuffix
```
protected void restoreBaseSuffix()
```

getBaseSuffixBackup

protected Stack<String> getBaseSuffixBackup()

backupRelationNoSuffix

protected void backupRelationNoSuffix()

restoreRelationNoSuffix

protected void restoreRelationNoSuffix()

getRelationNoSuffixBackup

protected Stack<String> getRelationNoSuffixBackup()

isNextRelationUnderLimit

protected boolean isNextRelationUnderLimit()

incrementCurrentRelationNestLevel

protected void incrementCurrentRelationNestLevel()

decrementCurrentRelationNestLevel

protected void decrementCurrentRelationNestLevel()

incrementValidValueCount

public void incrementValidValueCount()

clearValidValueCount
```
public void clearValidValueCount()
```

hasValidValueCount
```
public boolean hasValidValueCount()
```

prepareNextLevelMapping
```
public void prepareNextLevelMapping()
```

closeNextLevelMapping
```
public void closeNextLevelMapping()
```

prepareNextRelationProperty

public void prepareNextRelationProperty(TnRelationPropertyType nextRpt)

closeNextRelationProperty

public void closeNextRelationProperty()

isStopNextRelationMapping
```
public boolean isStopNextRelationMapping()
```
Does it stop the mapping of the next level relation?
This contains various determinations for performance.

戻り値:

The determination, true or false.

isStopCurrentRelationMapping
```
public boolean isStopCurrentRelationMapping()
```
Does it stop the mapping of the current relation?
This contains various determinations for performance.

戻り値:

The determination, true or false.

isNonLimitMapping
```
protected boolean isNonLimitMapping()
```
Does the mapping has non-limit of relation nest level?

戻り値:

The determination, true or false.

isNonSelectedRelation
```
protected boolean isNonSelectedRelation()
```
Is the relation (of current relation No suffix) non-selected?

戻り値:

The determination, true or false.

isNonSelectedNextConnectingRelation
```
protected boolean isNonSelectedNextConnectingRelation()
```
Does the relation (of current relation No suffix) non-connect to selected next relation?

戻り値:

The determination, true or false.

canUseRelationCache
```
public boolean canUseRelationCache()
```
Can it use the relation cache for entity mapping?

戻り値:

The determination, true or false.

isNonSpecifiedColumnAccessAllowed
```
public boolean isNonSpecifiedColumnAccessAllowed()
```
Is the access to non-specified column allowed?

戻り値:

The determination, true or false.

isUsingSpecifyColumnInRelation
```
public boolean isUsingSpecifyColumnInRelation()
```
Does the relation use SpecifyColumn?

戻り値:

The determination, true or false.

getResultSet
```
public ResultSet getResultSet()
```

setResultSet

public void setResultSet(ResultSet resultSet)

getRow
```
public Object getRow()
```

setRow
```
public void setRow(Object row)
```

getRelationPropertyType

public TnRelationPropertyType getRelationPropertyType()

setRelationPropertyType

public void setRelationPropertyType(TnRelationPropertyType rpt)

getSelectColumnMap

public Map<String,String> getSelectColumnMap()

setSelectColumnMap

public void setSelectColumnMap(Map<String,String> selectColumnMap)

getSelectIndexMap

public Map<String,Map<String,Integer>> getSelectIndexMap()

setSelectIndexMap

public void setSelectIndexMap(Map<String,Map<String,Integer>> selectIndexMap)

getRelationKey
```
public TnRelationKey getRelationKey()
```

setRelationKey

public void setRelationKey(TnRelationKey relationKey)

getRelPropCache

public Map<String,Map<String,TnPropertyMapping>> getRelPropCache()

setRelPropCache

public void setRelPropCache(Map<String,Map<String,TnPropertyMapping>> relPropCache)

getRelRowCache

public TnRelationRowCache getRelRowCache()

setRelRowCache

public void setRelRowCache(TnRelationRowCache relRowCache)

getBaseSuffix
```
public String getBaseSuffix()
```

setBaseSuffix

public void setBaseSuffix(String baseSuffix)

getRelationNoSuffix
```
public String getRelationNoSuffix()
```

setRelationNoSuffix

public void setRelationNoSuffix(String relationNoSuffix)

getLimitRelationNestLevel

public int getLimitRelationNestLevel()

setLimitRelationNestLevel

public void setLimitRelationNestLevel(int limitRelationNestLevel)

getCurrentRelationNestLevel

public int getCurrentRelationNestLevel()

setCurrentRelationNestLevel

public void setCurrentRelationNestLevel(int currentRelationNestLevel)

getCurrentPropertyMapping

public TnPropertyMapping getCurrentPropertyMapping()

setCurrentPropertyType

public void setCurrentPropertyType(TnPropertyMapping propertyType)

isCreateDeadLink
```
public boolean isCreateDeadLink()
```

setCreateDeadLink

public void setCreateDeadLink(boolean createDeadLink)

getRelationSelector

public TnRelationSelector getRelationSelector()

setRelationSelector

public void setRelationSelector(TnRelationSelector relSelector)

クラス TnRelationRowCreationResource

プロパティのサマリー

フィールドのサマリー

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

メソッドのサマリー

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

プロパティの詳細

hasNextRelation

フィールドの詳細

_resultSet

_row

_relationPropertyType

_selectColumnMap

_selectIndexMap

_relationKey

_relPropCache

_relRowCache

_relSelector

_baseSuffix

_relationNoSuffix

_limitRelationNestLevel

_currentRelationNestLevel

_currentPropertyMapping

_validValueCount

_createDeadLink

_relationPropertyTypeBackup

_relationKeyBackup

_baseSuffixBackup

_relationSuffixBackup

コンストラクタの詳細

TnRelationRowCreationResource

メソッドの詳細

hasRowInstance

clearRowInstance

getRelationBeanMetaData

hasNextRelationProperty

backupRelationPropertyType

restoreRelationPropertyType

getRelationPropertyTypeBackup

containsSelectColumn

containsRelationKeyColumn

extractRelationKeyValue

backupRelationKey

restoreRelationKey

getRelationKeyBackup

initializePropertyCacheElement

hasPropertyCacheElement

extractPropertyCacheElement

savePropertyCacheElement

prepareRelationKey

doCreateRelationKey

buildRelationColumnName

addRelationNoSuffix

backupBaseSuffix

restoreBaseSuffix

getBaseSuffixBackup

backupRelationNoSuffix

restoreRelationNoSuffix

getRelationNoSuffixBackup

isNextRelationUnderLimit

incrementCurrentRelationNestLevel

decrementCurrentRelationNestLevel

incrementValidValueCount

clearValidValueCount

hasValidValueCount

prepareNextLevelMapping

closeNextLevelMapping

prepareNextRelationProperty

closeNextRelationProperty

isStopNextRelationMapping

isStopCurrentRelationMapping

isNonLimitMapping

isNonSelectedRelation

isNonSelectedNextConnectingRelation

canUseRelationCache

isNonSpecifiedColumnAccessAllowed

isUsingSpecifyColumnInRelation

getResultSet

setResultSet

getRow