Entity (Nutz 1.r.63 API)

All Known Implementing Classes:

NutEntity
```
public interface Entity<T>
```
描述了一个实体

Author:

zozoh(zozohtnt@gmail.com)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addAfterInsertMacro(Pojo pojo)` 增加一个插入后字段宏
`boolean`	`addBeforeInsertMacro(Pojo pojo)` 增加一个插入前字段宏
`T`	`born(ResultSet rs)`
`List<Pojo>`	`cloneAfterInsertMacroes()` 获取实体所有自动执行的字段宏列表
`List<Pojo>`	`cloneBeforeInsertMacroes()` 获取实体所有自动执行的字段宏列表
`MappingField`	`getColumn(String name)` 根据实体的数据库字段名获取一个实体字段对象
`String`	`getColumnComent(String columnName)` 根据字段名获得注释
`List<MappingField>`	`getCompositePKFields()` 如果实体采用了复合主键，调用这个函数能返回所有的复合主键，顺序就是复合主键的顺序
`MappingField`	`getField(String name)` 根据实体的 Java 字段名获取一个实体字段对象
`MappingField`	`getIdField()`
`EntityIndex`	`getIndex(String name)` 按名称获取一个实体的索引
`List<EntityIndex>`	`getIndexes()`
`List<LinkField>`	`getLinkFields(String regex)` 获取实体所有匹配上正则表达是的关联字段，如果正则表达是为 null，则表示获取全部关联字段
`List<MappingField>`	`getMappingFields()`
`Object`	`getMeta(String key)` 获取一个实体补充描述
`Map<String,Object>`	`getMetas()`
`Mirror<T>`	`getMirror()`
`MappingField`	`getNameField()`
`T`	`getObject(Record rec)` 从一个记录中生成一个实体实例
`T`	`getObject(Record rec, String prefix)`
`T`	`getObject(ResultSet rs, FieldMatcher matcher)` 从结果集中生成一个实体实例
`T`	`getObject(ResultSet rs, FieldMatcher matcher, String prefix)`
`List<MappingField>`	`getPks()` 根据，"数字主键 > 字符主键 > 复合主键" 的优先顺序，返回主键列表
`PkType`	`getPkType()`
`String`	`getTableComment()`
`String`	`getTableName()` 获取实体的表名
`Class<T>`	`getType()`
`MappingField`	`getVersionField()`
`String`	`getViewName()` 获取实体视图名
`boolean`	`hasColumnComment()`
`boolean`	`hasMeta(String key)` 实体是否包含某一种 meta
`boolean`	`hasTableComment()`
`boolean`	`isComplete()`
`List<LinkField>`	`visitMany(Object obj, String regex, LinkVisitor visitor)` 访问所有一对多映射。即 '@Many' 声明的字段
`List<LinkField>`	`visitManyMany(Object obj, String regex, LinkVisitor visitor)` 访问所有多对多映射。即 '@ManyMany' 声明的字段
`List<LinkField>`	`visitOne(Object obj, String regex, LinkVisitor visitor)` 访问所有一对一映射。即 '@One' 声明的字段
`Context`	`wrapAsContext(Object obj)` 将一个实体对象的实例包裹成 Context 接口

- Method Detail
  - getType
```
Class<T> getType()
```
    Returns:
    
    实体的 Java 类型
  - getMirror
```
Mirror<T> getMirror()
```
    Returns:
    
    实体的 Java 类型
  - getIndexes
```
List<EntityIndex> getIndexes()
```
    Returns:
    
    实体索引列表
  - getTableName
```
String getTableName()
```
    获取实体的表名
    
    Returns:
    
    实体表名
  - getViewName
```
String getViewName()
```
    获取实体视图名
    
    Returns:
    
    实体视图名
  - getIndex
```
EntityIndex getIndex(String name)
```
    按名称获取一个实体的索引
    
    Parameters:
    
    name - 索引名称
    
    Returns:
    
    实体索引
  - getObject
```
T getObject(ResultSet rs,
            FieldMatcher matcher)
```
    从结果集中生成一个实体实例
    
    Parameters:
    
    rs - 结果集
    
    matcher - 字段匹配器。如果为null，则获取实体的全部字段
    
    Returns:
    
    Java 对象
  - getObject
```
T getObject(ResultSet rs,
            FieldMatcher matcher,
            String prefix)
```
  - getObject
```
T getObject(Record rec)
```
    从一个记录中生成一个实体实例
    
    Parameters:
    
    rec - 结果集
    
    Returns:
    
    Java 对象
  - getObject
```
T getObject(Record rec,
            String prefix)
```
  - getField
```
MappingField getField(String name)
```
    根据实体的 Java 字段名获取一个实体字段对象
    
    Parameters:
    
    name - 实体字段的 Java 对象名
    
    Returns:
    
    实体字段
  - addBeforeInsertMacro
```
boolean addBeforeInsertMacro(Pojo pojo)
```
    增加一个插入前字段宏
    
    Parameters:
    
    pojo - Pojo 语句
    
    Returns:
    
    是否增加成功
  - addAfterInsertMacro
```
boolean addAfterInsertMacro(Pojo pojo)
```
    增加一个插入后字段宏
    
    Parameters:
    
    pojo - Pojo 语句
    
    Returns:
    
    是否增加成功
  - cloneBeforeInsertMacroes
```
List<Pojo> cloneBeforeInsertMacroes()
```
    获取实体所有自动执行的字段宏列表
    这些自动执行宏，在实体被插入到数据库前调用
    比如程序员可以为某个字段定义值的自动生成规则
    
    Returns:
    
    预执行宏列表
  - cloneAfterInsertMacroes
```
List<Pojo> cloneAfterInsertMacroes()
```
    获取实体所有自动执行的字段宏列表
    这些自动执行宏，在实体被插入到数据库后调用
    比如程序员可以为数据库自动生成的字段获取生成后的值
    
    Returns:
    
    后执行字段宏列表
  - getColumn
```
MappingField getColumn(String name)
```
    根据实体的数据库字段名获取一个实体字段对象
    
    Parameters:
    
    name - 实体字段数据库字段名
    
    Returns:
    
    实体字段
  - getMappingFields
```
List<MappingField> getMappingFields()
```
    Returns:
    
    实体所有的映射字段
  - getLinkFields
```
List<LinkField> getLinkFields(String regex)
```
    获取实体所有匹配上正则表达是的关联字段，如果正则表达是为 null，则表示获取全部关联字段
    
    Parameters:
    
    regex - 正则表达式
    
    Returns:
    
    实体所有匹配上正则表达是的关联字段
  - visitOne
```
List<LinkField> visitOne(Object obj,
                         String regex,
                         LinkVisitor visitor)
```
    访问所有一对一映射。即 '@One' 声明的字段
    
    Parameters:
    
    obj - 映射的宿主对象
    
    visitor - 处理器
    
    regex - 正则表达式匹配 Java 字段名。null 表示匹配所有一对一映射字段
    
    Returns:
    
    匹配上的映射字段
  - visitMany
```
List<LinkField> visitMany(Object obj,
                          String regex,
                          LinkVisitor visitor)
```
    访问所有一对多映射。即 '@Many' 声明的字段
    
    Parameters:
    
    obj - 映射的宿主对象
    
    visitor - 处理器
    
    regex - 正则表达式匹配 Java 字段名。null 表示匹配所有一对多映射字段
    
    Returns:
    
    匹配上的映射字段
  - visitManyMany
```
List<LinkField> visitManyMany(Object obj,
                              String regex,
                              LinkVisitor visitor)
```
    访问所有多对多映射。即 '@ManyMany' 声明的字段
    
    Parameters:
    
    obj - 映射的宿主对象
    
    visitor - 处理器
    
    regex - 正则表达式匹配 Java 字段名。null 表示匹配所有多对多映射字段
    
    Returns:
    
    匹配上的映射字段
  - getCompositePKFields
```
List<MappingField> getCompositePKFields()
```
    如果实体采用了复合主键，调用这个函数能返回所有的复合主键，顺序就是复合主键的顺序
    如果没有复合主键，那么将返回 null
    
    Returns:
    
    实体所复合主键字段
  - getNameField
```
MappingField getNameField()
```
    Returns:
    
    实体唯一字符类型主键
  - getIdField
```
MappingField getIdField()
```
    Returns:
    
    实体唯一数字类型主键
  - getPks
```
List<MappingField> getPks()
```
    根据，"数字主键 > 字符主键 > 复合主键" 的优先顺序，返回主键列表
    
    Returns:
    
    实体的主键列表
  - getPkType
```
PkType getPkType()
```
    Returns:
    
    当前实体首选主键类型
  - wrapAsContext
```
Context wrapAsContext(Object obj)
```
    将一个实体对象的实例包裹成 Context 接口
    
    Parameters:
    
    obj - 实体对象的实例
    
    Returns:
    
    Context
  - getMeta
```
Object getMeta(String key)
```
    获取一个实体补充描述
    
    Parameters:
    
    key - 实体补充描述的键值
    
    Returns:
    
    实体补充描述的内容
  - hasMeta
```
boolean hasMeta(String key)
```
    实体是否包含某一种 meta
    
    Parameters:
    
    key - meta 的键值
    
    Returns:
    
    是否包含
  - getMetas
```
Map<String,Object> getMetas()
```
    Returns:
    
    实体补充描述的集合
  - hasTableComment
```
boolean hasTableComment()
```
    Returns:
    
    表是否有注释
  - hasColumnComment
```
boolean hasColumnComment()
```
    Returns:
    
    字段是否注释
  - getTableComment
```
String getTableComment()
```
    Returns:
    
    表注释
  - getColumnComent
```
String getColumnComent(String columnName)
```
    根据字段名获得注释
    
    Parameters:
    
    columnName - 字段名称
    
    Returns:
    
    注释
  - isComplete
```
boolean isComplete()
```
  - born
```
T born(ResultSet rs)
```
  - getVersionField
```
MappingField getVersionField()
```
    Returns:
    
    实体version字段映射

Interface Entity<T>

Method Summary

Method Detail

getType

getMirror

getIndexes

getTableName

getViewName

getIndex

getObject

getObject

getObject

getObject

getField

addBeforeInsertMacro

addAfterInsertMacro

cloneBeforeInsertMacroes

cloneAfterInsertMacroes

getColumn

getMappingFields

getLinkFields

visitOne

visitMany

visitManyMany

getCompositePKFields

getNameField

getIdField

getPks

getPkType

wrapAsContext

getMeta

hasMeta

getMetas

hasTableComment

hasColumnComment

getTableComment

getColumnComent

isComplete

born

getVersionField