CBase

所有超级接口:

java.io.Serializable

所有已知实现类:

View
```
public interface CBase
extends java.io.Serializable
```
功能说明：数据库基础表接口说明

作者:

陈祥 2021年10月25日

嵌套类概要

嵌套类
限定符和类型	接口和说明
`static interface`	`CBase.OutListener` 输出时的监听接口
`static class`	`CBase.PKey<T>` 主键值，只能是长整形、短整形或字符串类型

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFINE`
`static java.lang.String`	`DSNAME`
`static java.lang.String`	`FIELDS`
`static java.lang.String`	`FUNC`
`static java.lang.String`	`PKNAME`
`static java.lang.String`	`TABLE`

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`VSql`	`build(QEnum.Func func)` 将当前实例构造为可执行的VSql
`<T> T`	`cloneTable()` 克隆当前实例
`<T> T`	`cloneTable(java.lang.Class<T> clazz)` 将当前实例克隆为指定的实例
`long`	`count()` 按条件统计，不为空的字段属性值作为条件值
`java.lang.Object`	`delete()` 根据PK删除对应数据
`void`	`flush()` 刷新当前实例
`void`	`forEach(java.util.function.BiConsumer<? super java.lang.String,? super java.lang.Object> action)` 遍历所有属性
`java.lang.Object`	`get(java.lang.String fieldName)` 根据属性名称获取对应属性值
`java.lang.String`	`getDSName()` 获取当前对象对应的数据源名称
`java.util.Set<java.lang.String>`	`getFields()` 获取所有数据库映衬表的字段名
`java.util.Set<bee.cloud.engine.config.sqlmap.QTable>`	`getJoinTable()`
`java.lang.Object`	`getPK()` 获取PK值
`bee.cloud.engine.config.sqlmap.QTable`	`getQTable()`
`bee.cloud.engine.db.Sqlexe`	`getSqlexe()`
`bee.cloud.engine.db.relation.TableItem`	`getTableItem()`
`java.lang.String`	`getTableName()` 获取当前对象对应的物理表名
`java.lang.Object`	`getValue(java.lang.String fieldName)` 通过属性名称获取属性值
`java.lang.Object`	`getValue(java.lang.String fieldName, java.lang.Object defValue)` 通过属性名称获取属性值
`java.lang.Boolean`	`getValueByBoolean(java.lang.String fieldName)` 通过属性名称获取属性boolean值
`java.lang.Boolean`	`getValueByBoolean(java.lang.String fieldName, java.lang.Boolean defValue)` 通过属性名称获取属性boolean值
`java.util.Date`	`getValueByDate(java.lang.String fieldName)` 通过属性名称获取属性Date值
`java.util.Date`	`getValueByDate(java.lang.String fieldName, java.util.Date defValue)` 通过属性名称获取属性Date值
`java.lang.Double`	`getValueByDubble(java.lang.String fieldName)` 通过属性名称获取属性Double值
`java.lang.Double`	`getValueByDubble(java.lang.String fieldName, java.lang.Double defValue)` 通过属性名称获取属性Double值
`java.lang.Float`	`getValueByFloat(java.lang.String fieldName)` 通过属性名称获取属性Float值
`java.lang.Float`	`getValueByFloat(java.lang.String fieldName, java.lang.Float defValue)` 通过属性名称获取属性Float值
`java.lang.Integer`	`getValueByInt(java.lang.String fieldName)` 通过属性名称获取属性Integer值
`java.lang.Integer`	`getValueByInt(java.lang.String fieldName, java.lang.Integer defValue)` 通过属性名称获取属性Integer值
`java.lang.Long`	`getValueByLong(java.lang.String fieldName)` 通过属性名称获取属性Long值
`java.lang.Long`	`getValueByLong(java.lang.String fieldName, java.lang.Long defValue)` 通过属性名称获取属性Long值
`java.lang.String`	`getValueByString(java.lang.String fieldName)` 通过属性名称获取属性String值
`java.lang.String`	`getValueByString(java.lang.String fieldName, java.lang.String defValue)` 通过属性名称获取属性String值
`java.lang.Object`	`insert()` 新增数据，只插入不为空的属性值
`void`	`instance(com.fasterxml.jackson.databind.JsonNode jn)` 通过JSON数据初始化实例
`void`	`instance(java.util.Map<java.lang.String,java.lang.String> map)` 通过Map数据初始化实例
`void`	`instance(bee.cloud.core.db.RequestParam param)` 通过RequestParam数据初始化实例
`void`	`instance(java.sql.ResultSet rs)` 通过ResultSet数据初始化实例
`boolean`	`isTuomin()` 当前实例脱敏状态
`boolean`	`isValue(java.lang.String fieldName)` 判断字段属性值是否存在
`boolean`	`load(java.lang.String... fields)` 从数据库表中加载数据表中对应数据到当前实例中，执行此方法前需要确保PK不为空
`java.util.Map<java.lang.String,java.lang.Object>`	`outMap()` 输出为Map数据，如果遇脱敏数据会自动脱敏，业务程序中不要调用此方法
`java.util.Map<java.lang.String,java.lang.Object>`	`outMap(CBase.OutListener outListener)` 输出为Map数据，如果遇脱敏数据会自动脱敏，业务程序中不要调用此方法
`java.lang.Object`	`put(java.lang.String fieldName, java.lang.Object value)` 根据属性名称设置属性值
`<T> java.util.List<T>`	`query(java.lang.String... fields)` 按条件批量查询，不为空的字段属性值作为条件值
`java.lang.Object`	`remove(java.lang.String fieldName)` 删除属性值
`void`	`setDSName(java.lang.String dsname)` 设置数据源名称
`void`	`setJoinQTables(java.util.Set<bee.cloud.engine.config.sqlmap.QTable> joinTables)` 设置关联表配置，主要用于输出数据时的加密脱敏等业务
`void`	`setPK(java.lang.Object pk)` 设置实例PK值，不会更新到数据库
`void`	`setSqlexe(bee.cloud.engine.db.Sqlexe sqlexe)`
`void`	`setTuomin(boolean isTuomin)` 设置是否脱敏输出内容
`void`	`setValue(java.lang.String fieldName, java.lang.Object value)` 通过属性名称设置属性值
`com.fasterxml.jackson.databind.JsonNode`	`toJson()` 转为JSON字符串，数据内容未做加密处理，不包含定义“@define”，包含其他属性与子节点属性。
`com.fasterxml.jackson.databind.JsonNode`	`toJsonAndDefine()` 转为JSON字符串，数据内容未做加密处理，包含定义“@define”，不包含其他属性与子节点属性。
`bee.cloud.core.db.RequestParam`	`toRequestParam(java.lang.String... fields)` 将当前实例转换为RequestParam
`java.lang.String`	`toXml()` 转为XML字符串，数据内容未做加密处理，不包含定义“@define”，包含其他属性与子节点属性。
`boolean`	`update(java.lang.String... fields)` 执行更新属性值到数据库表中

- 字段详细资料
  - DSNAME
```
static final java.lang.String DSNAME
```
    另请参阅:
    
    常量字段值
  - TABLE
```
static final java.lang.String TABLE
```
    另请参阅:
    
    常量字段值
  - FIELDS
```
static final java.lang.String FIELDS
```
    另请参阅:
    
    常量字段值
  - PKNAME
```
static final java.lang.String PKNAME
```
    另请参阅:
    
    常量字段值
  - FUNC
```
static final java.lang.String FUNC
```
    另请参阅:
    
    常量字段值
  - DEFINE
```
static final java.lang.String DEFINE
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getPK
```
java.lang.Object getPK()
```
    获取PK值
    
    返回:
    
    -
  - getQTable
```
bee.cloud.engine.config.sqlmap.QTable getQTable()
```
  - getJoinTable
```
java.util.Set<bee.cloud.engine.config.sqlmap.QTable> getJoinTable()
```
  - setDSName
```
void setDSName(java.lang.String dsname)
```
    设置数据源名称
    
    参数:
    
    dsname - -数据源名称
  - getDSName
```
java.lang.String getDSName()
```
    获取当前对象对应的数据源名称
    
    返回:
    
    -
  - getTableName
```
java.lang.String getTableName()
```
    获取当前对象对应的物理表名
    
    返回:
    
    -
  - getTableItem
```
bee.cloud.engine.db.relation.TableItem getTableItem()
```
  - setSqlexe
```
void setSqlexe(bee.cloud.engine.db.Sqlexe sqlexe)
```
  - getSqlexe
```
bee.cloud.engine.db.Sqlexe getSqlexe()
```
  - instance
```
void instance(com.fasterxml.jackson.databind.JsonNode jn)
```
    通过JSON数据初始化实例
    
    参数:
    
    jn - JsonNode
  - instance
```
void instance(java.util.Map<java.lang.String,java.lang.String> map)
```
    通过Map数据初始化实例
    
    参数:
    
    map - -
  - instance
```
void instance(java.sql.ResultSet rs)
```
    通过ResultSet数据初始化实例
    
    参数:
    
    rs - ResultSet
  - instance
```
void instance(bee.cloud.core.db.RequestParam param)
```
    通过RequestParam数据初始化实例
    
    参数:
    
    param - RequestParam
  - setValue
```
void setValue(java.lang.String fieldName,
              java.lang.Object value)
```
    通过属性名称设置属性值
    
    参数:
    
    fieldName - 属性名称
    
    value - 属性值
  - setJoinQTables
```
void setJoinQTables(java.util.Set<bee.cloud.engine.config.sqlmap.QTable> joinTables)
```
    设置关联表配置，主要用于输出数据时的加密脱敏等业务
    
    参数:
    
    joinTables - 关联表
  - getValue
```
java.lang.Object getValue(java.lang.String fieldName)
```
    通过属性名称获取属性值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性值
  - getValue
```
java.lang.Object getValue(java.lang.String fieldName,
                          java.lang.Object defValue)
```
    通过属性名称获取属性值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性值
  - getValueByBoolean
```
java.lang.Boolean getValueByBoolean(java.lang.String fieldName)
```
    通过属性名称获取属性boolean值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    boolean值
  - getValueByBoolean
```
java.lang.Boolean getValueByBoolean(java.lang.String fieldName,
                                    java.lang.Boolean defValue)
```
    通过属性名称获取属性boolean值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    boolean值
  - getValueByDate
```
java.util.Date getValueByDate(java.lang.String fieldName)
```
    通过属性名称获取属性Date值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性Date值
  - getValueByDate
```
java.util.Date getValueByDate(java.lang.String fieldName,
                              java.util.Date defValue)
```
    通过属性名称获取属性Date值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性Date值
  - getValueByInt
```
java.lang.Integer getValueByInt(java.lang.String fieldName)
```
    通过属性名称获取属性Integer值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性Integer值
  - getValueByInt
```
java.lang.Integer getValueByInt(java.lang.String fieldName,
                                java.lang.Integer defValue)
```
    通过属性名称获取属性Integer值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性Integer值
  - getValueByLong
```
java.lang.Long getValueByLong(java.lang.String fieldName)
```
    通过属性名称获取属性Long值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性Long值
  - getValueByLong
```
java.lang.Long getValueByLong(java.lang.String fieldName,
                              java.lang.Long defValue)
```
    通过属性名称获取属性Long值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性Long值
  - getValueByDubble
```
java.lang.Double getValueByDubble(java.lang.String fieldName)
```
    通过属性名称获取属性Double值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性Double值
  - getValueByDubble
```
java.lang.Double getValueByDubble(java.lang.String fieldName,
                                  java.lang.Double defValue)
```
    通过属性名称获取属性Double值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性Double值
  - getValueByFloat
```
java.lang.Float getValueByFloat(java.lang.String fieldName)
```
    通过属性名称获取属性Float值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性Float值
  - getValueByFloat
```
java.lang.Float getValueByFloat(java.lang.String fieldName,
                                java.lang.Float defValue)
```
    通过属性名称获取属性Float值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性Float值
  - getValueByString
```
java.lang.String getValueByString(java.lang.String fieldName)
```
    通过属性名称获取属性String值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性String值
  - getValueByString
```
java.lang.String getValueByString(java.lang.String fieldName,
                                  java.lang.String defValue)
```
    通过属性名称获取属性String值
    
    参数:
    
    fieldName - 属性名称
    
    defValue - 默认属性值，属性值为空时使用默认属性值
    
    返回:
    
    属性String值
  - getFields
```
java.util.Set<java.lang.String> getFields()
```
    获取所有数据库映衬表的字段名
    
    返回:
    
    多个字段名
  - setPK
```
void setPK(java.lang.Object pk)
```
    设置实例PK值，不会更新到数据库
    
    参数:
    
    pk - PK值
  - update
```
boolean update(java.lang.String... fields)
```
    执行更新属性值到数据库表中
    
    参数:
    
    fields - 指定需要更新的字段，当不指定更新字段时，默认只更新不为空的非PK字段
    
    返回:
    
    true-更新成功，false-更新失败
  - load
```
boolean load(java.lang.String... fields)
```
    从数据库表中加载数据表中对应数据到当前实例中，执行此方法前需要确保PK不为空
    
    参数:
    
    fields - 指定需要加载的字段，默认加载所有字段
    
    返回:
    
    true-加载成功，false-加载失败
  - query
```
<T> java.util.List<T> query(java.lang.String... fields)
```
    按条件批量查询，不为空的字段属性值作为条件值
    
    类型参数:
    
    T - 当前实体对象
    
    参数:
    
    fields - 指定返回的字段，不指定时反回所有字段
    
    返回:
    
    实体列表
  - count
```
long count()
```
    按条件统计，不为空的字段属性值作为条件值
    
    返回:
    
    总数量
  - delete
```
java.lang.Object delete()
```
    根据PK删除对应数据
    
    返回:
    
    删除成功的PK值与删除的总数
  - insert
```
java.lang.Object insert()
```
    新增数据，只插入不为空的属性值
    
    返回:
    
    PK值
  - toRequestParam
```
bee.cloud.core.db.RequestParam toRequestParam(java.lang.String... fields)
```
    将当前实例转换为RequestParam
    
    参数:
    
    fields - 指定需要转换的字段名
    
    返回:
    
    RequestParam
  - setTuomin
```
void setTuomin(boolean isTuomin)
```
    设置是否脱敏输出内容
    
    参数:
    
    isTuomin - true-脱敏输出，false-非脱敏输出，默认为true
  - isTuomin
```
boolean isTuomin()
```
    当前实例脱敏状态
    
    返回:
    
    true-脱敏，false-非脱敏
  - cloneTable
```
<T> T cloneTable()
```
    克隆当前实例
    
    类型参数:
    
    T - 当前实例对象
    
    返回:
    
    新的实例对象
  - cloneTable
```
<T> T cloneTable(java.lang.Class<T> clazz)
```
    将当前实例克隆为指定的实例
    
    类型参数:
    
    T - 指定实例类
    
    参数:
    
    clazz - 指定实例类
    
    返回:
    
    指定实例对象
  - get
```
java.lang.Object get(java.lang.String fieldName)
```
    根据属性名称获取对应属性值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    属性值
  - forEach
```
void forEach(java.util.function.BiConsumer<? super java.lang.String,? super java.lang.Object> action)
```
    遍历所有属性
    
    参数:
    
    action - BiConsumer
  - isValue
```
boolean isValue(java.lang.String fieldName)
```
    判断字段属性值是否存在
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    true-存在，false-不存在
  - put
```
java.lang.Object put(java.lang.String fieldName,
                     java.lang.Object value)
```
    根据属性名称设置属性值
    
    参数:
    
    fieldName - 属性名称
    
    value - 属性值
    
    返回:
    
    返回属性值
  - remove
```
java.lang.Object remove(java.lang.String fieldName)
```
    删除属性值
    
    参数:
    
    fieldName - 属性名称
    
    返回:
    
    返回删除的属性值
  - build
```
VSql build(QEnum.Func func)
```
    将当前实例构造为可执行的VSql
    
    参数:
    
    func - 需要构造的执行方法，可参照VSql
    
    返回:
    
    -
  - flush
```
void flush()
```
    刷新当前实例
  - toJson
```
com.fasterxml.jackson.databind.JsonNode toJson()
```
    转为JSON字符串，数据内容未做加密处理，不包含定义“@define”，包含其他属性与子节点属性。
    
    返回:
    
    JsonNode
  - toXml
```
java.lang.String toXml()
```
    转为XML字符串，数据内容未做加密处理，不包含定义“@define”，包含其他属性与子节点属性。
    
    返回:
    
    String
  - toJsonAndDefine
```
com.fasterxml.jackson.databind.JsonNode toJsonAndDefine()
```
    转为JSON字符串，数据内容未做加密处理，包含定义“@define”，不包含其他属性与子节点属性。
    
    返回:
    
    JsonNode
  - outMap
```
java.util.Map<java.lang.String,java.lang.Object> outMap()
```
    输出为Map数据，如果遇脱敏数据会自动脱敏，业务程序中不要调用此方法
    
    返回:
    
    Map
  - outMap
```
java.util.Map<java.lang.String,java.lang.Object> outMap(CBase.OutListener outListener)
```
    输出为Map数据，如果遇脱敏数据会自动脱敏，业务程序中不要调用此方法
    
    参数:
    
    outListener - -
    
    返回:
    
    Map

接口 CBase

嵌套类概要

字段概要

方法概要

字段详细资料

DSNAME

TABLE

FIELDS

PKNAME

FUNC

DEFINE

方法详细资料

getPK

getQTable

getJoinTable

setDSName

getDSName

getTableName

getTableItem

setSqlexe

getSqlexe

instance

instance

instance

instance

setValue

setJoinQTables

getValue

getValue

getValueByBoolean

getValueByBoolean

getValueByDate

getValueByDate

getValueByInt

getValueByInt

getValueByLong

getValueByLong

getValueByDubble

getValueByDubble

getValueByFloat

getValueByFloat

getValueByString

getValueByString

getFields

setPK

update

load

query

count

delete

insert

toRequestParam

setTuomin

isTuomin

cloneTable

cloneTable

get

forEach

isValue

put

remove

build

flush

toJson

toXml

toJsonAndDefine

outMap

outMap