com.mybatisflex.core.table

类 TableInfo

java.lang.Object

com.mybatisflex.core.table.TableInfo

public class TableInfo
extends Object

字段概要

字段

限定符和类型	字段和说明
private String[]	allColumns
private static String	APPEND_CONDITIONS_FLAG
private Map<String,Class<?>>	associationType 对应 MapperXML 配置文件中 <resultMap> 标签下的 <association> 标签。
private boolean	camelToUnderline
private Map<Field,Class<?>>	collectionType 对应 MapperXML 配置文件中 <resultMap> 标签下的 <collection> 标签。
private List<ColumnInfo>	columnInfoList
private Map<String,ColumnInfo>	columnInfoMapping
private Map<String,QueryColumn>	columnQueryMapping
private String[]	columns
private String	comment
private String	dataSource
private String[]	defaultQueryColumns
private Class<?>	entityClass
private static Map<Class<?>,List<InsertListener>>	insertListenerCache
private String[]	insertPrimaryKeys
private String[]	largeColumns
private String	logicDeleteColumn
private Map<String,String>	onInsertColumns
private List<InsertListener>	onInsertListeners
private List<SetListener>	onSetListeners
private Map<String,String>	onUpdateColumns
private List<UpdateListener>	onUpdateListeners
private String[]	primaryColumns
private List<IdInfo>	primaryKeyList
private Map<String,String>	propertyColumnMapping
private org.apache.ibatis.reflection.Reflector	reflector
private org.apache.ibatis.reflection.ReflectorFactory	reflectorFactory
private String	schema
private static Map<Class<?>,List<SetListener>>	setListenerCache
private String	tableName
private String	tenantIdColumn
private static Map<Class<?>,List<UpdateListener>>	updateListenerCache
private String	versionColumn

构造器概要

构造器

构造器和说明
TableInfo()

方法概要

限定符和类型	方法和说明
void	addAssociationType(String fieldName, Class<?> clazz)
void	addCollectionType(Field field, Class<?> genericClass)
void	appendConditions(Object entity, QueryWrapper queryWrapper)
private Object	buildColumnSqlArg(org.apache.ibatis.reflection.MetaObject metaObject, String column)
Object	buildColumnSqlArg(Object entityObject, String column)
private void	buildDefaultResultMapping(org.apache.ibatis.session.Configuration configuration, List<org.apache.ibatis.mapping.ResultMapping> resultMappings, ColumnInfo columnInfo, List<org.apache.ibatis.mapping.ResultFlag> flags)
Object[]	buildInsertSqlArgs(Object entity, boolean ignoreNulls) 构建 insert 的 Sql 参数
Object[]	buildInsertSqlArgsWithPk(Object entity, boolean ignoreNulls)
Object[]	buildPkSqlArgs(Object entity) 构建主键的 sql 参数数据
QueryWrapper	buildQueryWrapper(Object entity, SqlOperators operators)
org.apache.ibatis.mapping.ResultMap	buildResultMap(org.apache.ibatis.session.Configuration configuration)
private Object	buildSqlArg(String column, Object value)
void	buildTenantCondition(QueryWrapper queryWrapper)
void	buildTenantCondition(StringBuilder sql, Object[] tenantIdArgs, IDialect dialect)
String	buildTenantCondition(String sql, Object[] tenantIdArgs, IDialect dialect)
Object[]	buildTenantIdArgs()
Object[]	buildUpdateSqlArgs(Object entity, boolean ignoreNulls, boolean includePrimary) 获取所有要修改的值，默认为全部除了主键以外的字段
private void	doAppendConditions(Object entity, QueryWrapper queryWrapper)
private void	doBuildColumnResultMapping(org.apache.ibatis.session.Configuration configuration, List<org.apache.ibatis.mapping.ResultMapping> resultMappings, List<String> existedColumns, ColumnInfo columnInfo, List<org.apache.ibatis.mapping.ResultFlag> flags, boolean isNested)
private org.apache.ibatis.mapping.ResultMap	doBuildResultMap(org.apache.ibatis.session.Configuration configuration, Set<String> resultMapIds, List<String> existedColumns, boolean isNested, String nestedPrefix)
String[]	getAllColumns()
Map<String,Class<?>>	getAssociationType()
Map<Field,Class<?>>	getCollectionType()
String	getColumnByProperty(String property)
List<ColumnInfo>	getColumnInfoList()
String[]	getColumns()
private void	getCombinedColumns(List<Class<?>> existedEntities, Class<?> entityClass, List<String> combinedColumns)
String	getComment()
String	getDataSource()
List<QueryColumn>	getDefaultQueryColumn()
String[]	getDefaultQueryColumns()
Class<?>	getEntityClass()
String[]	getInsertPrimaryKeys()
String	getKeyColumns()
String	getKeyProperties()
String[]	getLargeColumns()
String	getLogicDeleteColumn()
String	getLogicDeleteColumnOrSkip()
Map<String,String>	getOnInsertColumns()
List<InsertListener>	getOnInsertListeners()
List<SetListener>	getOnSetListeners()
Map<String,String>	getOnUpdateColumns()
List<UpdateListener>	getOnUpdateListeners()
String	getOptimisticLockColumnOrSkip()
Object	getPkValue(Object entity) 获取主键值
String[]	getPrimaryColumns()
List<IdInfo>	getPrimaryKeyList()
Map<String,String>	getPropertyColumnMapping()
Object	getPropertyValue(org.apache.ibatis.reflection.MetaObject metaObject, String property)
QueryColumn	getQueryColumnByProperty(String property)
org.apache.ibatis.reflection.Reflector	getReflector()
org.apache.ibatis.reflection.ReflectorFactory	getReflectorFactory()
private ResultSet	getResultSet(Object value)
String	getSchema()
String	getTableName()
String	getTableNameWithSchema()
String	getTenantIdColumn()
Object	getValue(Object entity, String property)
String	getVersionColumn()
String	getWrapSchemaAndTableName(IDialect dialect, OperateType operateType)
void	initLogicDeleteValueIfNecessary(Object entityObject) 初始化逻辑删除的默认值
void	initTenantIdIfNecessary(Object entityObject) 设置租户id
void	initVersionValueIfNecessary(Object entityObject) 初始化乐观锁版本号
void	invokeOnInsertListener(Object entity)
Object	invokeOnSetListener(Object entity, String property, Object value)
void	invokeOnUpdateListener(Object entity)
boolean	isCamelToUnderline()
<T> T	newInstanceByRow(Row row, int index) 通过 row 实例类转换为一个 entity
String[]	obtainInsertColumns(Object entity, boolean ignoreNulls) 插入（新增）数据时，获取所有要插入的字段
String[]	obtainInsertColumnsWithPk(Object entity, boolean ignoreNulls) 插入（新增）数据时，获取所有要插入的字段
Set<String>	obtainUpdateColumns(Object entity, boolean ignoreNulls, boolean includePrimary) 获取要修改的值
Map<String,RawValue>	obtainUpdateRawValueMap(Object entity)
void	setAllColumns(String[] allColumns)
void	setAssociationType(Map<String,Class<?>> associationType)
void	setCamelToUnderline(boolean camelToUnderline)
void	setCollectionType(Map<Field,Class<?>> collectionType)
(专用程序包) void	setColumnInfoList(List<ColumnInfo> columnInfoList)
void	setColumns(String[] columns)
void	setComment(String comment)
void	setDataSource(String dataSource)
void	setDefaultQueryColumns(String[] defaultQueryColumns)
void	setEntityClass(Class<?> entityClass)
void	setInsertPrimaryKeys(String[] insertPrimaryKeys)
private void	setInstancePropertyValue(Row row, Object instance, org.apache.ibatis.reflection.MetaObject metaObject, ColumnInfo columnInfo, String rowKey)
void	setLargeColumns(String[] largeColumns)
void	setLogicDeleteColumn(String logicDeleteColumn)
void	setOnInsertColumns(Map<String,String> onInsertColumns)
void	setOnInsertListeners(List<InsertListener> onInsertListeners)
void	setOnSetListeners(List<SetListener> onSetListeners)
void	setOnUpdateColumns(Map<String,String> onUpdateColumns)
void	setOnUpdateListeners(List<UpdateListener> onUpdateListeners)
void	setPrimaryColumns(String[] primaryColumns)
(专用程序包) void	setPrimaryKeyList(List<IdInfo> primaryKeyList)
void	setReflector(org.apache.ibatis.reflection.Reflector reflector)
void	setSchema(String schema)
void	setTableName(String tableName)
void	setTenantIdColumn(String tenantIdColumn)
void	setVersionColumn(String versionColumn)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

columnInfoMapping

private final Map<String,ColumnInfo> columnInfoMapping

propertyColumnMapping

private final Map<String,String> propertyColumnMapping

schema

private String schema

camelToUnderline

private boolean camelToUnderline

dataSource

private String dataSource

comment

private String comment

tableName

private String tableName

entityClass

private Class<?> entityClass

logicDeleteColumn

private String logicDeleteColumn

versionColumn

private String versionColumn

tenantIdColumn

private String tenantIdColumn

onInsertColumns

private Map<String,String> onInsertColumns

allColumns

private String[] allColumns

onUpdateColumns

private Map<String,String> onUpdateColumns

largeColumns

private String[] largeColumns

defaultQueryColumns

private String[] defaultQueryColumns

columns

private String[] columns

columnInfoList

private List<ColumnInfo> columnInfoList

primaryKeyList

private List<IdInfo> primaryKeyList

primaryColumns

private String[] primaryColumns

columnQueryMapping

private final Map<String,QueryColumn> columnQueryMapping

insertPrimaryKeys

private String[] insertPrimaryKeys

onInsertListeners

private List<InsertListener> onInsertListeners

onUpdateListeners

private List<UpdateListener> onUpdateListeners

onSetListeners

private List<SetListener> onSetListeners

associationType

private Map<String,Class<?>> associationType

对应 MapperXML 配置文件中 <resultMap> 标签下的 <association> 标签。

collectionType

private Map<Field,Class<?>> collectionType

对应 MapperXML 配置文件中 <resultMap> 标签下的 <collection> 标签。

reflectorFactory

private final org.apache.ibatis.reflection.ReflectorFactory reflectorFactory

reflector

private org.apache.ibatis.reflection.Reflector reflector

APPEND_CONDITIONS_FLAG

private static final String APPEND_CONDITIONS_FLAG

另请参阅:

常量字段值

insertListenerCache

private static final Map<Class<?>,List<InsertListener>> insertListenerCache

updateListenerCache

private static final Map<Class<?>,List<UpdateListener>> updateListenerCache

setListenerCache

private static final Map<Class<?>,List<SetListener>> setListenerCache

构造器详细资料

TableInfo

public TableInfo()

方法详细资料

getSchema

public String getSchema()

setSchema

public void setSchema(String schema)

getPropertyColumnMapping

public Map<String,String> getPropertyColumnMapping()

getTableName

public String getTableName()

getTableNameWithSchema

public String getTableNameWithSchema()

getWrapSchemaAndTableName

public String getWrapSchemaAndTableName(IDialect dialect,
                                        OperateType operateType)

setTableName

public void setTableName(String tableName)

getEntityClass

public Class<?> getEntityClass()

setEntityClass

public void setEntityClass(Class<?> entityClass)

isCamelToUnderline

public boolean isCamelToUnderline()

setCamelToUnderline

public void setCamelToUnderline(boolean camelToUnderline)

getDataSource

public String getDataSource()

setDataSource

public void setDataSource(String dataSource)

getComment

public String getComment()

setComment

public void setComment(String comment)

getLogicDeleteColumnOrSkip

public String getLogicDeleteColumnOrSkip()

getLogicDeleteColumn

public String getLogicDeleteColumn()

setLogicDeleteColumn

public void setLogicDeleteColumn(String logicDeleteColumn)

getOptimisticLockColumnOrSkip

public String getOptimisticLockColumnOrSkip()

getVersionColumn

public String getVersionColumn()

setVersionColumn

public void setVersionColumn(String versionColumn)

getTenantIdColumn

public String getTenantIdColumn()

setTenantIdColumn

public void setTenantIdColumn(String tenantIdColumn)

getOnInsertColumns

public Map<String,String> getOnInsertColumns()

setOnInsertColumns

public void setOnInsertColumns(Map<String,String> onInsertColumns)

getOnUpdateColumns

public Map<String,String> getOnUpdateColumns()

setOnUpdateColumns

public void setOnUpdateColumns(Map<String,String> onUpdateColumns)

getLargeColumns

public String[] getLargeColumns()

setLargeColumns

public void setLargeColumns(String[] largeColumns)

getDefaultQueryColumns

public String[] getDefaultQueryColumns()

setDefaultQueryColumns

public void setDefaultQueryColumns(String[] defaultQueryColumns)

getInsertPrimaryKeys

public String[] getInsertPrimaryKeys()

setInsertPrimaryKeys

public void setInsertPrimaryKeys(String[] insertPrimaryKeys)

getReflector

public org.apache.ibatis.reflection.Reflector getReflector()

getReflectorFactory

public org.apache.ibatis.reflection.ReflectorFactory getReflectorFactory()

setReflector

public void setReflector(org.apache.ibatis.reflection.Reflector reflector)

getAllColumns

public String[] getAllColumns()

setAllColumns

public void setAllColumns(String[] allColumns)

getColumns

public String[] getColumns()

setColumns

public void setColumns(String[] columns)

getPrimaryColumns

public String[] getPrimaryColumns()

setPrimaryColumns

public void setPrimaryColumns(String[] primaryColumns)

getOnInsertListeners

public List<InsertListener> getOnInsertListeners()

setOnInsertListeners

public void setOnInsertListeners(List<InsertListener> onInsertListeners)

getOnUpdateListeners

public List<UpdateListener> getOnUpdateListeners()

setOnUpdateListeners

public void setOnUpdateListeners(List<UpdateListener> onUpdateListeners)

getOnSetListeners

public List<SetListener> getOnSetListeners()

setOnSetListeners

public void setOnSetListeners(List<SetListener> onSetListeners)

getColumnInfoList

public List<ColumnInfo> getColumnInfoList()

getColumnByProperty

public String getColumnByProperty(String property)

getAssociationType

public Map<String,Class<?>> getAssociationType()

setAssociationType

public void setAssociationType(Map<String,Class<?>> associationType)

addAssociationType

public void addAssociationType(String fieldName,
                               Class<?> clazz)

getCollectionType

public Map<Field,Class<?>> getCollectionType()

setCollectionType

public void setCollectionType(Map<Field,Class<?>> collectionType)

addCollectionType

public void addCollectionType(Field field,
                              Class<?> genericClass)

setColumnInfoList

void setColumnInfoList(List<ColumnInfo> columnInfoList)

getPrimaryKeyList

public List<IdInfo> getPrimaryKeyList()

setPrimaryKeyList

void setPrimaryKeyList(List<IdInfo> primaryKeyList)

buildInsertSqlArgs

public Object[] buildInsertSqlArgs(Object entity,
                                   boolean ignoreNulls)

构建 insert 的 Sql 参数

参数:

entity - 从 entity 中获取

ignoreNulls - 是否忽略 null 值

返回:

数组

obtainInsertColumns

public String[] obtainInsertColumns(Object entity,
                                    boolean ignoreNulls)

插入（新增）数据时，获取所有要插入的字段

参数:

entity -

ignoreNulls -

返回:

字段列表

buildInsertSqlArgsWithPk

public Object[] buildInsertSqlArgsWithPk(Object entity,
                                         boolean ignoreNulls)

obtainInsertColumnsWithPk

public String[] obtainInsertColumnsWithPk(Object entity,
                                          boolean ignoreNulls)

插入（新增）数据时，获取所有要插入的字段

参数:

entity -

ignoreNulls -

返回:

字段列表

obtainUpdateRawValueMap

public Map<String,RawValue> obtainUpdateRawValueMap(Object entity)

obtainUpdateColumns

public Set<String> obtainUpdateColumns(Object entity,
                                       boolean ignoreNulls,
                                       boolean includePrimary)

获取要修改的值

参数:

entity -

ignoreNulls -

buildUpdateSqlArgs

public Object[] buildUpdateSqlArgs(Object entity,
                                   boolean ignoreNulls,
                                   boolean includePrimary)

获取所有要修改的值，默认为全部除了主键以外的字段

参数:

entity - 实体对象

返回:

数组

buildPkSqlArgs

public Object[] buildPkSqlArgs(Object entity)

构建主键的 sql 参数数据

参数:

entity -

getValue

public Object getValue(Object entity,
                       String property)

getPkValue

public Object getPkValue(Object entity)

获取主键值

参数:

entity -

返回:

主键值，有多个主键时返回数组

buildTenantIdArgs

public Object[] buildTenantIdArgs()

buildTenantCondition

public String buildTenantCondition(String sql,
                                   Object[] tenantIdArgs,
                                   IDialect dialect)

buildTenantCondition

public void buildTenantCondition(StringBuilder sql,
                                 Object[] tenantIdArgs,
                                 IDialect dialect)

buildTenantCondition

public void buildTenantCondition(QueryWrapper queryWrapper)

appendConditions

public void appendConditions(Object entity,
                             QueryWrapper queryWrapper)

doAppendConditions

private void doAppendConditions(Object entity,
                                QueryWrapper queryWrapper)

buildQueryWrapper

public QueryWrapper buildQueryWrapper(Object entity,
                                      SqlOperators operators)

buildSqlArg

private Object buildSqlArg(String column,
                           Object value)

getKeyProperties

public String getKeyProperties()

getKeyColumns

public String getKeyColumns()

getDefaultQueryColumn

public List<QueryColumn> getDefaultQueryColumn()

getCombinedColumns

private void getCombinedColumns(List<Class<?>> existedEntities,
                                Class<?> entityClass,
                                List<String> combinedColumns)

buildResultMap

public org.apache.ibatis.mapping.ResultMap buildResultMap(org.apache.ibatis.session.Configuration configuration)

doBuildResultMap

private org.apache.ibatis.mapping.ResultMap doBuildResultMap(org.apache.ibatis.session.Configuration configuration,
                                                             Set<String> resultMapIds,
                                                             List<String> existedColumns,
                                                             boolean isNested,
                                                             String nestedPrefix)

doBuildColumnResultMapping

private void doBuildColumnResultMapping(org.apache.ibatis.session.Configuration configuration,
                                        List<org.apache.ibatis.mapping.ResultMapping> resultMappings,
                                        List<String> existedColumns,
                                        ColumnInfo columnInfo,
                                        List<org.apache.ibatis.mapping.ResultFlag> flags,
                                        boolean isNested)

buildDefaultResultMapping

private void buildDefaultResultMapping(org.apache.ibatis.session.Configuration configuration,
                                       List<org.apache.ibatis.mapping.ResultMapping> resultMappings,
                                       ColumnInfo columnInfo,
                                       List<org.apache.ibatis.mapping.ResultFlag> flags)

buildColumnSqlArg

private Object buildColumnSqlArg(org.apache.ibatis.reflection.MetaObject metaObject,
                                 String column)

buildColumnSqlArg

public Object buildColumnSqlArg(Object entityObject,
                                String column)

getPropertyValue

public Object getPropertyValue(org.apache.ibatis.reflection.MetaObject metaObject,
                               String property)

newInstanceByRow

public <T> T newInstanceByRow(Row row,
                              int index)

通过 row 实例类转换为一个 entity

返回:

entity

setInstancePropertyValue

private void setInstancePropertyValue(Row row,
                                      Object instance,
                                      org.apache.ibatis.reflection.MetaObject metaObject,
                                      ColumnInfo columnInfo,
                                      String rowKey)

getResultSet

private ResultSet getResultSet(Object value)

initVersionValueIfNecessary

public void initVersionValueIfNecessary(Object entityObject)

初始化乐观锁版本号

参数:

entityObject -

initTenantIdIfNecessary

public void initTenantIdIfNecessary(Object entityObject)

设置租户id

参数:

entityObject -

initLogicDeleteValueIfNecessary

public void initLogicDeleteValueIfNecessary(Object entityObject)

初始化逻辑删除的默认值

参数:

entityObject -

invokeOnInsertListener

public void invokeOnInsertListener(Object entity)

invokeOnUpdateListener

public void invokeOnUpdateListener(Object entity)

invokeOnSetListener

public Object invokeOnSetListener(Object entity,
                                  String property,
                                  Object value)

getQueryColumnByProperty

public QueryColumn getQueryColumnByProperty(String property)