com.github.fartherp.framework.database.mybatis.plugin.search.vo

类 Searchable

java.lang.Object

com.github.fartherp.framework.database.mybatis.plugin.search.vo.Searchable

直接已知子类:

SearchRequest

public abstract class Searchable
extends Object

查询条件接口

User: hyssop

Date: 16-1-16 上午8:47

Version: 1.0

字段概要

字段

限定符和类型	字段和说明
boolean	converted
PageRequest	page
Sort	sort

构造器概要

构造器

构造器和说明
Searchable()

方法概要

方法

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

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

page

public PageRequest page

converted

public boolean converted

sort

public Sort sort

构造器详细资料

Searchable

public Searchable()

方法详细资料

newSearchable

public static Searchable newSearchable()

创建一个新的查询

setConverted

public void setConverted(boolean converted)

setSort

public void setSort(Sort sort)

newSearchable

public static Searchable newSearchable(Map<String,Object> searchParams)
                                throws SearchException

创建一个新的查询

抛出:

SearchException

newSearchable

public static Searchable newSearchable(Map<String,Object> searchParams,
                       PageRequest page)
                                throws SearchException

创建一个新的查询

抛出:

SearchException

newSearchable

public static Searchable newSearchable(Map<String,Object> searchParams,
                       Sort sort)
                                throws SearchException

创建一个新的查询

抛出:

SearchException

newSearchable

public static Searchable newSearchable(Map<String,Object> searchParams,
                       PageRequest page,
                       Sort sort)

创建一个新的查询

removePageable

public abstract void removePageable()

addSearchParam

public abstract Searchable addSearchParam(String key,
                        Object value)
                                   throws SearchException

添加过滤条件 如key="parent.id_eq" value = 1 如果添加时不加操作符 默认是custom 即如key=parent 实际key是parent_custom

参数:

key - 如 name_like

value - 如果是in查询 多个值之间","分隔

抛出:

SearchException

addSearchParams

public abstract Searchable addSearchParams(Map<String,Object> searchParams)
                                    throws SearchException

添加一组查询参数

参数:

searchParams -

抛出:

SearchException

addSearchFilter

public abstract Searchable addSearchFilter(String searchProperty,
                         SearchOperator operator,
                         Object value)
                                    throws SearchException

添加过滤条件

参数:

searchProperty - 查询的属性名

operator - 操作运算符

value - 值

抛出:

SearchException

addSearchFilter

public abstract Searchable addSearchFilter(SearchFilter searchFilter)

addSearchFilters

public abstract Searchable addSearchFilters(Collection<? extends SearchFilter> searchFilters)

添加多个and连接的过滤条件

参数:

searchFilters -

返回:

or

public abstract Searchable or(SearchFilter first,
            SearchFilter... others)

添加多个or连接的过滤条件

参数:

first - 第一个

others - 其他

返回:

and

public abstract Searchable and(SearchFilter first,
             SearchFilter... others)

添加多个and连接的过滤条件

参数:

first -

others -

removeSearchFilter

public abstract Searchable removeSearchFilter(String key)

移除指定key的过滤条件

removeSearchFilter

public abstract Searchable removeSearchFilter(String searchProperty,
                            SearchOperator operator)

移除指定属性 和 操作符的过滤条件

convert

public abstract <T> Searchable convert(Class<T> entityClass)

把字符串类型的值转化为entity属性值

markConverted

public abstract Searchable markConverted()

标识为已经转换过了 避免多次转换

setPage

public abstract Searchable setPage(Pagination page)

setPage

public abstract Searchable setPage(int pageNumber,
                 int pageSize)

参数:

pageNumber - 分页页码 索引从 0 开始

pageSize - 每页大小

addSort

public abstract Searchable addSort(Sort sort)

addSort

public abstract Searchable addSort(Sort.Direction direction,
                 String property)

getSearchFilters

public abstract Collection<SearchFilter> getSearchFilters()

获取查询过滤条件

isConverted

public abstract boolean isConverted()

是否已经转换过了 避免多次转换

hasSearchFilter

public abstract boolean hasSearchFilter()

是否有查询参数

hashSort

public abstract boolean hashSort()

是否有排序

removeSort

public abstract void removeSort()

hasPagination

public abstract boolean hasPagination()

是否有分页

removePagination

public abstract void removePagination()

getPage

public abstract Pagination getPage()

获取分页和排序信息

containsSearchKey

public abstract boolean containsSearchKey(String key)

是否包含查询键 如 name_like 包括 or 和 and的

getValue

public abstract <T> T getValue(String key)

获取查询属性对应的值 不能获取or 或 and 的

hasPageable

public abstract boolean hasPageable()

是否有分页