NutEntity (Nutz 1.r.61.r2 API)

java.lang.Object
- org.nutz.dao.impl.entity.NutEntity<T>

所有已实现的接口:

Entity<T>
```
public class NutEntity<T>
extends Object
implements Entity<T>
```
记录一个实体

作者:

zozoh(zozohtnt@gmail.com)

字段概要

字段
限定符和类型	字段和说明
`protected Borning<T>`	`bornByDefault` 根据默认构造函数或者工厂方法创建实体的方法
`protected Borning<T>`	`bornByRS` 根据 ResultSet 创建实体的方法
`protected LinkFieldSet`	`manymanys` 所有多对多映射字段
`protected LinkFieldSet`	`manys` 所有一对多映射字段
`protected LinkFieldSet`	`ones` 所有一对一映射字段
`protected Class<T>`	`type` 实体 Java 类型

构造器概要

构造器
构造器和说明

NutEntity(Class<T> type)

构造器
构造器和说明
`NutEntity(Class<T> type)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`addAfterInsertMacro(Pojo pojo)` 增加一个插入后字段宏
`boolean`	`addBeforeInsertMacro(Pojo pojo)` 增加一个插入前字段宏
`void`	`addIndex(EntityIndex index)` 增加实体索引
`void`	`addLinkField(LinkField lnk)`
`void`	`addMappingField(MappingField field)` 增加映射字段
`T`	`born(ResultSet rs)`
`void`	`checkCompositeFields(String[] names)` 当所有字段增加完成，这个方法必须被调用，用来搜索复合主键
`List<Pojo>`	`cloneAfterInsertMacroes()` 获取实体所有自动执行的字段宏列表这些自动执行宏，在实体被插入到数据库后调用比如程序员可以为数据库自动生成的字段获取生成后的值
`List<Pojo>`	`cloneBeforeInsertMacroes()` 获取实体所有自动执行的字段宏列表这些自动执行宏，在实体被插入到数据库前调用比如程序员可以为某个字段定义值的自动生成规则
`MappingField`	`getColumn(String name)` 根据实体的数据库字段名获取一个实体字段对象
`String`	`getColumnComent(String columnName)` 根据字段名获得注释
`List<MappingField>`	`getCompositePKFields()` 如果实体采用了复合主键，调用这个函数能返回所有的复合主键，顺序就是复合主键的顺序如果没有复合主键，那么将返回 null
`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()`
`void`	`setAfterInsertMacroes(List<Pojo> afterInsertMacroes)`
`void`	`setBeforeInsertMacroes(List<Pojo> beforeInsertMacroes)`
`void`	`setComplete(boolean complete)`
`void`	`setHasColumnComment(boolean hasColumnComment)`
`void`	`setHasTableComment(boolean hasTableComment)`
`void`	`setTableComment(String tComment)`
`void`	`setTableName(String namep)`
`void`	`setViewName(String namep)`
`String`	`toString()`
`List<LinkField>`	`visitMany(Object obj, String regex, LinkVisitor visitor)` 访问所有一对多映射。
`List<LinkField>`	`visitManyMany(Object obj, String regex, LinkVisitor visitor)` 访问所有多对多映射。
`List<LinkField>`	`visitOne(Object obj, String regex, LinkVisitor visitor)` 访问所有一对一映射。
`Context`	`wrapAsContext(Object obj)` 将一个实体对象的实例包裹成 Context 接口

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - ones
```
protected LinkFieldSet ones
```
    所有一对一映射字段
  - manys
```
protected LinkFieldSet manys
```
    所有一对多映射字段
  - manymanys
```
protected LinkFieldSet manymanys
```
    所有多对多映射字段
  - type
```
protected Class<T> type
```
    实体 Java 类型
  - bornByRS
```
protected Borning<T> bornByRS
```
    根据 ResultSet 创建实体的方法
  - bornByDefault
```
protected Borning<T> bornByDefault
```
    根据默认构造函数或者工厂方法创建实体的方法
- 构造器详细资料
  - NutEntity
```
public NutEntity(Class<T> type)
```
- 方法详细资料
  - getObject
```
public T getObject(ResultSet rs,
                   FieldMatcher matcher)
```
    从接口复制的说明: Entity
    
    从结果集中生成一个实体实例
    
    指定者:
    
    getObject 在接口中 Entity<T>
    
    参数:
    
    rs - 结果集
    
    matcher - 字段匹配器。如果为null，则获取实体的全部字段
    
    返回:
    
    Java 对象
  - getObject
```
public T getObject(ResultSet rs,
                   FieldMatcher matcher,
                   String prefix)
```
    指定者:
    
    getObject 在接口中 Entity<T>
  - getObject
```
public T getObject(Record rec)
```
    从接口复制的说明: Entity
    
    从一个记录中生成一个实体实例
    
    指定者:
    
    getObject 在接口中 Entity<T>
    
    参数:
    
    rec - 结果集
    
    返回:
    
    Java 对象
  - getObject
```
public T getObject(Record rec,
                   String prefix)
```
    指定者:
    
    getObject 在接口中 Entity<T>
  - checkCompositeFields
```
public void checkCompositeFields(String[] names)
```
    当所有字段增加完成，这个方法必须被调用，用来搜索复合主键
    
    参数:
    
    names - 复合主键的 Java 字段名数组
  - addMappingField
```
public void addMappingField(MappingField field)
```
    增加映射字段
    
    参数:
    
    field - 数据库实体字段
  - addLinkField
```
public void addLinkField(LinkField lnk)
```
    参数:
    
    lnk -
  - addIndex
```
public void addIndex(EntityIndex index)
```
    增加实体索引
    
    参数:
    
    index - 实体索引
  - wrapAsContext
```
public Context wrapAsContext(Object obj)
```
    从接口复制的说明: Entity
    
    将一个实体对象的实例包裹成 Context 接口
    
    指定者:
    
    wrapAsContext 在接口中 Entity<T>
    
    参数:
    
    obj - 实体对象的实例
    
    返回:
    
    Context
  - visitOne
```
public List<LinkField> visitOne(Object obj,
                                String regex,
                                LinkVisitor visitor)
```
    从接口复制的说明: Entity
    
    访问所有一对一映射。即 '@One' 声明的字段
    
    指定者:
    
    visitOne 在接口中 Entity<T>
    
    参数:
    
    obj - 映射的宿主对象
    
    regex - 正则表达式匹配 Java 字段名。null 表示匹配所有一对一映射字段
    
    visitor - 处理器
    
    返回:
    
    匹配上的映射字段
  - visitMany
```
public List<LinkField> visitMany(Object obj,
                                 String regex,
                                 LinkVisitor visitor)
```
    从接口复制的说明: Entity
    
    访问所有一对多映射。即 '@Many' 声明的字段
    
    指定者:
    
    visitMany 在接口中 Entity<T>
    
    参数:
    
    obj - 映射的宿主对象
    
    regex - 正则表达式匹配 Java 字段名。null 表示匹配所有一对多映射字段
    
    visitor - 处理器
    
    返回:
    
    匹配上的映射字段
  - visitManyMany
```
public List<LinkField> visitManyMany(Object obj,
                                     String regex,
                                     LinkVisitor visitor)
```
    从接口复制的说明: Entity
    
    访问所有多对多映射。即 '@ManyMany' 声明的字段
    
    指定者:
    
    visitManyMany 在接口中 Entity<T>
    
    参数:
    
    obj - 映射的宿主对象
    
    regex - 正则表达式匹配 Java 字段名。null 表示匹配所有多对多映射字段
    
    visitor - 处理器
    
    返回:
    
    匹配上的映射字段
  - setTableName
```
public void setTableName(String namep)
```
  - setTableComment
```
public void setTableComment(String tComment)
```
  - setHasTableComment
```
public void setHasTableComment(boolean hasTableComment)
```
  - setHasColumnComment
```
public void setHasColumnComment(boolean hasColumnComment)
```
  - setBeforeInsertMacroes
```
public void setBeforeInsertMacroes(List<Pojo> beforeInsertMacroes)
```
  - setAfterInsertMacroes
```
public void setAfterInsertMacroes(List<Pojo> afterInsertMacroes)
```
  - setViewName
```
public void setViewName(String namep)
```
  - getField
```
public MappingField getField(String name)
```
    从接口复制的说明: Entity
    
    根据实体的 Java 字段名获取一个实体字段对象
    
    指定者:
    
    getField 在接口中 Entity<T>
    
    参数:
    
    name - 实体字段的 Java 对象名
    
    返回:
    
    实体字段
  - getColumn
```
public MappingField getColumn(String name)
```
    从接口复制的说明: Entity
    
    根据实体的数据库字段名获取一个实体字段对象
    
    指定者:
    
    getColumn 在接口中 Entity<T>
    
    参数:
    
    name - 实体字段数据库字段名
    
    返回:
    
    实体字段
  - getMappingFields
```
public List<MappingField> getMappingFields()
```
    指定者:
    
    getMappingFields 在接口中 Entity<T>
    
    返回:
    
    实体所有的映射字段
  - getLinkFields
```
public List<LinkField> getLinkFields(String regex)
```
    从接口复制的说明: Entity
    
    获取实体所有匹配上正则表达是的关联字段，如果正则表达是为 null，则表示获取全部关联字段
    
    指定者:
    
    getLinkFields 在接口中 Entity<T>
    
    参数:
    
    regex - 正则表达式
    
    返回:
    
    实体所有匹配上正则表达是的关联字段
  - getCompositePKFields
```
public List<MappingField> getCompositePKFields()
```
    从接口复制的说明: Entity
    
    如果实体采用了复合主键，调用这个函数能返回所有的复合主键，顺序就是复合主键的顺序
    如果没有复合主键，那么将返回 null
    
    指定者:
    
    getCompositePKFields 在接口中 Entity<T>
    
    返回:
    
    实体所复合主键字段
  - getNameField
```
public MappingField getNameField()
```
    指定者:
    
    getNameField 在接口中 Entity<T>
    
    返回:
    
    实体唯一字符类型主键
  - getVersionField
```
public MappingField getVersionField()
```
    指定者:
    
    getVersionField 在接口中 Entity<T>
    
    返回:
    
    实体version字段映射
  - getIdField
```
public MappingField getIdField()
```
    指定者:
    
    getIdField 在接口中 Entity<T>
    
    返回:
    
    实体唯一数字类型主键
  - getPks
```
public List<MappingField> getPks()
```
    从接口复制的说明: Entity
    
    根据，"数字主键 > 字符主键 > 复合主键" 的优先顺序，返回主键列表
    
    指定者:
    
    getPks 在接口中 Entity<T>
    
    返回:
    
    实体的主键列表
  - getType
```
public Class<T> getType()
```
    指定者:
    
    getType 在接口中 Entity<T>
    
    返回:
    
    实体的 Java 类型
  - getMirror
```
public Mirror<T> getMirror()
```
    指定者:
    
    getMirror 在接口中 Entity<T>
    
    返回:
    
    实体的 Java 类型
  - getIndexes
```
public List<EntityIndex> getIndexes()
```
    指定者:
    
    getIndexes 在接口中 Entity<T>
    
    返回:
    
    实体索引列表
  - getIndex
```
public EntityIndex getIndex(String name)
```
    从接口复制的说明: Entity
    
    按名称获取一个实体的索引
    
    指定者:
    
    getIndex 在接口中 Entity<T>
    
    参数:
    
    name - 索引名称
    
    返回:
    
    实体索引
  - getTableName
```
public String getTableName()
```
    从接口复制的说明: Entity
    
    获取实体的表名
    
    指定者:
    
    getTableName 在接口中 Entity<T>
    
    返回:
    
    实体表名
  - getViewName
```
public String getViewName()
```
    从接口复制的说明: Entity
    
    获取实体视图名
    
    指定者:
    
    getViewName 在接口中 Entity<T>
    
    返回:
    
    实体视图名
  - addBeforeInsertMacro
```
public boolean addBeforeInsertMacro(Pojo pojo)
```
    从接口复制的说明: Entity
    
    增加一个插入前字段宏
    
    指定者:
    
    addBeforeInsertMacro 在接口中 Entity<T>
    
    参数:
    
    pojo - Pojo 语句
    
    返回:
    
    是否增加成功
  - addAfterInsertMacro
```
public boolean addAfterInsertMacro(Pojo pojo)
```
    从接口复制的说明: Entity
    
    增加一个插入后字段宏
    
    指定者:
    
    addAfterInsertMacro 在接口中 Entity<T>
    
    参数:
    
    pojo - Pojo 语句
    
    返回:
    
    是否增加成功
  - cloneBeforeInsertMacroes
```
public List<Pojo> cloneBeforeInsertMacroes()
```
    从接口复制的说明: Entity
    
    获取实体所有自动执行的字段宏列表
    这些自动执行宏，在实体被插入到数据库前调用
    比如程序员可以为某个字段定义值的自动生成规则
    
    指定者:
    
    cloneBeforeInsertMacroes 在接口中 Entity<T>
    
    返回:
    
    预执行宏列表
  - cloneAfterInsertMacroes
```
public List<Pojo> cloneAfterInsertMacroes()
```
    从接口复制的说明: Entity
    
    获取实体所有自动执行的字段宏列表
    这些自动执行宏，在实体被插入到数据库后调用
    比如程序员可以为数据库自动生成的字段获取生成后的值
    
    指定者:
    
    cloneAfterInsertMacroes 在接口中 Entity<T>
    
    返回:
    
    后执行字段宏列表
  - getPkType
```
public PkType getPkType()
```
    指定者:
    
    getPkType 在接口中 Entity<T>
    
    返回:
    
    当前实体首选主键类型
  - getMeta
```
public Object getMeta(String key)
```
    从接口复制的说明: Entity
    
    获取一个实体补充描述
    
    指定者:
    
    getMeta 在接口中 Entity<T>
    
    参数:
    
    key - 实体补充描述的键值
    
    返回:
    
    实体补充描述的内容
  - hasMeta
```
public boolean hasMeta(String key)
```
    从接口复制的说明: Entity
    
    实体是否包含某一种 meta
    
    指定者:
    
    hasMeta 在接口中 Entity<T>
    
    参数:
    
    key - meta 的键值
    
    返回:
    
    是否包含
  - getMetas
```
public Map<String,Object> getMetas()
```
    指定者:
    
    getMetas 在接口中 Entity<T>
    
    返回:
    
    实体补充描述的集合
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - hasTableComment
```
public boolean hasTableComment()
```
    指定者:
    
    hasTableComment 在接口中 Entity<T>
    
    返回:
    
    表是否有注释
  - getTableComment
```
public String getTableComment()
```
    指定者:
    
    getTableComment 在接口中 Entity<T>
    
    返回:
    
    表注释
  - hasColumnComment
```
public boolean hasColumnComment()
```
    指定者:
    
    hasColumnComment 在接口中 Entity<T>
    
    返回:
    
    字段是否注释
  - getColumnComent
```
public String getColumnComent(String columnName)
```
    从接口复制的说明: Entity
    
    根据字段名获得注释
    
    指定者:
    
    getColumnComent 在接口中 Entity<T>
    
    参数:
    
    columnName - 字段名称
    
    返回:
    
    注释
  - isComplete
```
public boolean isComplete()
```
    指定者:
    
    isComplete 在接口中 Entity<T>
  - setComplete
```
public void setComplete(boolean complete)
```
  - born
```
public T born(ResultSet rs)
```
    指定者:
    
    born 在接口中 Entity<T>

类 NutEntity<T>

字段概要

构造器概要

方法概要

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

字段详细资料

ones

manys

manymanys

type

bornByRS

bornByDefault

构造器详细资料

NutEntity

方法详细资料

getObject

getObject

getObject

getObject

checkCompositeFields

addMappingField

addLinkField

addIndex

wrapAsContext

visitOne

visitMany

visitManyMany

setTableName

setTableComment

setHasTableComment

setHasColumnComment

setBeforeInsertMacroes

setAfterInsertMacroes

setViewName

getField

getColumn

getMappingFields

getLinkFields

getCompositePKFields

getNameField

getVersionField

getIdField

getPks

getType

getMirror

getIndexes

getIndex

getTableName

getViewName

addBeforeInsertMacro

addAfterInsertMacro

cloneBeforeInsertMacroes

cloneAfterInsertMacroes

getPkType

getMeta

hasMeta

getMetas

toString

hasTableComment

getTableComment

hasColumnComment

getColumnComent

isComplete

setComplete

born