Query (easymybatis 2.0.1 API)

java.lang.Object
- net.oschina.durcframework.easymybatis.query.Query

所有已实现的接口:: Expressional, Pageable, Queryable, Sortable

直接已知子类:: ProjectionQuery

public class Query
extends Object
implements Queryable

查询类

根据主键查询：
User user = dao.get(1);

查询姓名为张三的用户：
User user = dao.getByProperty("username","张三");

查询姓名为张三的用户返回列表:
List users = dao.listByProperty("username","张三");

查询姓名为张三，并且年龄为22岁的用户：
Query query = new Query().eq("username","张三").eq("age",22);
List users = dao.find(query);

查询年龄为10,20,30的用户：
Query query = new Query().in("age",Arrays.asList(10,20,30));
List users = dao.find(query);

查询注册日期大于2017-11-11的用户：
Date regDate = ...
Query query = new Query().gt("reg_date",regDate);
List users = dao.find(query);

查询性别为男的，年龄大于等于20岁的用户，按年龄降序：
Query query = new Query().eq("gender",1).ge("age",20).orderby("age",Sort.DESC);
List users = dao.find(query);

分页查询：
Query query = new Query().eq("age",10).page(1,10); // 第一页，每页10条数据
List users = dao.find(query);

查询总记录数：
Query query = new Query().eq("age",10).page(1,10); // 第一页，每页10条数据
long total = dao.countTotal(query); // 该条件下总记录数

作者:: tanghc

构造器概要

构造器
构造器和说明

Query()

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

方法概要

方法
限定符和类型	方法和说明
`void`	`addAll(List<Expression> expressions)`
`Query`	`addAnnotionExpression(Object searchEntity)` 添加注解查询条件
`Expressional`	`addExpression(Expression expression)`
`Query`	`addOtherColumn(String column)` 添加其它表的字段 query.addOtherColumn("t2.username as name");
`Query`	`addOtherColumns(String... columns)` 批量添加其它字段.
`Query`	`addPaginationInfo(SchPageableParam searchEntity)` 添加分页信息
`Query`	`addParam(String name, Object value)` 添加额外参数
`Query`	`addSort(String sortname)` 添加ASC排序字段,
`Query`	`addSort(String sortname, Sort sort)` 字段排序
`Query`	`addSortInfo(SchSortableParam searchEntity)` 添加排序信息
`Query`	`allEq(LinkedHashMap<String,Object> map)` 使用key/value进行多个等于的比对,相当于多个eq的效果
`static Query`	`build()`
`static Query`	`build(Object searchEntity)` 构建查询条件.
`static Query`	`buildFromBeanByProperty(Object bean)` 将bean中的字段转换成条件,不会将字段名转换成下划线形式.
`static Query`	`buildQueryAll()` 构建查询全部的表达式对象
`Query`	`eq(String columnName, Object value)` 添加等于条件
`Query`	`ge(String columnName, Object value)` 大于等于,>=
`List<String>`	`getColumns()`
`int`	`getFirstResult()` 同getStart()
`boolean`	`getIsQueryAll()`
`List<ExpressionJoinable>`	`getJoinExpressions()`
`int`	`getLimit()`
`List<ExpressionListable>`	`getListExpressions()`
`String`	`getOrder()` 返回排序信息
`boolean`	`getOrderable()` 是否具备排序,是返回true
`List<String>`	`getOtherTableColumns()`
`int`	`getPageSize()` 同getLimit()
`Map<String,Object>`	`getParam()`
`List<ExpressionSqlable>`	`getSqlExpressions()`
`int`	`getStart()`
`List<ExpressionValueable>`	`getValueExpressions()`
`Query`	`gt(String columnName, Object value)` 添加大于条件,>
`Query`	`in(String columnName, Collection<?> value)` 添加IN条件
`<T> Query`	`in(String columnName, Collection<T> value, ValueConvert<T> valueConvert)` 添加IN条件
`Query`	`in(String columnName, Object[] value)` 添加IN条件
`Query`	`isEmpty(String column)` 空字段条件，null或者空字符串
`Query`	`isNull(String column)` 字段是null的条件
`Query`	`join(String joinSql)` 添加关联条件
`Query`	`le(String columnName, Object value)` 小于等于,<=
`Query`	`like(String columnName, Object value)` 添加模糊查询条件
`Query`	`limit(int start, int offset)` 设置分页信息,针对不规则分页。
`Query`	`lt(String columnName, Object value)` 添加小于条件,<
`Query`	`notEmpty(String column)` 不为空字符串
`Query`	`notEq()` 不等于条件
`Query`	`notEq(String columnName, Object value)` 添加不等于条件
`Query`	`notIn(String columnName, Collection<?> value)` 添加not in条件
`<T> Query`	`notIn(String columnName, Collection<T> value, ValueConvert<T> valueConvert)` 添加not in条件
`Query`	`notIn(String columnName, Object[] value)` 添加not in条件
`Query`	`notNull(String column)` 字段不为null的条件
`Query`	`orderby(String sortname, Sort sort)` 字段排序
`Query`	`page(int pageIndex, int pageSize)` 设置分页信息
`void`	`setColumns(List<String> columns)`
`Query`	`setQueryAll(boolean queryAll)` 查询全部
`Query`	`sql(String sql)` 添加自定义sql条件

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

- 构造器详细资料
  - Query
```
public Query()
```
- 方法详细资料
  - buildFromBeanByProperty
```
public static Query buildFromBeanByProperty(Object bean)
```
    将bean中的字段转换成条件,不会将字段名转换成下划线形式.
```
 User user = new User();
 user.setUserName("jim");
 Query query = Query.buildFromBeanByProperty(user);
 
 这样会组装成一个条件:where userName='jim'
 更多功能可查看开发文档.
 
```
    参数:
    bean -
    
    返回:
  - build
```
public static Query build()
```
  - addOtherColumn
```
public Query addOtherColumn(String column)
```
    添加其它表的字段 query.addOtherColumn("t2.username as name");
    
    参数:
    column -
    
    返回:
  - addOtherColumns
```
public Query addOtherColumns(String... columns)
```
    批量添加其它字段. query.addOtherColumns( "t2.username" ,"t2.userage as age" )
    
    参数:
    columns -
    
    返回:
  - getOtherTableColumns
```
public List<String> getOtherTableColumns()
```
    指定者:
    
    getOtherTableColumns 在接口中 Queryable
  - page
```
public Query page(int pageIndex,
         int pageSize)
```
    设置分页信息
    
    参数:
    pageIndex - 当前第几页,从1开始
    pageSize - 每页结果集大小
    
    返回:
    返回自身对象
  - limit
```
public Query limit(int start,
          int offset)
```
    设置分页信息,针对不规则分页。对应mysql分页语句：limit {start},{offset}
    
    参数:
    start - 记录起始位置
    offset - 偏移量
    
    返回:
    返回自身对象
  - getStart
```
public int getStart()
```
    指定者:
    
    getStart 在接口中 Pageable
  - getLimit
```
public int getLimit()
```
    指定者:
    
    getLimit 在接口中 Pageable
  - getFirstResult
```
public int getFirstResult()
```
    同getStart()
    
    返回:
  - getPageSize
```
public int getPageSize()
```
    同getLimit()
    
    返回:
  - buildQueryAll
```
public static Query buildQueryAll()
```
    构建查询全部的表达式对象
    
    返回:
  - addAnnotionExpression
```
public Query addAnnotionExpression(Object searchEntity)
```
    添加注解查询条件
    
    参数:
    searchEntity -
    
    返回:
    返回自身对象
  - addPaginationInfo
```
public Query addPaginationInfo(SchPageableParam searchEntity)
```
    添加分页信息
  - addSortInfo
```
public Query addSortInfo(SchSortableParam searchEntity)
```
    添加排序信息
    
    参数:
    searchEntity -
    
    返回:
    返回自身对象
  - build
```
public static Query build(Object searchEntity)
```
    构建查询条件.
    
    参数:
    searchEntity -
    
    返回:
  - addExpression
```
public Expressional addExpression(Expression expression)
```
    指定者:
    
    addExpression 在接口中 Expressional
  - addAll
```
public void addAll(List<Expression> expressions)
```
  - addParam
```
public Query addParam(String name,
             Object value)
```
    添加额外参数
    
    参数:
    name -
    value -
    
    返回:
    返回自身对象
  - getParam
```
public Map<String,Object> getParam()
```
    指定者:
    
    getParam 在接口中 Queryable
  - getIsQueryAll
```
public boolean getIsQueryAll()
```
    指定者:
    
    getIsQueryAll 在接口中 Pageable
  - setQueryAll
```
public Query setQueryAll(boolean queryAll)
```
    查询全部
    
    参数:
    queryAll - true，则查询全部
    
    返回:
    返回自身对象
  - getValueExpressions
```
public List<ExpressionValueable> getValueExpressions()
```
    指定者:
    
    getValueExpressions 在接口中 Expressional
  - getJoinExpressions
```
public List<ExpressionJoinable> getJoinExpressions()
```
    指定者:
    
    getJoinExpressions 在接口中 Expressional
  - getListExpressions
```
public List<ExpressionListable> getListExpressions()
```
    指定者:
    
    getListExpressions 在接口中 Expressional
  - getSqlExpressions
```
public List<ExpressionSqlable> getSqlExpressions()
```
    指定者:
    
    getSqlExpressions 在接口中 Expressional
  - orderby
```
public Query orderby(String sortname,
            Sort sort)
```
    字段排序
    
    参数:
    sortname - 数据库字段名
    sort - 排序类型
    
    返回:
  - addSort
```
public Query addSort(String sortname)
```
    添加ASC排序字段,
    
    参数:
    sortname - 数据库字段名
    
    返回:
    返回自身对象
  - addSort
```
public Query addSort(String sortname,
            Sort sort)
```
    字段排序
    
    参数:
    sortname - 数据库字段名
    sort - 排序类型
    
    返回:
  - getOrderable
```
public boolean getOrderable()
```
    从接口复制的说明: Sortable
    
    是否具备排序,是返回true
    
    指定者:
    
    getOrderable 在接口中 Sortable
    
    返回:
  - getOrder
```
public String getOrder()
```
    从接口复制的说明: Sortable
    
    返回排序信息
    
    指定者:
    
    getOrder 在接口中 Sortable
    
    返回:
    返回排序信息,如:id ASC,name ASC,date desc. 没有排序则返回""
  - getColumns
```
public List<String> getColumns()
```
    指定者:
    
    getColumns 在接口中 Queryable
  - setColumns
```
public void setColumns(List<String> columns)
```
  - join
```
public Query join(String joinSql)
```
    添加关联条件
    
    参数:
    joinSql -
    
    返回:
  - allEq
```
public Query allEq(LinkedHashMap<String,Object> map)
```
    使用key/value进行多个等于的比对,相当于多个eq的效果
    
    参数:
    map -
    
    返回:
  - eq
```
public Query eq(String columnName,
       Object value)
```
    添加等于条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - notEq
```
public Query notEq(String columnName,
          Object value)
```
    添加不等于条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - gt
```
public Query gt(String columnName,
       Object value)
```
    添加大于条件,>
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - ge
```
public Query ge(String columnName,
       Object value)
```
    大于等于,>=
    
    参数:
    columnName -
    value -
    
    返回:
    返回自身对象
  - lt
```
public Query lt(String columnName,
       Object value)
```
    添加小于条件,<
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - le
```
public Query le(String columnName,
       Object value)
```
    小于等于,<=
    
    参数:
    columnName -
    value -
    
    返回:
    返回自身对象
  - like
```
public Query like(String columnName,
         Object value)
```
    添加模糊查询条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - in
```
public Query in(String columnName,
       Collection<?> value)
```
    添加IN条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - in
```
public <T> Query in(String columnName,
           Collection<T> value,
           ValueConvert<T> valueConvert)
```
    添加IN条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - in
```
public Query in(String columnName,
       Object[] value)
```
    添加IN条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - notIn
```
public Query notIn(String columnName,
          Collection<?> value)
```
    添加not in条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - notIn
```
public <T> Query notIn(String columnName,
              Collection<T> value,
              ValueConvert<T> valueConvert)
```
    添加not in条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - notIn
```
public Query notIn(String columnName,
          Object[] value)
```
    添加not in条件
    
    参数:
    columnName - 数据库字段名
    value - 值
    
    返回:
    返回自身对象
  - sql
```
public Query sql(String sql)
```
    添加自定义sql条件
    
    参数:
    sql - 自定义sql
    
    返回:
    返回自身对象
  - notNull
```
public Query notNull(String column)
```
    字段不为null的条件
    
    参数:
    column - 数据库字段名
    
    返回:
    返回自身对象
  - isNull
```
public Query isNull(String column)
```
    字段是null的条件
    
    参数:
    column - 数据库字段名
    
    返回:
    返回自身对象
  - notEmpty
```
public Query notEmpty(String column)
```
    不为空字符串
    
    参数:
    column - 数据库字段名
    
    返回:
    返回自身对象
  - isEmpty
```
public Query isEmpty(String column)
```
    空字段条件，null或者空字符串
    
    参数:
    column - 数据库字段名
    
    返回:
    返回自身对象
  - notEq
```
public Query notEq()
```
    不等于条件
    
    返回:
    返回自身对象

类 Query

构造器概要

方法概要

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

构造器详细资料

Query

方法详细资料

buildFromBeanByProperty

build

addOtherColumn

addOtherColumns

getOtherTableColumns

page

limit

getStart

getLimit

getFirstResult

getPageSize

buildQueryAll

addAnnotionExpression

addPaginationInfo

addSortInfo

build

addExpression

addAll

addParam

getParam

getIsQueryAll

setQueryAll

getValueExpressions

getJoinExpressions

getListExpressions

getSqlExpressions

orderby

addSort

addSort

getOrderable

getOrder

getColumns

setColumns

join

allEq

eq

notEq

gt

ge

lt

le

like

in

in

in

notIn

notIn

notIn

sql

notNull

isNull

notEmpty

isEmpty

notEq