org.dbflute.s2dao.rshandler.TnAbstractBeanResultSetHandler Maven / Gradle / Ivy
/*
* Copyright 2014-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.dbflute.s2dao.rshandler;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Map;
import org.dbflute.bhv.core.context.ResourceContext;
import org.dbflute.cbean.ConditionBean;
import org.dbflute.s2dao.extension.TnRelationRowCreatorExtension;
import org.dbflute.s2dao.extension.TnRowCreatorExtension;
import org.dbflute.s2dao.jdbc.TnResultSetHandler;
import org.dbflute.s2dao.metadata.TnBeanMetaData;
import org.dbflute.s2dao.metadata.TnPropertyMapping;
import org.dbflute.s2dao.metadata.TnRelationPropertyType;
import org.dbflute.s2dao.rowcreator.TnRelationKey;
import org.dbflute.s2dao.rowcreator.TnRelationRowCache;
import org.dbflute.s2dao.rowcreator.TnRelationRowCreator;
import org.dbflute.s2dao.rowcreator.TnRelationSelector;
import org.dbflute.s2dao.rowcreator.TnRowCreator;
/**
* @author modified by jflute (originated in S2Dao)
*/
public abstract class TnAbstractBeanResultSetHandler implements TnResultSetHandler {
// ===================================================================================
// Attribute
// =========
private final TnBeanMetaData _beanMetaData;
protected final TnRowCreator _rowCreator;
protected final TnRelationRowCreator _relationRowCreator;
// ===================================================================================
// Constructor
// ===========
/**
* @param beanMetaData Bean meta data. (NotNull)
* @param rowCreator Row creator. (NotNull)
* @param relationRowCreator Relation row creator. (NotNul)
*/
public TnAbstractBeanResultSetHandler(TnBeanMetaData beanMetaData, TnRowCreator rowCreator, TnRelationRowCreator relationRowCreator) {
_beanMetaData = beanMetaData;
_rowCreator = rowCreator;
_relationRowCreator = relationRowCreator;
}
// ===================================================================================
// Property Cache
// ==============
/**
* Create property cache for base point row.
* @param selectColumnMap The map of select column name. map:{flexibleName = columnAliasName} (NotNull)
* @param selectIndexMap The map of select index. map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}} (NullAllowed)
* @return The map of row property cache. map:{columnName, PropertyMapping} (NotNull)
* @throws SQLException When it fails to handle the SQL.
*/
protected Map createPropertyCache(Map selectColumnMap,
Map> selectIndexMap) throws SQLException {
// - - - - - - - - -
// Override for Bean
// - - - - - - - - -
return _rowCreator.createPropertyCache(selectColumnMap, selectIndexMap, _beanMetaData);
}
/**
* Create relation property cache.
* @param selectColumnMap The map of select column name. map:{flexibleName = columnAliasName} (NotNull)
* @param selectIndexMap The map of select index. map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}} (NullAllowed)
* @param relSelector The selector of relation, which can determines e.g. is it not-selected relation?. (NotNull)
* @return The map of relation property cache. map:{relationNoSuffix = map:{columnName = PropertyMapping}} (NotNull)
* @throws SQLException When it fails to handle the SQL.
*/
protected Map> createRelationPropertyCache(Map selectColumnMap,
Map> selectIndexMap, TnRelationSelector relSelector) throws SQLException {
return _relationRowCreator.createPropertyCache(selectColumnMap, selectIndexMap, relSelector, _beanMetaData);
}
// ===================================================================================
// Create Row
// ==========
/**
* Create base point row.
* @param rs Result set. (NotNull)
* @param selectIndexMap The map of select index. map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}} (NullAllowed)
* @param propertyCache The map of property cache. map:{columnName, PropertyMapping} (NotNull)
* @param cb The condition-bean for the select. (NullAllowed: when not condition-bean select)
* @return The created row. (NotNull)
* @throws SQLException When it fails to handle the SQL.
*/
protected Object createRow(ResultSet rs, Map> selectIndexMap, Map propertyCache,
ConditionBean cb) throws SQLException {
// - - - - - - - - -
// Override for Bean
// - - - - - - - - -
final Class beanClass = _beanMetaData.getBeanClass();
return _rowCreator.createRow(rs, selectIndexMap, propertyCache, beanClass, cb);
}
/**
* Create relation row.
* @param rs Result set. (NotNull)
* @param rpt The type of relation property. (NotNull)
* @param selectColumnMap The name map of select column. map:{flexibleName = columnDbName} (NotNull)
* @param selectIndexMap The map of select index. map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}} (NullAllowed)
* @param relKey The relation key, which has key values, of the relation. (NotNull)
* @param relPropCache The map of relation property cache. map:{relationNoSuffix = map:{columnName = PropertyMapping}} (NotNull)
* @param relRowCache The cache of relation row. (NotNull)
* @param relSelector The selector of relation, which can determines e.g. is it not-selected relation?. (NotNull)
* @return Created relation row. (NullAllowed)
* @throws SQLException When it fails to handle the SQL.
*/
protected Object createRelationRow(ResultSet rs, TnRelationPropertyType rpt, Map selectColumnMap,
Map> selectIndexMap, TnRelationKey relKey,
Map> relPropCache, TnRelationRowCache relRowCache, TnRelationSelector relSelector)
throws SQLException {
return _relationRowCreator.createRelationRow(rs, rpt // basic resource
, selectColumnMap, selectIndexMap // select resource
, relKey, relPropCache, relRowCache, relSelector); // relation resource
}
/**
* Adjust created row for base-point table.
* @param row The row of result list. (NotNull)
* @param checkNonSp Does is use the check of access to non-specified column?
* @param colNullObj Does is use the handling of column null object?
* @param basePointBmd The bean meta data of the row for base-point table. (NotNull)
* @param cb The condition-bean for the select. (NullAllowed: when not condition-bean select)
*/
protected void adjustCreatedRow(Object row, boolean checkNonSp, boolean colNullObj, TnBeanMetaData basePointBmd, ConditionBean cb) {
TnRowCreatorExtension.adjustCreatedRow(row, checkNonSp, colNullObj, basePointBmd, cb);
}
/**
* Adjust created row for relation tables.
* @param relationRow The relation row of tables related to the base-point table. (NotNull)
* @param relationNoSuffix The suffix of relation no, e.g. _0, _1_3. (NotNull)
* @param relSelector The selector of relation, which has various determination. (NotNull)
* @param rpt The property type of the relation. (NotNull)
*/
protected void adjustCreatedRelationRow(Object relationRow, String relationNoSuffix, TnRelationSelector relSelector,
TnRelationPropertyType rpt) {
TnRelationRowCreatorExtension.adjustCreatedRelationRow(relationRow, relationNoSuffix, relSelector, rpt);
}
// ===================================================================================
// Select Column
// =============
protected Map createSelectColumnMap(ResultSet rs) throws SQLException {
return ResourceContext.createSelectColumnMap(rs);
}
// ===================================================================================
// Accessor
// ========
public TnBeanMetaData getBeanMetaData() {
return _beanMetaData;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy