SearchRequest (framework-database 1.2.0 API)

java.lang.Object
- com.github.fartherp.framework.database.mybatis.plugin.search.vo.Searchable
- - com.github.fartherp.framework.database.mybatis.plugin.search.vo.SearchRequest

```
public class SearchRequest
extends Searchable
```
查询条件（包括分页和排序）

User: hyssop
Date: 16-1-15 上午7:29
Version: 1.0

字段概要
- 从类继承的字段 com.github.fartherp.framework.database.mybatis.plugin.search.vo.Searchable
  converted, page, sort

构造器概要

构造器
构造器和说明
`SearchRequest()`
`SearchRequest(Map<String,Object> searchParams)`
`SearchRequest(Map<String,Object> searchParams, PageRequest page)`
`SearchRequest(Map<String,Object> searchParams, PageRequest page, Sort sort)` 根据查询参数拼Search 查询参数格式：property_op=value 或 customerProperty=value customerProperty查找规则是：1、先查找domain的属性，2、如果找不到查找domain上的SearchPropertyMappings映射规则属性、操作符之间用_分割，op可省略/或custom，省略后值默认为custom，即程序中自定义如果op=custom，property也可以自定义（即可以与domain的不一样）,
`SearchRequest(Map<String,Object> searchParams, Sort sort)`

方法概要

方法
限定符和类型	方法和说明
`Searchable`	`addSearchFilter(SearchFilter searchFilter)`
`Searchable`	`addSearchFilter(String searchProperty, SearchOperator operator, Object value)` 添加过滤条件
`Searchable`	`addSearchFilters(Collection<? extends SearchFilter> searchFilters)` 添加多个and连接的过滤条件
`Searchable`	`addSearchParam(String key, Object value)` 添加过滤条件如key="parent.id_eq" value = 1 如果添加时不加操作符默认是custom 即如key=parent 实际key是parent_custom
`Searchable`	`addSearchParams(Map<String,Object> searchParams)` 添加一组查询参数
`Searchable`	`addSort(Sort.Direction direction, String property)`
`Searchable`	`addSort(Sort sort)`
`Searchable`	`and(SearchFilter first, SearchFilter... others)` 添加多个and连接的过滤条件
`boolean`	`containsSearchKey(String key)` 是否包含查询键如 name_like 包括 or 和 and的
`<T> Searchable`	`convert(Class<T> entityClass)` 把字符串类型的值转化为entity属性值
`Pagination`	`getPage()` 获取分页和排序信息
`Collection<SearchFilter>`	`getSearchFilters()` 获取查询过滤条件
`Object`	`getValue(String key)` 获取查询属性对应的值不能获取or 或 and 的
`boolean`	`hashSort()` 是否有排序
`boolean`	`hasPageable()` 是否有分页
`boolean`	`hasPagination()` 是否有分页
`boolean`	`hasSearchFilter()` 是否有查询参数
`boolean`	`isConverted()` 是否已经转换过了避免多次转换
`Searchable`	`markConverted()` 标识为已经转换过了避免多次转换
`Searchable`	`or(SearchFilter first, SearchFilter... others)` 添加多个or连接的过滤条件
`void`	`removePageable()`
`void`	`removePagination()`
`Searchable`	`removeSearchFilter(String key)` 移除指定key的过滤条件
`Searchable`	`removeSearchFilter(String searchProperty, SearchOperator operator)` 移除指定属性和操作符的过滤条件
`void`	`removeSort()`
`Searchable`	`setPage(int pageNumber, int pageSize)`
`Searchable`	`setPage(PageRequest page)`
`Searchable`	`setPage(Pagination page)`
`void`	`setSort(Sort sort)`
`String`	`toString()`

从类继承的方法 com.github.fartherp.framework.database.mybatis.plugin.search.vo.Searchable
newSearchable, newSearchable, newSearchable, newSearchable, newSearchable, setConverted

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

- 构造器详细资料
  - SearchRequest
```
public SearchRequest(Map<String,Object> searchParams)
```
  - SearchRequest
```
public SearchRequest()
```
  - SearchRequest
```
public SearchRequest(Map<String,Object> searchParams,
             PageRequest page)
```
  - SearchRequest
```
public SearchRequest(Map<String,Object> searchParams,
             Sort sort)
              throws SearchException
```
    抛出:
    
    SearchException
  - SearchRequest
```
public SearchRequest(Map<String,Object> searchParams,
             PageRequest page,
             Sort sort)
              throws SearchException
```
    根据查询参数拼Search
    查询参数格式：property_op=value 或 customerProperty=value
    customerProperty查找规则是：1、先查找domain的属性，2、如果找不到查找domain上的SearchPropertyMappings映射规则属性、操作符之间用_分割，op可省略/或custom，省略后值默认为custom，即程序中自定义
    如果op=custom，property也可以自定义（即可以与domain的不一样）,
    
    参数:
    searchParams - 查询参数组
    page - 分页
    sort - 排序
    
    抛出:
    
    SearchException
- 方法详细资料
  - removePageable
```
public void removePageable()
```
    指定者:
    
    removePageable 在类中 Searchable
  - addSearchParam
```
public Searchable addSearchParam(String key,
                        Object value)
                          throws SearchException
```
    从类复制的说明: Searchable
    
    添加过滤条件如key="parent.id_eq" value = 1 如果添加时不加操作符默认是custom 即如key=parent 实际key是parent_custom
    
    指定者:
    
    addSearchParam 在类中 Searchable
    
    参数:
    key - 如 name_like
    value - 如果是in查询多个值之间","分隔
    
    抛出:
    
    SearchException
  - addSearchParams
```
public Searchable addSearchParams(Map<String,Object> searchParams)
                           throws SearchException
```
    从类复制的说明: Searchable
    
    添加一组查询参数
    
    指定者:
    
    addSearchParams 在类中 Searchable
    
    抛出:
    
    SearchException
  - addSearchFilter
```
public Searchable addSearchFilter(String searchProperty,
                         SearchOperator operator,
                         Object value)
```
    从类复制的说明: Searchable
    
    添加过滤条件
    
    指定者:
    
    addSearchFilter 在类中 Searchable
    
    参数:
    searchProperty - 查询的属性名
    operator - 操作运算符
    value - 值
  - addSearchFilter
```
public Searchable addSearchFilter(SearchFilter searchFilter)
```
    指定者:
    
    addSearchFilter 在类中 Searchable
  - addSearchFilters
```
public Searchable addSearchFilters(Collection<? extends SearchFilter> searchFilters)
```
    从类复制的说明: Searchable
    
    添加多个and连接的过滤条件
    
    指定者:
    
    addSearchFilters 在类中 Searchable
    
    返回:
  - or
```
public Searchable or(SearchFilter first,
            SearchFilter... others)
```
    从类复制的说明: Searchable
    
    添加多个or连接的过滤条件
    
    指定者:
    
    or 在类中 Searchable
    
    参数:
    first - 第一个
    others - 其他
    
    返回:
  - and
```
public Searchable and(SearchFilter first,
             SearchFilter... others)
```
    从类复制的说明: Searchable
    
    添加多个and连接的过滤条件
    
    指定者:
    
    and 在类中 Searchable
  - removeSearchFilter
```
public Searchable removeSearchFilter(String searchProperty,
                            SearchOperator operator)
```
    从类复制的说明: Searchable
    
    移除指定属性和操作符的过滤条件
    
    指定者:
    
    removeSearchFilter 在类中 Searchable
  - removeSearchFilter
```
public Searchable removeSearchFilter(String key)
```
    从类复制的说明: Searchable
    
    移除指定key的过滤条件
    
    指定者:
    
    removeSearchFilter 在类中 Searchable
  - setPage
```
public Searchable setPage(PageRequest page)
```
  - setPage
```
public Searchable setPage(int pageNumber,
                 int pageSize)
```
    指定者:
    
    setPage 在类中 Searchable
    
    参数:
    pageNumber - 分页页码索引从 0 开始
    pageSize - 每页大小
  - addSort
```
public Searchable addSort(Sort sort)
```
    指定者:
    
    addSort 在类中 Searchable
  - addSort
```
public Searchable addSort(Sort.Direction direction,
                 String property)
```
    指定者:
    
    addSort 在类中 Searchable
  - convert
```
public <T> Searchable convert(Class<T> entityClass)
```
    从类复制的说明: Searchable
    
    把字符串类型的值转化为entity属性值
    
    指定者:
    
    convert 在类中 Searchable
  - markConverted
```
public Searchable markConverted()
```
    从类复制的说明: Searchable
    
    标识为已经转换过了避免多次转换
    
    指定者:
    
    markConverted 在类中 Searchable
  - setPage
```
public Searchable setPage(Pagination page)
```
    指定者:
    
    setPage 在类中 Searchable
  - getSearchFilters
```
public Collection<SearchFilter> getSearchFilters()
```
    从类复制的说明: Searchable
    
    获取查询过滤条件
    
    指定者:
    
    getSearchFilters 在类中 Searchable
  - isConverted
```
public boolean isConverted()
```
    从类复制的说明: Searchable
    
    是否已经转换过了避免多次转换
    
    指定者:
    
    isConverted 在类中 Searchable
  - hasSearchFilter
```
public boolean hasSearchFilter()
```
    从类复制的说明: Searchable
    
    是否有查询参数
    
    指定者:
    
    hasSearchFilter 在类中 Searchable
  - hashSort
```
public boolean hashSort()
```
    从类复制的说明: Searchable
    
    是否有排序
    
    指定者:
    
    hashSort 在类中 Searchable
  - removeSort
```
public void removeSort()
```
    指定者:
    
    removeSort 在类中 Searchable
  - hasPagination
```
public boolean hasPagination()
```
    从类复制的说明: Searchable
    
    是否有分页
    
    指定者:
    
    hasPagination 在类中 Searchable
  - removePagination
```
public void removePagination()
```
    指定者:
    
    removePagination 在类中 Searchable
  - getPage
```
public Pagination getPage()
```
    从类复制的说明: Searchable
    
    获取分页和排序信息
    
    指定者:
    
    getPage 在类中 Searchable
  - containsSearchKey
```
public boolean containsSearchKey(String key)
```
    从类复制的说明: Searchable
    
    是否包含查询键如 name_like 包括 or 和 and的
    
    指定者:
    
    containsSearchKey 在类中 Searchable
  - hasPageable
```
public boolean hasPageable()
```
    从类复制的说明: Searchable
    
    是否有分页
    
    指定者:
    
    hasPageable 在类中 Searchable
  - getValue
```
public Object getValue(String key)
```
    从类复制的说明: Searchable
    
    获取查询属性对应的值不能获取or 或 and 的
    
    指定者:
    
    getValue 在类中 Searchable
  - setSort
```
public void setSort(Sort sort)
```
    覆盖:
    
    setSort 在类中 Searchable
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 SearchRequest

字段概要

从类继承的字段 com.github.fartherp.framework.database.mybatis.plugin.search.vo.Searchable

构造器概要

方法概要

从类继承的方法 com.github.fartherp.framework.database.mybatis.plugin.search.vo.Searchable

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

构造器详细资料

SearchRequest

SearchRequest

SearchRequest

SearchRequest

SearchRequest

方法详细资料

removePageable

addSearchParam

addSearchParams

addSearchFilter

addSearchFilter

addSearchFilters

or

and

removeSearchFilter

removeSearchFilter

setPage

setPage

addSort

addSort

convert

markConverted

setPage

getSearchFilters

isConverted

hasSearchFilter

hashSort

removeSort

hasPagination

removePagination

getPage

containsSearchKey

hasPageable

getValue

setSort

toString