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

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

All Implemented Interfaces:

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

Author:

zozoh(zozohtnt@gmail.com)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Borning<T>`	`bornByDefault` 根据默认构造函数或者工厂方法创建实体的方法
`protected Borning<T>`	`bornByRS` 根据 ResultSet 创建实体的方法
`protected LinkFieldSet`	`manymanys` 所有多对多映射字段
`protected LinkFieldSet`	`manys` 所有一对多映射字段
`protected LinkFieldSet`	`ones` 所有一对一映射字段
`protected Class<T>`	`type` 实体 Java 类型

Constructor Summary

Constructors
Constructor and Description

NutEntity(Class<T> type)

Constructors
Constructor and Description
`NutEntity(Class<T> type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` 如果实体采用了复合主键，调用这个函数能返回所有的复合主键，顺序就是复合主键的顺序
`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)` 访问所有一对多映射。即 '@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 接口

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

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

Class NutEntity<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ones

manys

manymanys

type

bornByRS

bornByDefault

Constructor Detail

NutEntity

Method Detail

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