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