BaseSqlProvider (fluent mybatis 1.6.12 API)

java.lang.Object
- cn.org.atool.fluent.mybatis.base.crud.BaseSqlProvider<E>

public abstract class BaseSqlProvider<E extends IEntity>
extends Object

SqlProvider: 动态SQL构造基类

作者:: wudarui

构造器概要

构造器
构造器和说明

BaseSqlProvider()

构造器
构造器和说明
`BaseSqlProvider()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected abstract List<String>`	`allFields(boolean withPk)` 所有字段列表(以逗号隔开)
`static String`	`batchCrud(Map map)` 批量更新, 插入, 删除操作语句构造 `IEntityMapper.batchCrud(BatchCrud)`
`String`	`buildDeleteSql(WrapperData ew, boolean isLogic)` 根据WrapperData设置构建删除语句
`static String`	`buildInsertSelect(DbType dbType, String tableName, String[] fields, IQuery query)`
`String`	`buildInsertSql(String prefix, E entity, boolean withPk)` 构建插入语句
`String`	`buildUpdaterSql(WrapperData ew)` 根据WrapperData设置构建更新语句
`protected void`	`checkUpdateVersionWhere(List<String> wheres)` 更新时, 检查乐观锁字段条件是否设置
`String`	`count(Map map)` count(IQuery) SQL构造
`String`	`countNoLimit(Map map)` 去掉limit部分 count(IQuery) SQL构造
`protected abstract DbType`	`dbType()` 数据库类型
`String`	`delete(Map map)` 根据动态查询条件物理删除数据SQL构造
`String`	`deleteById(Map map)` 根据主键物理删除数据SQL构造
`String`	`deleteByIds(Map map)` 根据主键列表物理删除数据SQL构造
`String`	`deleteByMap(Map<String,Object> map)` 按map删除数据SQL构造
`String`	`findById(Serializable id)` 根据主键查找数据SQL构造
`String`	`findOne(Map map)` 根据动态条件查询一条记录SQL构造
`String`	`insert(E entity)` 插入id未赋值的entity
`String`	`insertBatch(Map map)`
`protected abstract List<String>`	`insertBatchEntity(int index, E entity, boolean withPk)` 批量插入时，第index个实例VALUES SQL构造
`String`	`insertBatchWithPk(Map map)`
`protected abstract void`	`insertEntity(InsertList inserts, String prefix, E entity, boolean withPk)` 单个插入时, insert字段和值
`String`	`insertSelect(Map map)` 构造`IEntityMapper.insertSelect(String[], IQuery)`SQL语句
`String`	`insertWithPk(E entity)` 插入id已赋值的entity
`String`	`listByIds(Map map)` 根据Id列表查询数据SQL构造
`String`	`listByMap(Map map)` 根据Map查询数据SQL构造
`String`	`listEntity(Map map)` 根据动态条件查询Entity SQL构造
`String`	`listMaps(Map map)` 根据动态条件查询Map列表 SQL构造
`String`	`listObjs(Map map)` 根据动态条件查询单列数据列表 SQL构造
`String`	`logicDelete(Map map)` 根据动态查询条件逻辑删除数据SQL构造
`String`	`logicDeleteById(Map map)` 根据主键逻辑删除数据SQL构造
`String`	`logicDeleteByIds(Map map)` 根据主键列表逻辑删除数据SQL构造
`String`	`logicDeleteByMap(Map<String,Object> map)` 按map逻辑删除数据SQL构造
`protected abstract boolean`	`longTypeOfLogicDelete()` 逻辑删除字段是否为 Long 型
`protected abstract IMapping`	`mapping()` 获取字段映射关系
`protected abstract boolean`	`primaryIsNull(E entity)` entity无主键或者主键值为null
`protected abstract boolean`	`primaryNotNull(E entity)` entity无主键或者主键有值
`protected abstract void`	`setEntityByDefault(IEntity entity)` 根据`IDefaultSetter.setInsertDefault(IEntity)`设置默认值
`protected abstract String`	`tableName()` 返回表名
`String`	`updateBy(Map<String,Object> map)` update(IQuery) SQL构造
`protected abstract List<String>`	`updateDefaults(Map<String,String> updates, boolean ignoreLockVersion)` 构造updates中没有显式设置的默认值构造

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

- 构造器详细资料
  - BaseSqlProvider
```
public BaseSqlProvider()
```
- 方法详细资料
  - batchCrud
```
public static String batchCrud(Map map)
```
    批量更新, 插入, 删除操作语句构造 IEntityMapper.batchCrud(BatchCrud)
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - insertSelect
```
public String insertSelect(Map map)
```
    构造IEntityMapper.insertSelect(String[], IQuery)SQL语句
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - buildInsertSelect
```
public static String buildInsertSelect(DbType dbType,
                                       String tableName,
                                       String[] fields,
                                       IQuery query)
```
  - insert
```
public String insert(E entity)
```
    插入id未赋值的entity
    
    参数:
    
    entity - 实体实例
    
    返回:
    
    sql
  - insertWithPk
```
public String insertWithPk(E entity)
```
    插入id已赋值的entity
    
    参数:
    
    entity - 实体实例
    
    返回:
    
    sql
  - insertBatch
```
public String insertBatch(Map map)
```
  - insertBatchWithPk
```
public String insertBatchWithPk(Map map)
```
  - insertEntity
```
protected abstract void insertEntity(InsertList inserts,
                                     String prefix,
                                     E entity,
                                     boolean withPk)
```
    单个插入时, insert字段和值
    
    参数:
    
    inserts - 插入字段值对
    
    entity - 实体实例
    
    withPk - true:with id; false: without id
  - insertBatchEntity
```
protected abstract List<String> insertBatchEntity(int index,
                                                  E entity,
                                                  boolean withPk)
```
    批量插入时，第index个实例VALUES SQL构造
    
    参数:
    
    index - 序号
    
    entity - 实例
    
    withPk - true:with id; false: without id
    
    返回:
    
    ignore
  - primaryIsNull
```
protected abstract boolean primaryIsNull(E entity)
```
    entity无主键或者主键值为null
    
    参数:
    
    entity - 实体实例
    
    返回:
    
    ignore
  - primaryNotNull
```
protected abstract boolean primaryNotNull(E entity)
```
    entity无主键或者主键有值
    
    参数:
    
    entity - 实体实例
    
    返回:
    
    ignore
  - countNoLimit
```
public String countNoLimit(Map map)
```
    去掉limit部分 count(IQuery) SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - count
```
public String count(Map map)
```
    count(IQuery) SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - listEntity
```
public String listEntity(Map map)
```
    根据动态条件查询Entity SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - listMaps
```
public String listMaps(Map map)
```
    根据动态条件查询Map列表 SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - listObjs
```
public String listObjs(Map map)
```
    根据动态条件查询单列数据列表 SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - listByMap
```
public String listByMap(Map map)
```
    根据Map查询数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - listByIds
```
public String listByIds(Map map)
```
    根据Id列表查询数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    sql
  - findById
```
public String findById(Serializable id)
```
    根据主键查找数据SQL构造
    
    参数:
    
    id - 主键
    
    返回:
    
    ignore
  - findOne
```
public String findOne(Map map)
```
    根据动态条件查询一条记录SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - deleteById
```
public String deleteById(Map map)
```
    根据主键物理删除数据SQL构造
    
    参数:
    
    map - 主键值
    
    返回:
    
    ignore
  - logicDeleteById
```
public String logicDeleteById(Map map)
```
    根据主键逻辑删除数据SQL构造
    
    参数:
    
    map - 参数
    
    返回:
    
    ignore
  - deleteByIds
```
public String deleteByIds(Map map)
```
    根据主键列表物理删除数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - logicDeleteByIds
```
public String logicDeleteByIds(Map map)
```
    根据主键列表逻辑删除数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - deleteByMap
```
public String deleteByMap(Map<String,Object> map)
```
    按map删除数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - logicDeleteByMap
```
public String logicDeleteByMap(Map<String,Object> map)
```
    按map逻辑删除数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - delete
```
public String delete(Map map)
```
    根据动态查询条件物理删除数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - logicDelete
```
public String logicDelete(Map map)
```
    根据动态查询条件逻辑删除数据SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - updateBy
```
public String updateBy(Map<String,Object> map)
```
    update(IQuery) SQL构造
    
    参数:
    
    map - k-v条件
    
    返回:
    
    ignore
  - setEntityByDefault
```
protected abstract void setEntityByDefault(IEntity entity)
```
    根据IDefaultSetter.setInsertDefault(IEntity)设置默认值
    
    参数:
    
    entity - 实体实例
  - updateDefaults
```
protected abstract List<String> updateDefaults(Map<String,String> updates,
                                               boolean ignoreLockVersion)
```
    构造updates中没有显式设置的默认值构造
    
    参数:
    
    updates - 显式update字段
    
    返回:
    
    ignore
  - buildInsertSql
```
public String buildInsertSql(String prefix,
                             E entity,
                             boolean withPk)
```
    构建插入语句
    
    参数:
    
    prefix - entity变量前缀
    
    entity - 实体实例
    
    withPk - 包含主键?
    
    返回:
    
    ignore
  - buildUpdaterSql
```
public String buildUpdaterSql(WrapperData ew)
```
    根据WrapperData设置构建更新语句
    
    参数:
    
    ew - 更新/查询构造数据
    
    返回:
    
    sql
  - checkUpdateVersionWhere
```
protected void checkUpdateVersionWhere(List<String> wheres)
```
    更新时, 检查乐观锁字段条件是否设置
  - buildDeleteSql
```
public String buildDeleteSql(WrapperData ew,
                             boolean isLogic)
```
    根据WrapperData设置构建删除语句
    
    参数:
    
    ew - 更新/查询构造数据
    
    返回:
    
    sql
  - dbType
```
protected abstract DbType dbType()
```
    数据库类型
    
    返回:
    
    ignore
  - tableName
```
protected abstract String tableName()
```
    返回表名
    
    返回:
    
    ignore
  - allFields
```
protected abstract List<String> allFields(boolean withPk)
```
    所有字段列表(以逗号隔开)
    
    参数:
    
    withPk - 是否包含主键字段
    
    返回:
    
    ignore
  - mapping
```
protected abstract IMapping mapping()
```
    获取字段映射关系
    
    返回:
    
    字段映射
  - longTypeOfLogicDelete
```
protected abstract boolean longTypeOfLogicDelete()
```
    逻辑删除字段是否为 Long 型
    
    返回:
    
    ignore

类 BaseSqlProvider<E extends IEntity>

构造器概要

方法概要

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

构造器详细资料

BaseSqlProvider

方法详细资料

batchCrud

insertSelect

buildInsertSelect

insert

insertWithPk

insertBatch

insertBatchWithPk

insertEntity

insertBatchEntity

primaryIsNull

primaryNotNull

countNoLimit

count

listEntity

listMaps

listObjs

listByMap

listByIds

findById

findOne

deleteById

logicDeleteById

deleteByIds

logicDeleteByIds

deleteByMap

logicDeleteByMap

delete

logicDelete

updateBy

setEntityByDefault

updateDefaults

buildInsertSql

buildUpdaterSql

checkUpdateVersionWhere

buildDeleteSql

dbType

tableName

allFields

mapping

longTypeOfLogicDelete