EntityTable (MyBatis Provider 2.2.3 API)

java.lang.Object
- io.mybatis.provider.EntityProps<EntityTable>
- - io.mybatis.provider.EntityTable

public class EntityTable
extends EntityProps<EntityTable>

实体表接口，记录实体和表的关系

Author:: liuzh

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoResultMap` 自动根据字段生成 <resultMap>
`protected String`	`catalog` catalog 名称，配置后，会在表名前面加上 catalog 名称，规则为：catalog.schema.tableName，支持全局 mybatis.provider.catalog 配置
`protected List<EntityColumn>`	`columns` 字段信息
`static Pattern`	`DELIMITER`
`protected Class<?>`	`entityClass` 实体类
`protected String[]`	`excludeFields` 排除指定字段名的字段
`protected Class<?>[]`	`excludeFieldTypes` 排除指定类型的字段
`protected Class<?>[]`	`excludeSuperClasses` 排除指定父类的所有字段
`protected Set<org.apache.ibatis.session.Configuration>`	`initConfiguration` 已经初始化的配置
`protected boolean`	`ready` 初始化完成，可以使用
`static String`	`RESULT_MAP_NAME`
`protected String`	`resultMap` 使用指定的 <resultMap>
`protected List<org.apache.ibatis.mapping.ResultMap>`	`resultMaps` 已初始化自动ResultMap
`protected String`	`schema` schema 名称，配置后，会在表名前面加上 schema 名称，规则为：catalog.schema.tableName，支持全局 mybatis.provider.schema 配置
`protected String`	`style` 实体类和字段转表名和字段名方式
`protected String`	`table` 原始表名，在拼 SQL 中，使用 `tableName()` 方法，这个方法可能会返回代理方法加工后的值

Fields inherited from class io.mybatis.provider.EntityProps
props

Constructor Summary

Constructors
Modifier Constructor and Description

protected EntityTable(Class<?> entityClass)

Constructors
Modifier	Constructor and Description
`protected`	`EntityTable(Class<?> entityClass)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(EntityColumn column)` 添加列
`String`	`baseColumnAsPropertyList()` 所有查询列，形如 column1 AS property1, column2 AS property2, ...
`String`	`baseColumnList()` 所有查询列，形如 column1, column2, ...
`protected boolean`	`canUseResultMaps(org.apache.ibatis.builder.annotation.ProviderContext providerContext, String cacheKey)` 是否使用 resultMaps
`List<String>`	`columnNames()` 返回所有列名
`List<EntityColumn>`	`columns()` 返回所有列
`boolean`	`equals(Object o)`
`List<String>`	`fieldNames()` 返回所有属性名
`List<EntityField>`	`fields()` 返回所有字段
`protected String`	`generateResultMapId(org.apache.ibatis.builder.annotation.ProviderContext providerContext, String resultMapId)`
`protected org.apache.ibatis.mapping.ResultMap`	`genResultMap(org.apache.ibatis.session.Configuration configuration, org.apache.ibatis.builder.annotation.ProviderContext providerContext, String cacheKey)`
`org.apache.ibatis.type.TypeHandler`	`getTypeHandlerInstance(Class<?> javaTypeClass, Class<?> typeHandlerClass)` 实例化TypeHandler
`Optional<String>`	`groupByColumn()` 带上 GROUP BY 前缀的方法，默认空，默认查询列来自 `groupByColumnList()`
`Optional<String>`	`groupByColumnList()` 所有 order by 字段，默认空，字段来源 `groupByColumns()` 参考值: column1, column2, ...
`Optional<List<EntityColumn>>`	`groupByColumns()` 所有 GROUP BY 到的字段，默认为空，当使用 GROUP BY 列时，必须使用当前方法返回的列
`protected boolean`	`hasBeenReplaced(org.apache.ibatis.session.Configuration configuration, String cacheKey)` 是否已经替换 resultMap
`int`	`hashCode()`
`Optional<String>`	`havingColumn()` 带上 HAVING 前缀的方法，默认空，默认查询列来自 `havingColumnList()`
`Optional<String>`	`havingColumnList()` 所有 having 字段，默认空，字段来源 `havingColumns()` 参考值: column1, column2, ...
`Optional<List<EntityColumn>>`	`havingColumns()` 所有 HAVING 到的字段，默认为空，当使用 HAVING 列时，必须使用当前方法返回的列
`List<EntityColumn>`	`idColumns()` 返回主键列，不会为空，当根据主键作为条件时，必须使用当前方法返回的列，没有设置主键时，当前方法返回所有列
`protected void`	`initResultMap(org.apache.ibatis.session.Configuration configuration, org.apache.ibatis.builder.annotation.ProviderContext providerContext, String cacheKey)`
`void`	`initRuntimeContext(org.apache.ibatis.session.Configuration configuration, org.apache.ibatis.builder.annotation.ProviderContext providerContext, String cacheKey)` 设置运行时信息，不同方法分别执行一次，需要保证幂等
`String`	`insertColumnList()` 所有 insert 列，形如 column1, column2, ...，字段来源 `insertColumns()`
`List<EntityColumn>`	`insertColumns()` 所有 insert 用到的字段，当插入列时，必须使用当前方法返回的列
`boolean`	`isExcludeField(EntityField field)` 是否需要排除指定的字段
`boolean`	`isExcludeSuperClass(Class<?> superClass)` 是否需要排除父类
`List<EntityColumn>`	`normalColumns()` 返回普通列，排除主键字段，当根据非主键作为条件时，必须使用当前方法返回的列
`static EntityTable`	`of(Class<?> entityClass)`
`Optional<String>`	`orderByColumn()` 带上 ORDER BY 前缀的方法，默认空，默认查询列来自 `orderByColumnList()`
`Optional<String>`	`orderByColumnList()` 所有 order by 字段，默认空，字段来源 `orderByColumns()` 参考值: column1, column2, ...
`Optional<List<EntityColumn>>`	`orderByColumns()` 所有排序用到的字段
`List<EntityColumn>`	`selectColumns()` 返回查询列，当获取查询列时，必须使用当前方法返回的列
`String`	`tableName()` 获取 SQL 语句中使用的表名
`String`	`toString()`
`List<EntityColumn>`	`updateColumns()` 所有 update 用到的字段，当更新列时，必须使用当前方法返回的列
`boolean`	`useResultMaps()` 当前实体类是否使用 resultMap
`List<EntityColumn>`	`whereColumns()` 返回查询列，默认所有列，当使用查询条件列时，必须使用当前方法返回的列

Methods inherited from class io.mybatis.provider.EntityProps
getProp, getProp, getPropBoolean, getPropBoolean, getPropInt, getPropInt, removeProp, setProp, setProp, setProps

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DELIMITER
```
public static final Pattern DELIMITER
```
  - RESULT_MAP_NAME
```
public static final String RESULT_MAP_NAME
```
    See Also:
    
    Constant Field Values
  - table
```
protected String table
```
    原始表名，在拼 SQL 中，使用 tableName() 方法，这个方法可能会返回代理方法加工后的值
  - catalog
```
protected String catalog
```
    catalog 名称，配置后，会在表名前面加上 catalog 名称，规则为：catalog.schema.tableName，支持全局 mybatis.provider.catalog 配置
  - schema
```
protected String schema
```
    schema 名称，配置后，会在表名前面加上 schema 名称，规则为：catalog.schema.tableName，支持全局 mybatis.provider.schema 配置
  - style
```
protected String style
```
    实体类和字段转表名和字段名方式
  - entityClass
```
protected Class<?> entityClass
```
    实体类
  - columns
```
protected List<EntityColumn> columns
```
    字段信息
  - ready
```
protected boolean ready
```
    初始化完成，可以使用
  - resultMap
```
protected String resultMap
```
    使用指定的 <resultMap>
  - autoResultMap
```
protected boolean autoResultMap
```
    自动根据字段生成 <resultMap>
  - resultMaps
```
protected List<org.apache.ibatis.mapping.ResultMap> resultMaps
```
    已初始化自动ResultMap
  - excludeSuperClasses
```
protected Class<?>[] excludeSuperClasses
```
    排除指定父类的所有字段
  - excludeFieldTypes
```
protected Class<?>[] excludeFieldTypes
```
    排除指定类型的字段
  - excludeFields
```
protected String[] excludeFields
```
    排除指定字段名的字段
  - initConfiguration
```
protected Set<org.apache.ibatis.session.Configuration> initConfiguration
```
    已经初始化的配置
- Constructor Detail
  - EntityTable
```
protected EntityTable(Class<?> entityClass)
```
- Method Detail
  - of
```
public static EntityTable of(Class<?> entityClass)
```
  - tableName
```
public String tableName()
```
    获取 SQL 语句中使用的表名
  - columns
```
public List<EntityColumn> columns()
```
    返回所有列
    
    Returns:
    
    所有列信息
  - fields
```
public List<EntityField> fields()
```
    返回所有字段
    
    Returns:
    
    所有字段
  - columnNames
```
public List<String> columnNames()
```
    返回所有列名
    
    Returns:
    
    所有列名
  - fieldNames
```
public List<String> fieldNames()
```
    返回所有属性名
    
    Returns:
    
    所有属性名
  - addColumn
```
public void addColumn(EntityColumn column)
```
    添加列
  - canUseResultMaps
```
protected boolean canUseResultMaps(org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                                   String cacheKey)
```
    是否使用 resultMaps
    
    Parameters:
    
    providerContext - 当前方法信息
    
    cacheKey - 缓存 key，每个方法唯一，默认和 msId 一样
    
    Returns:
    
    true 是，false 否
  - useResultMaps
```
public boolean useResultMaps()
```
    当前实体类是否使用 resultMap
    
    Returns:
  - hasBeenReplaced
```
protected boolean hasBeenReplaced(org.apache.ibatis.session.Configuration configuration,
                                  String cacheKey)
```
    是否已经替换 resultMap
    
    Parameters:
    
    configuration - MyBatis 配置类，慎重操作
    
    cacheKey - 缓存 key，每个方法唯一，默认和 msId 一样
    
    Returns:
  - initRuntimeContext
```
public void initRuntimeContext(org.apache.ibatis.session.Configuration configuration,
                               org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                               String cacheKey)
```
    设置运行时信息，不同方法分别执行一次，需要保证幂等
    
    Parameters:
    
    configuration - MyBatis 配置类，慎重操作，多数据源或多个配置时，需要区分 Configuration 执行
    
    providerContext - 当前方法信息
    
    cacheKey - 缓存 key，每个方法唯一，默认和 msId 一样
  - initResultMap
```
protected void initResultMap(org.apache.ibatis.session.Configuration configuration,
                             org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                             String cacheKey)
```
  - generateResultMapId
```
protected String generateResultMapId(org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                                     String resultMapId)
```
  - genResultMap
```
protected org.apache.ibatis.mapping.ResultMap genResultMap(org.apache.ibatis.session.Configuration configuration,
                                                           org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                                                           String cacheKey)
```
  - getTypeHandlerInstance
```
public org.apache.ibatis.type.TypeHandler getTypeHandlerInstance(Class<?> javaTypeClass,
                                                                 Class<?> typeHandlerClass)
```
    实例化TypeHandler
  - idColumns
```
public List<EntityColumn> idColumns()
```
    返回主键列，不会为空，当根据主键作为条件时，必须使用当前方法返回的列，没有设置主键时，当前方法返回所有列
  - normalColumns
```
public List<EntityColumn> normalColumns()
```
    返回普通列，排除主键字段，当根据非主键作为条件时，必须使用当前方法返回的列
  - selectColumns
```
public List<EntityColumn> selectColumns()
```
    返回查询列，当获取查询列时，必须使用当前方法返回的列
  - whereColumns
```
public List<EntityColumn> whereColumns()
```
    返回查询列，默认所有列，当使用查询条件列时，必须使用当前方法返回的列
  - insertColumns
```
public List<EntityColumn> insertColumns()
```
    所有 insert 用到的字段，当插入列时，必须使用当前方法返回的列
  - updateColumns
```
public List<EntityColumn> updateColumns()
```
    所有 update 用到的字段，当更新列时，必须使用当前方法返回的列
  - groupByColumns
```
public Optional<List<EntityColumn>> groupByColumns()
```
    所有 GROUP BY 到的字段，默认为空，当使用 GROUP BY 列时，必须使用当前方法返回的列
  - havingColumns
```
public Optional<List<EntityColumn>> havingColumns()
```
    所有 HAVING 到的字段，默认为空，当使用 HAVING 列时，必须使用当前方法返回的列
  - orderByColumns
```
public Optional<List<EntityColumn>> orderByColumns()
```
    所有排序用到的字段
  - baseColumnList
```
public String baseColumnList()
```
    所有查询列，形如 column1, column2, ...
  - baseColumnAsPropertyList
```
public String baseColumnAsPropertyList()
```
    所有查询列，形如 column1 AS property1, column2 AS property2, ...
  - insertColumnList
```
public String insertColumnList()
```
    所有 insert 列，形如 column1, column2, ...，字段来源 insertColumns()
  - groupByColumnList
```
public Optional<String> groupByColumnList()
```
    所有 order by 字段，默认空，字段来源 groupByColumns() 参考值: column1, column2, ...
    默认重写 groupByColumns() 方法即可，当前方法不需要重写
  - groupByColumn
```
public Optional<String> groupByColumn()
```
    带上 GROUP BY 前缀的方法，默认空，默认查询列来自 groupByColumnList()
    默认重写 groupByColumns() 方法即可，当前方法不需要重写
  - havingColumnList
```
public Optional<String> havingColumnList()
```
    所有 having 字段，默认空，字段来源 havingColumns() 参考值: column1, column2, ...
  - havingColumn
```
public Optional<String> havingColumn()
```
    带上 HAVING 前缀的方法，默认空，默认查询列来自 havingColumnList()
  - orderByColumnList
```
public Optional<String> orderByColumnList()
```
    所有 order by 字段，默认空，字段来源 orderByColumns() 参考值: column1, column2, ...
    默认重写 orderByColumns() 方法即可，当前方法不需要重写
  - orderByColumn
```
public Optional<String> orderByColumn()
```
    带上 ORDER BY 前缀的方法，默认空，默认查询列来自 orderByColumnList()
    默认重写 orderByColumns() 方法即可，当前方法不需要重写
  - isExcludeSuperClass
```
public boolean isExcludeSuperClass(Class<?> superClass)
```
    是否需要排除父类
    
    Parameters:
    
    superClass - 父类
    
    Returns:
    
    true - 需要排除，false - 不需要排除
  - isExcludeField
```
public boolean isExcludeField(EntityField field)
```
    是否需要排除指定的字段
    
    Parameters:
    
    field - 字段
    
    Returns:
    
    true - 需要排除，false - 不需要排除
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EntityTable

Field Summary

Fields inherited from class io.mybatis.provider.EntityProps

Constructor Summary

Method Summary

Methods inherited from class io.mybatis.provider.EntityProps

Methods inherited from class java.lang.Object

Field Detail

DELIMITER

RESULT_MAP_NAME

table

catalog

schema

style

entityClass

columns

ready

resultMap

autoResultMap

resultMaps

excludeSuperClasses

excludeFieldTypes

excludeFields

initConfiguration

Constructor Detail

EntityTable

Method Detail

of

tableName

columns

fields

columnNames

fieldNames

addColumn

canUseResultMaps

useResultMaps

hasBeenReplaced

initRuntimeContext

initResultMap

generateResultMapId

genResultMap

getTypeHandlerInstance

idColumns

normalColumns

selectColumns

whereColumns

insertColumns

updateColumns

groupByColumns

havingColumns

orderByColumns

baseColumnList

baseColumnAsPropertyList

insertColumnList

groupByColumnList

groupByColumn

havingColumnList

havingColumn

orderByColumnList

orderByColumn

isExcludeSuperClass

isExcludeField

equals

hashCode

toString