MapBuilder (Bean Searcher 4.2.8 API)

java.lang.Object
- cn.zhxu.bs.util.Builder<MapBuilder>
- - cn.zhxu.bs.util.MapBuilder

public class MapBuilder
extends Builder<MapBuilder>

检索参数构建器

嵌套类概要

嵌套类
限定符和类型类和说明

static class MapBuilder.Limit

static class MapBuilder.Page

嵌套类
限定符和类型	类和说明
`static class`	`MapBuilder.Limit`
`static class`	`MapBuilder.Page`

字段概要

字段
限定符和类型	字段和说明
`static String`	`FIELD_PARAM`
`static String`	`GROUP_EXPR`
`static String`	`ONLY_SELECT`
`static String`	`ORDER_BY`
`static String`	`PAGING`
`static String`	`SELECT_EXCLUDE`

从类继承的字段 cn.zhxu.bs.util.Builder
group, map, ROOT_GROUP

构造器概要

构造器
构造器和说明

MapBuilder(Map<String,Object> map)

构造器
构造器和说明
`MapBuilder(Map<String,Object> map)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`MapBuilder`	`asc()` 升序，在 `#orderBy(FieldFn)` 方法之后调用
`MapBuilder`	`asc(boolean sure)`
`Map<String,Object>`	`build()` 构建参数
`MapBuilder`	`desc()` 降序，在 `#orderBy(FieldFn)` 方法之后调用
`MapBuilder`	`desc(boolean sure)`
`MapBuilder`	`group(String group)` 开始一个分组（只对字段参数进行分组）在 `Builder.field(String, Object...)` 方法之前使用 }
`MapBuilder`	`groupExpr(String gExpr)` 设置组表达式（用于表达参数组之间的逻辑关系）
`MapBuilder`	`limit(long offset, int size)` 分页
`<T> MapBuilder`	`onlySelect(FieldFns.FieldFn<T,?>... fieldFns)` 指定只 Select 某些字段
`MapBuilder`	`onlySelect(String... fields)` 指定只 Select 某些字段
`<T> MapBuilder`	`orderBy(FieldFns.FieldFn<T,?> fieldFn)` 指定按某个字段排序（默认升序）可再次调用 `desc()` 或 `asc()` 方法指定排序方法
`<T> MapBuilder`	`orderBy(FieldFns.FieldFn<T,?> fieldFn, String order)` 指定按某个字段排序 v3.4.0 后支持调用多次，来指定多字段排序
`MapBuilder`	`orderBy(String fieldName)` 指定按某个字段排序（默认升序）可再次调用 `desc()` 或 `asc()` 方法指定排序方法
`MapBuilder`	`orderBy(String fieldName, String order)` 指定按某个字段排序 v3.4.0 后支持调用多次，来指定多字段排序
`MapBuilder`	`page(long page, int size)` 分页
`MapBuilder`	`put(String key, Object value)` 添加参数
`MapBuilder`	`putAll(Map<String,?> params)` 批量添加参数
`<T> MapBuilder`	`selectExclude(FieldFns.FieldFn<T,?>... fieldFns)` 指定 Select 需要排除哪些字段
`MapBuilder`	`selectExclude(String... fields)` 指定 Select 需要排除哪些字段

从类继承的方法 cn.zhxu.bs.util.Builder
field, field, field, field, field, groupExpr, ic, ic, nextGroup, nextGroup, obtainList, op, op, op, sql, sql, toFields

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

- 字段详细资料
  - ORDER_BY
```
public static final String ORDER_BY
```
  - PAGING
```
public static final String PAGING
```
  - FIELD_PARAM
```
public static final String FIELD_PARAM
```
  - ONLY_SELECT
```
public static final String ONLY_SELECT
```
  - SELECT_EXCLUDE
```
public static final String SELECT_EXCLUDE
```
  - GROUP_EXPR
```
public static final String GROUP_EXPR
```
- 构造器详细资料
  - MapBuilder
```
public MapBuilder(Map<String,Object> map)
```
- 方法详细资料
  - put
```
public MapBuilder put(String key,
                      Object value)
```
    添加参数
    
    参数:
    
    key - 参数名
    
    value - 参数值
    
    返回:
    
    MapBuilder
  - putAll
```
public MapBuilder putAll(Map<String,?> params)
```
    批量添加参数
    
    参数:
    
    params - 参数集
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.8.1
  - onlySelect
```
@SafeVarargs
public final <T> MapBuilder onlySelect(FieldFns.FieldFn<T,?>... fieldFns)
```
    指定只 Select 某些字段
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    fieldFns - 需要 Select 的字段表达式，可多个
    
    返回:
    
    MapBuilder
  - onlySelect
```
public MapBuilder onlySelect(String... fields)
```
    指定只 Select 某些字段
    
    参数:
    
    fields - 需要 Select 的字段名，可多个
    
    返回:
    
    MapBuilder
  - selectExclude
```
@SafeVarargs
public final <T> MapBuilder selectExclude(FieldFns.FieldFn<T,?>... fieldFns)
```
    指定 Select 需要排除哪些字段
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    fieldFns - 需要排除的字段表达式，可多个
    
    返回:
    
    MapBuilder
  - selectExclude
```
public MapBuilder selectExclude(String... fields)
```
    指定 Select 需要排除哪些字段
    
    参数:
    
    fields - 需要排除的字段名，可多个
    
    返回:
    
    MapBuilder
  - group
```
public MapBuilder group(String group)
```
    开始一个分组（只对字段参数进行分组）在 Builder.field(String, Object...) 方法之前使用 }
    
    参数:
    
    group - 组名（非空）
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.5.0
  - groupExpr
```
public MapBuilder groupExpr(String gExpr)
```
    设置组表达式（用于表达参数组之间的逻辑关系）
    
    参数:
    
    gExpr - 表达式
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.5.0
  - orderBy
```
public <T> MapBuilder orderBy(FieldFns.FieldFn<T,?> fieldFn,
                              String order)
```
    指定按某个字段排序 v3.4.0 后支持调用多次，来指定多字段排序
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    fieldFn - 字段表达式
    
    order - 排序方法：asc, desc
    
    返回:
    
    MapBuilder
  - orderBy
```
public MapBuilder orderBy(String fieldName,
                          String order)
```
    指定按某个字段排序 v3.4.0 后支持调用多次，来指定多字段排序
    
    参数:
    
    fieldName - 属性名
    
    order - 排序方法：asc, desc
    
    返回:
    
    MapBuilder
  - orderBy
```
public <T> MapBuilder orderBy(FieldFns.FieldFn<T,?> fieldFn)
```
    指定按某个字段排序（默认升序）可再次调用 desc() 或 asc() 方法指定排序方法
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    fieldFn - 字段表达式
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.7.1
  - orderBy
```
public MapBuilder orderBy(String fieldName)
```
    指定按某个字段排序（默认升序）可再次调用 desc() 或 asc() 方法指定排序方法
    
    参数:
    
    fieldName - 属性名
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.7.1
  - asc
```
public MapBuilder asc()
```
    升序，在 #orderBy(FieldFn) 方法之后调用
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.7.1
  - asc
```
public MapBuilder asc(boolean sure)
```
    参数:
    
    sure - 是否确定升序
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.8.1
  - desc
```
public MapBuilder desc()
```
    降序，在 #orderBy(FieldFn) 方法之后调用
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.7.1
  - desc
```
public MapBuilder desc(boolean sure)
```
    参数:
    
    sure - 是否确定降序
    
    返回:
    
    MapBuilder
    
    从以下版本开始:
    
    v3.8.1
  - page
```
public MapBuilder page(long page,
                       int size)
```
    分页
    
    参数:
    
    page - 页码，从 0 开始
    
    size - 每页大小
    
    返回:
    
    MapBuilder
  - limit
```
public MapBuilder limit(long offset,
                        int size)
```
    分页
    
    参数:
    
    offset - 偏移量，从 0 开始
    
    size - 每页大小
    
    返回:
    
    MapBuilder
  - build
```
public Map<String,Object> build()
```
    构建参数
    
    返回:
    
    检索参数

类 MapBuilder

嵌套类概要

字段概要

从类继承的字段 cn.zhxu.bs.util.Builder

构造器概要

方法概要

从类继承的方法 cn.zhxu.bs.util.Builder

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

字段详细资料

ORDER_BY

PAGING

FIELD_PARAM

ONLY_SELECT

SELECT_EXCLUDE

GROUP_EXPR

构造器详细资料

MapBuilder

方法详细资料

put

putAll

onlySelect

onlySelect

selectExclude

selectExclude

group

groupExpr

orderBy

orderBy

orderBy

orderBy

asc

asc

desc

desc

page

limit

build