org.dbflute.s2dao.rowcreator

インタフェース TnRelationRowCreator

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

TnRelationRowCreatorExtension, TnRelationRowCreatorImpl

public interface TnRelationRowCreator

作成者:

modified by jflute (originated in S2Dao)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Map<String,Map<String,TnPropertyMapping>>	createPropertyCache(Map<String,String> selectColumnMap, Map<String,Map<String,Integer>> selectIndexMap, TnRelationSelector relSelector, TnBeanMetaData baseBmd) Create relation property cache.
Object	createRelationRow(ResultSet rs, TnRelationPropertyType rpt, Map<String,String> selectColumnMap, Map<String,Map<String,Integer>> selectIndexMap, TnRelationKey relKey, Map<String,Map<String,TnPropertyMapping>> relPropCache, TnRelationRowCache relRowCache, TnRelationSelector relSelector) Create relation row from first level relation.
Object	filterOptionalRelationRowIfNeeds(Object row, TnRelationPropertyType rpt, Object relationRow) Filter the relation row as optional object if it needs.

メソッドの詳細

createRelationRow

Object createRelationRow(ResultSet rs,
                         TnRelationPropertyType rpt,
                         Map<String,String> selectColumnMap,
                         Map<String,Map<String,Integer>> selectIndexMap,
                         TnRelationKey relKey,
                         Map<String,Map<String,TnPropertyMapping>> relPropCache,
                         TnRelationRowCache relRowCache,
                         TnRelationSelector relSelector)
                  throws SQLException

Create relation row from first level relation.

パラメータ:

rs - Result set. (NotNull)

rpt - The type of relation property. (NotNull)

selectColumnMap - The name map of select column. map:{flexibleName = columnDbName} (NotNull)

selectIndexMap - The map of select index. map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}} (NullAllowed: null means select index is disabled)

relKey - The relation key, which has key values, of the relation. (NotNull)

relPropCache - The map of relation property cache. map:{relationNoSuffix = map:{columnName = PropertyMapping}} (NotNull)

relRowCache - The cache of relation row. (NotNull)

relSelector - The selector of relation, which can determines e.g. is it not-selected relation?. (NotNull)

戻り値:

The created row of the relation. (NullAllowed: if null, no data about the relation)

例外:

SQLException - When it fails to handle the SQL.

createPropertyCache

Map<String,Map<String,TnPropertyMapping>> createPropertyCache(Map<String,String> selectColumnMap,
                                                              Map<String,Map<String,Integer>> selectIndexMap,
                                                              TnRelationSelector relSelector,
                                                              TnBeanMetaData baseBmd)
                                                       throws SQLException

Create relation property cache.

パラメータ:

selectColumnMap - The name map of select column. map:{flexibleName = columnDbName} (NotNull)

selectIndexMap - The map of select index. map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}} (NullAllowed: null means select index is disabled)

relSelector - The selector of relation, which can determines e.g. is it not-selected relation?. (NotNull)

baseBmd - Bean meta data of base object. (NotNull)

戻り値:

The map of relation property cache. map:{relationNoSuffix = map:{columnName = PropertyMapping}} (NotNull)

例外:

SQLException - When it fails to handle the SQL.

filterOptionalRelationRowIfNeeds

Object filterOptionalRelationRowIfNeeds(Object row,
                                        TnRelationPropertyType rpt,
                                        Object relationRow)

Filter the relation row as optional object if it needs.

パラメータ:

row - The base point row, which is previous relation row. (NotNull)

rpt - The property type for the relation. (NotNull)

relationRow - The row instance of relation entity. (NullAllowed)

戻り値:

The filtered instance of relation entity. (NullAllowed)