WrapperData (fluent mybatis 1.6.12 API)

java.lang.Object
- cn.org.atool.fluent.mybatis.segment.model.WrapperData

所有已实现的接口:

IWrapperData

直接已知子类:

JoinWrapperData
```
public class WrapperData
extends Object
implements IWrapperData
```
WrapperInfo: 查询器或更新器xml需要用到信息

作者:

darui.wu 2020/6/23 5:15 下午

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`isDistinct` select 前面是否加 DISTINCT 关键字
`protected MergeSegments`	`mergeSegments` where, group, having ,order by对象列表
`protected PagedOffset`	`paged` 分页参数
`protected Parameters`	`parameters` 自定义参数列表
`protected List<String>`	`sqlSelect` 查询字段
`protected Supplier<String>`	`table` 表名

构造器概要

构造器
构造器和说明
`WrapperData()`
`WrapperData(Supplier<String> table, String alias, Parameters parameters, Class entityClass, Class queryClass)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addSelectColumn(String column)` 增加查询字段
`void`	`apply(KeyWordSegment keyWord, Column column, ISqlOp operator, Object... paras)` 增加条件设置
`void`	`apply(KeyWordSegment keyWord, Column column, ISqlOp operator, String format, Object... args)` 增加条件设置
`void`	`apply(KeyWordSegment keyWord, ISqlSegment... segments)`
`void`	`customizedSql(String sql, Object parameter)` 自定义的完整sql语句设置
`List<String>`	`findWhereColumns()` 获取where条件字段
`String`	`getGroupBy()` 返回 groupBy + having + orderBy + last 组合起来的语句
`String`	`getLastSql()` 返回last sql部分
`String`	`getMergeSql()` where + groupBy + having + orderBy + limit + last 语句部分
`String`	`getOrderBy()` 返回 groupBy + having + last 组合起来的语句
`String`	`getQuerySql()` select ... from table where ...
`String`	`getSqlSelect()` 查询条件 SQL 片段
`String`	`getTable()`
`String`	`getUpdateStr()` (update) set column1 = value1, column2 = value2
`String`	`getWhereSql()` 返回where部分sql
`String`	`hint(HintType type)`
`void`	`hint(HintType type, String hint)`
`void`	`last(String lastSql)` 附加sql,只允许执行一次
`String`	`paramSql(Column column, String functionSql, Object[] values)` 根据函数和变量构建占位符和设置占位符对应的变量值
`void`	`sharedParameter(Parameters parameters)`
`void`	`sharedParameter(WrapperData wrapperData)`
`List<String>`	`sqlSelect()`
`void`	`updateSet(Column column, Object value)` 更新column字段值
`void`	`updateSql(Column column, String functionSql, Object... values)` 设置更新（自定义SQL）
`ISqlSegment[]`	`whereSegments()`

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

从接口继承的方法 cn.org.atool.fluent.mybatis.segment.model.IWrapperData
isDistinct

- 字段详细资料
  - isDistinct
```
protected boolean isDistinct
```
    select 前面是否加 DISTINCT 关键字
  - sqlSelect
```
protected List<String> sqlSelect
```
    查询字段
  - table
```
protected Supplier<String> table
```
    表名
  - parameters
```
protected final Parameters parameters
```
    自定义参数列表
  - mergeSegments
```
protected final MergeSegments mergeSegments
```
    where, group, having ,order by对象列表
  - paged
```
protected PagedOffset paged
```
    分页参数
- 构造器详细资料
  - WrapperData
```
public WrapperData()
```
  - WrapperData
```
public WrapperData(Supplier<String> table,
                   String alias,
                   Parameters parameters,
                   Class entityClass,
                   Class queryClass)
```
- 方法详细资料
  - getTable
```
public String getTable()
```
  - getSqlSelect
```
public String getSqlSelect()
```
    从接口复制的说明: IWrapperData
    
    查询条件 SQL 片段
    
    指定者:
    
    getSqlSelect 在接口中 IWrapperData
    
    返回:
    
    查询字段列表
  - sqlSelect
```
public List<String> sqlSelect()
```
  - customizedSql
```
public void customizedSql(String sql,
                          Object parameter)
```
    自定义的完整sql语句设置
    
    参数:
    
    sql - sql
    
    parameter - 参数
  - getQuerySql
```
public String getQuerySql()
```
    从接口复制的说明: IWrapperData
    
    select ... from table where ... 不包含分页部分
    
    指定者:
    
    getQuerySql 在接口中 IWrapperData
    
    返回:
    
    select ... from table where ...
  - getUpdateStr
```
public String getUpdateStr()
```
    从接口复制的说明: IWrapperData
    
    (update) set column1 = value1, column2 = value2
    
    指定者:
    
    getUpdateStr 在接口中 IWrapperData
    
    返回:
    
    更新语句
  - getMergeSql
```
public String getMergeSql()
```
    从接口复制的说明: IWrapperData
    
    where + groupBy + having + orderBy + limit + last 语句部分
    
    指定者:
    
    getMergeSql 在接口中 IWrapperData
    
    返回:
    
    where sql
  - getWhereSql
```
public String getWhereSql()
```
    从接口复制的说明: IWrapperData
    
    返回where部分sql
    
    指定者:
    
    getWhereSql 在接口中 IWrapperData
    
    返回:
    
    ignore
  - getGroupBy
```
public String getGroupBy()
```
    从接口复制的说明: IWrapperData
    
    返回 groupBy + having + orderBy + last 组合起来的语句
    
    指定者:
    
    getGroupBy 在接口中 IWrapperData
    
    返回:
    
    ignore
  - getOrderBy
```
public String getOrderBy()
```
    从接口复制的说明: IWrapperData
    
    返回 groupBy + having + last 组合起来的语句
    
    指定者:
    
    getOrderBy 在接口中 IWrapperData
    
    返回:
    
    ignore
  - getLastSql
```
public String getLastSql()
```
    从接口复制的说明: IWrapperData
    
    返回last sql部分
    
    指定者:
    
    getLastSql 在接口中 IWrapperData
    
    返回:
    
    ignore
  - last
```
public void last(String lastSql)
```
    附加sql,只允许执行一次
    
    参数:
    
    lastSql - 附加sql
  - apply
```
public void apply(KeyWordSegment keyWord,
                  Column column,
                  ISqlOp operator,
                  Object... paras)
```
    增加条件设置
    
    参数:
    
    keyWord - or and
    
    column - 设置条件的字段
    
    operator - 条件操作
    
    paras - 条件参数（填充 operator 中占位符?)
  - addSelectColumn
```
public void addSelectColumn(String column)
```
    增加查询字段
    
    参数:
    
    column - 字段
  - apply
```
public void apply(KeyWordSegment keyWord,
                  Column column,
                  ISqlOp operator,
                  String format,
                  Object... args)
```
    增加条件设置
    
    参数:
    
    keyWord - or and
    
    column - 设置条件的字段
    
    operator - 条件操作
    
    format - 格式化sql语句
    
    args - 条件参数（填充 operator 中占位符?)
  - apply
```
public void apply(KeyWordSegment keyWord,
                  ISqlSegment... segments)
```
  - paramSql
```
public String paramSql(Column column,
                       String functionSql,
                       Object[] values)
```
    根据函数和变量构建占位符和设置占位符对应的变量值
    
    参数:
    
    column - 映射字段, 如果 = null, 表示非原始字段赋值
    
    functionSql - 函数
    
    values - 变量列表
    
    返回:
    
    参数化后的sql
  - updateSet
```
public void updateSet(Column column,
                      Object value)
```
    更新column字段值
    
    参数:
    
    column - 被更新字段
    
    value - 更新值
  - updateSql
```
public void updateSql(Column column,
                      String functionSql,
                      Object... values)
```
    设置更新（自定义SQL）
    
    参数:
    
    column - 更新的字段
    
    functionSql - set function sql
    
    values - 对应的参数
  - findWhereColumns
```
public List<String> findWhereColumns()
```
    获取where条件字段
    
    返回:
    
    ignore
  - hint
```
public void hint(HintType type,
                 String hint)
```
  - hint
```
public String hint(HintType type)
```
  - sharedParameter
```
public void sharedParameter(WrapperData wrapperData)
```
  - sharedParameter
```
public void sharedParameter(Parameters parameters)
```
  - whereSegments
```
public ISqlSegment[] whereSegments()
```

类 WrapperData

字段概要

构造器概要

方法概要

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

从接口继承的方法 cn.org.atool.fluent.mybatis.segment.model.IWrapperData

字段详细资料

isDistinct

sqlSelect

table

parameters

mergeSegments

paged

构造器详细资料

WrapperData

WrapperData

方法详细资料

getTable

getSqlSelect

sqlSelect

customizedSql

getQuerySql

getUpdateStr

getMergeSql

getWhereSql

getGroupBy

getOrderBy

getLastSql

last

apply

addSelectColumn

apply

apply

paramSql

updateSet

updateSql

findWhereColumns

hint

hint

sharedParameter

sharedParameter

whereSegments