JBQuery (JavaBaas_SDK_Java 2.0.17 API)

java.lang.Object
- com.javabaas.javasdk.JBQuery<T>

直接已知子类:

JBPush.JBPushQuery
```
public class JBQuery<T extends JBObject>
extends Object
```
查询相关 Created by zangyilin on 2017/8/9.

构造器概要

构造器
构造器和说明

JBQuery(String className)

构造器
构造器和说明
`JBQuery(String className)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`JBQuery<T>`	`addAscendingOrder(String key)` 添加正序排序字段不会删除之前设置的排序方式
`JBQuery<T>`	`addDescendingOrder(String key)` 添加倒叙排序字段不会删除之前设置的排序方式
`protected JBQuery<T>`	`addWhereItem(String key, String op, Object value)`
`protected Map<String,String>`	`assembleParameters()`
`int`	`count()` 统计查询同步
`void`	`countInBackground(JBCountCallback callback)` 统计查询异步
`static JBQuery`	`createQuery(JBObject object)`
`void`	`deleteByQuery()` 批量删除同步
`void`	`deleteByQueryInBackground()` 批量删除异步
`void`	`deleteByQueryInBackground(JBBooleanCallback callback)`
`List<T>`	`find()` 查询同步
`void`	`findInBackground(JBFindCallBack<T> callBack)` 查询异步
`T`	`get(String objectId)` 根据objectId查询对象同步
`String`	`getClassName()` 获取当前query对应的主体类类名
`Class<T>`	`getClazz()`
`void`	`getInBackground(String objectId, JBGetCallback<T> callback)` 根据objectId查询对象异步
`List<String>`	`getInclude()`
`int`	`getLimit()`
`LinkedHashMap<String,Integer>`	`getOrder()`
`Map<String,String>`	`getParameters()`
`static <T extends JBObject> JBQuery<T>`	`getQuery(String className)`
`Boolean`	`getRunning()` 查询当前查询是否进行中
`Set<String>`	`getSelectedKeys()`
`int`	`getSkip()`
`Map<String,List<JBQueryOperation>>`	`getWhere()`
`String`	`getWhereSting()` 这个只是针对传递过来json字符串，对于JBQueryConditions的where不适用
`JBQuery<T>`	`include(String key)` 添加include的内容如果查询的字段是Pointer类型,通过设置include可以将Pointer字段的详细信息查询出来.
`JBQuery<T>`	`limit(int limit)` 设置查询返回文档数据的最大条数 limit取值为1-1000 不设置默认为100
`JBQuery<T>`	`order(LinkedHashMap<String,Integer> order)` 设置查询排序方式
`JBQuery<T>`	`orderByAscending(String key)` 设置正序排序字段会把之前设置的排序方式删除
`JBQuery<T>`	`orderByDescending(String key)` 设置倒叙排序字段会把之前设置的排序方式删除
`protected List<T>`	`processResults(Map<String,Object> map)`
`JBQuery<T>`	`selectKeys(Collection<String> keys)` 添加待查询字段
`JBQuery<T>`	`setClassName(String className)`
`void`	`setClazz(Class<T> clazz)`
`void`	`setInclude(List<String> include)` 添加include的内容如果查询的字段是Pointer类型,通过设置include可以将Pointer字段的详细信息查询出来.
`JBQuery<T>`	`setLimit(int limit)` 设置查询返回文档数据的最大条数 limit取值为1-1000 不设置默认为100
`JBQuery<T>`	`setOrder(LinkedHashMap<String,Integer> order)` 设置查询排序方式
`void`	`setParameters(Map<String,String> parameters)`
`void`	`setRunning(Boolean running)`
`void`	`setSelectedKeys(Set<String> selectedKeys)` 设置需要查询的字段
`JBQuery<T>`	`setSkip(int skip)` 设置查询文档数据结果返回跳过的文档数目
`void`	`setWhereSting(String whereSting)` 这个会把其他where条件全部替换
`JBQuery<T>`	`skip(int skip)` 设置查询文档数据结果返回跳过的文档数目
`JBQuery<T>`	`whereContainedIn(String key, Collection<? extends Object> values)` 查询字段值在集合中 "$in"
`JBQuery<T>`	`whereContains(String key, String substring)` 查询字段值包含某个字符串 ".
`JBQuery<T>`	`whereEndWith(String key, String suffix)` 查询字段以字符串结束 ".
`JBQuery<T>`	`whereEqualTo(String key, Object value)` 查询字段值等于
`JBQuery<T>`	`whereExists(String key)` 查询字段不为空 "$exists":true
`JBQuery<T>`	`whereGreaterThan(String key, Object value)` 查询字段值大于 "$gt"
`JBQuery<T>`	`whereGreaterThanOrEqualTo(String key, Object value)` 查询字段值大于等于 "$gte"
`JBQuery<T>`	`whereLessThan(String key, Object value)` 查询字段值小于 "$lt"
`JBQuery<T>`	`whereLessThanOrEqualTo(String key, Object value)` 查询字段值小于等于 "$lte"
`JBQuery<T>`	`whereMatches(String key, String regex)` 查询字段匹配正则 "$regex"
`JBQuery<T>`	`whereMatches(String key, String regex, String modifiers)` 查询字段匹配正则 "$regex" "$options"
`JBQuery<T>`	`whereMatchesKeyInQuery(String key, String searchKey, JBQuery<?> query, String targetClass)` 查询字段匹配子查询查询的字段
`JBQuery<T>`	`whereMatchesQuery(String key, JBQuery<?> query)` 查询字段匹配子查询
`JBQuery<T>`	`whereNotContainedIn(String key, Collection<? extends Object> values)` 查询字段值不在集合中 "$nin"
`JBQuery<T>`	`whereNotEqualTo(String key, Object value)` 查询字段值不等于 "$ne"
`JBQuery<T>`	`whereNotExist(String key)` 查询字段为空 "$exists":false
`JBQuery<T>`	`whereStartWith(String key, String prefix)` 查询字段以字符串开始 "^%s
`JBQuery<T>`	`whereWithinKilometers(String key, JBGeoPoint point, double maxDistance)` 查询附近X距离（单位米）内的数据

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

- 构造器详细资料
  - JBQuery
```
public JBQuery(String className)
```
- 方法详细资料
  - getClassName
```
public String getClassName()
```
    获取当前query对应的主体类类名
    
    返回:
    
    类名
  - setClassName
```
public JBQuery<T> setClassName(String className)
```
  - getClazz
```
public Class<T> getClazz()
```
  - setClazz
```
public void setClazz(Class<T> clazz)
```
  - getRunning
```
public Boolean getRunning()
```
    查询当前查询是否进行中
    
    返回:
    
    结果
  - setRunning
```
public void setRunning(Boolean running)
```
  - getInclude
```
public List<String> getInclude()
```
  - setInclude
```
public void setInclude(List<String> include)
```
    添加include的内容
    
    如果查询的字段是Pointer类型,通过设置include可以将Pointer字段的详细信息查询出来.
    例如有个字段为sound,音频,是Pointer类型,对应的class是Sound,则查询该字段的详细信息可以添加"sound"到include中.
    如果Sound还有有个字段为user,是Pointer类型,对应的class是_User,
    则查询sound字段对应的详细信息中的user字段的详细信息,可以添加"sound.user"到include中.
    
    pointer字段的层级通过"."来分隔,例如"a.b.c",表示当前查询的主体类中有Pointer字段a,a对应的类中有Pointer字段b,b对应的Pointer字段c
    本次查询需要三个层级的查询,一直把c的详细信息查询出来.
    
    需要注意的是,系统默认会把"a.b.c"对应的所有层级的信息查询出来,不能只想要a和b的Pointer信息和c的详细信息.
    同时,当你需要查询a,b,c三个层级的信息时,只需要设置一个"a.b.c"到include中即可,不必同时设置{"a","a.b","a.b.c"}
    
    参数:
    
    include -
  - getSelectedKeys
```
public Set<String> getSelectedKeys()
```
  - setSelectedKeys
```
public void setSelectedKeys(Set<String> selectedKeys)
```
    设置需要查询的字段
    
    参数:
    
    selectedKeys - 字段集合
  - getWhereSting
```
public String getWhereSting()
```
    这个只是针对传递过来json字符串，对于JBQueryConditions的where不适用
    
    返回:
    
    string
  - setWhereSting
```
public void setWhereSting(String whereSting)
```
    这个会把其他where条件全部替换
    
    参数:
    
    whereSting - 查询语句
  - getParameters
```
public Map<String,String> getParameters()
```
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
  - getWhere
```
public Map<String,List<JBQueryOperation>> getWhere()
```
  - createQuery
```
public static JBQuery createQuery(JBObject object)
```
  - getQuery
```
public static <T extends JBObject> JBQuery<T> getQuery(String className)
```
  - getLimit
```
public int getLimit()
```
  - setLimit
```
public JBQuery<T> setLimit(int limit)
```
    设置查询返回文档数据的最大条数
    limit取值为1-1000
    不设置默认为100
    
    参数:
    
    limit - limit值
    
    返回:
    
    query
  - limit
```
public JBQuery<T> limit(int limit)
```
    设置查询返回文档数据的最大条数
    limit取值为1-1000
    不设置默认为100
    
    参数:
    
    limit - limit值
    
    返回:
    
    query
  - getSkip
```
public int getSkip()
```
  - setSkip
```
public JBQuery<T> setSkip(int skip)
```
    设置查询文档数据结果返回跳过的文档数目
    
    参数:
    
    skip - skip值
    
    返回:
    
    query
  - skip
```
public JBQuery<T> skip(int skip)
```
    设置查询文档数据结果返回跳过的文档数目
    
    参数:
    
    skip - skip值
    
    返回:
    
    query
  - getOrder
```
public LinkedHashMap<String,Integer> getOrder()
```
  - setOrder
```
public JBQuery<T> setOrder(LinkedHashMap<String,Integer> order)
```
    设置查询排序方式
    
    参数:
    
    order - 排序方式
    
    返回:
    
    query
  - order
```
public JBQuery<T> order(LinkedHashMap<String,Integer> order)
```
    设置查询排序方式
    
    参数:
    
    order - 排序方式
    
    返回:
    
    query
  - include
```
public JBQuery<T> include(String key)
```
    添加include的内容
    
    如果查询的字段是Pointer类型,通过设置include可以将Pointer字段的详细信息查询出来.
    例如有个字段为sound,音频,是Pointer类型,对应的class是Sound,则查询该字段的详细信息可以添加"sound"到include中.
    如果Sound还有有个字段为user,是Pointer类型,对应的class是_User,
    则查询sound字段对应的详细信息中的user字段的详细信息,可以添加"sound.user"到include中.
    
    pointer字段的层级通过"."来分隔,例如"a.b.c",表示当前查询的主体类中有Pointer字段a,a对应的类中有Pointer字段b,b对应的Pointer字段c
    本次查询需要三个层级的查询,一直把c的详细信息查询出来.
    
    需要注意的是,系统默认会把"a.b.c"对应的所有层级的信息查询出来,不能只想要a和b的Pointer信息和c的详细信息.
    同时,当你需要查询a,b,c三个层级的信息时,只需要设置一个"a.b.c"到include中即可,不必分别设置"a","a.b","a.b.c"
    
    参数:
    
    key - key值
    
    返回:
    
    query
  - addAscendingOrder
```
public JBQuery<T> addAscendingOrder(String key)
```
    添加正序排序字段
    不会删除之前设置的排序方式
    
    参数:
    
    key - 排序字段
    
    返回:
    
    query
  - addDescendingOrder
```
public JBQuery<T> addDescendingOrder(String key)
```
    添加倒叙排序字段
    不会删除之前设置的排序方式
    
    参数:
    
    key - 排序字段
    
    返回:
    
    query
  - selectKeys
```
public JBQuery<T> selectKeys(Collection<String> keys)
```
    添加待查询字段
    
    参数:
    
    keys - 待查询字段
    
    返回:
    
    query
  - orderByAscending
```
public JBQuery<T> orderByAscending(String key)
```
    设置正序排序字段会把之前设置的排序方式删除
    
    参数:
    
    key - 排序字段
    
    返回:
    
    query
  - orderByDescending
```
public JBQuery<T> orderByDescending(String key)
```
    设置倒叙排序字段
    会把之前设置的排序方式删除
    
    参数:
    
    key - 排序字段
    
    返回:
    
    query
  - whereExists
```
public JBQuery<T> whereExists(String key)
```
    查询字段不为空
    "$exists":true
    
    参数:
    
    key - 待查询字段
    
    返回:
    
    query
  - whereNotExist
```
public JBQuery<T> whereNotExist(String key)
```
    查询字段为空
    "$exists":false
    
    参数:
    
    key - 待查询字段
    
    返回:
    
    query
  - whereEqualTo
```
public JBQuery<T> whereEqualTo(String key,
                               Object value)
```
    查询字段值等于
    
    参数:
    
    key - 待查询字段
    
    value - 待比较值
    
    返回:
    
    query
  - whereNotEqualTo
```
public JBQuery<T> whereNotEqualTo(String key,
                                  Object value)
```
    查询字段值不等于
    "$ne"
    
    参数:
    
    key - 待查询字段
    
    value - 待比较值
    
    返回:
    
    query
  - whereGreaterThanOrEqualTo
```
public JBQuery<T> whereGreaterThanOrEqualTo(String key,
                                            Object value)
```
    查询字段值大于等于
    "$gte"
    
    参数:
    
    key - 待查询字段
    
    value - 待比较值
    
    返回:
    
    query
  - whereGreaterThan
```
public JBQuery<T> whereGreaterThan(String key,
                                   Object value)
```
    查询字段值大于
    "$gt"
    
    参数:
    
    key - 待查询字段
    
    value - 待比较值
    
    返回:
    
    query
  - whereLessThan
```
public JBQuery<T> whereLessThan(String key,
                                Object value)
```
    查询字段值小于
    "$lt"
    
    参数:
    
    key - 待查询字段
    
    value - 待比较值
    
    返回:
    
    query
  - whereLessThanOrEqualTo
```
public JBQuery<T> whereLessThanOrEqualTo(String key,
                                         Object value)
```
    查询字段值小于等于
    "$lte"
    
    参数:
    
    key - 待查询字段
    
    value - 待比较值
    
    返回:
    
    query
  - whereContains
```
public JBQuery<T> whereContains(String key,
                                String substring)
```
    查询字段值包含某个字符串
    ".*%s.*"
    
    参数:
    
    key - 待查询字段
    
    substring - 字符串
    
    返回:
    
    query
  - whereContainedIn
```
public JBQuery<T> whereContainedIn(String key,
                                   Collection<? extends Object> values)
```
    查询字段值在集合中
    "$in"
    
    参数:
    
    key - 待查询字段
    
    values - 集合
    
    返回:
    
    query
  - whereNotContainedIn
```
public JBQuery<T> whereNotContainedIn(String key,
                                      Collection<? extends Object> values)
```
    查询字段值不在集合中
    "$nin"
    
    参数:
    
    key - 待查询字段
    
    values - 集合
    
    返回:
    
    query
  - whereStartWith
```
public JBQuery<T> whereStartWith(String key,
                                 String prefix)
```
    查询字段以字符串开始
    "^%s.*"
    
    参数:
    
    key - 待查询字段
    
    prefix - 待比较字符串
    
    返回:
    
    query
  - whereEndWith
```
public JBQuery<T> whereEndWith(String key,
                               String suffix)
```
    查询字段以字符串结束
    ".*%s$"
    
    参数:
    
    key - 待查询字段
    
    suffix - 待比较字符串
    
    返回:
    
    query
  - whereWithinKilometers
```
public JBQuery<T> whereWithinKilometers(String key,
                                        JBGeoPoint point,
                                        double maxDistance)
```
    查询附近X距离（单位米）内的数据
    
    参数:
    
    key - key
    
    point - 中心位置
    
    maxDistance - 最大半径单位米
    
    返回:
    
    结果
  - whereMatches
```
public JBQuery<T> whereMatches(String key,
                               String regex)
```
    查询字段匹配正则
    "$regex"
    
    参数:
    
    key - 待查询字段
    
    regex - 正则表达式
    
    返回:
    
    query
  - whereMatches
```
public JBQuery<T> whereMatches(String key,
                               String regex,
                               String modifiers)
```
    查询字段匹配正则
    "$regex"
    "$options"
    
    参数:
    
    key - 待查询字段
    
    regex - 正则表达式
    
    modifiers - 参数
    
    返回:
    
    query
  - addWhereItem
```
protected JBQuery<T> addWhereItem(String key,
                                  String op,
                                  Object value)
```
  - whereMatchesQuery
```
public JBQuery<T> whereMatchesQuery(String key,
                                    JBQuery<?> query)
```
    查询字段匹配子查询
    
    参数:
    
    key - 待查询字段
    
    query - 子查询
    
    返回:
    
    query
  - whereMatchesKeyInQuery
```
public JBQuery<T> whereMatchesKeyInQuery(String key,
                                         String searchKey,
                                         JBQuery<?> query,
                                         String targetClass)
```
    查询字段匹配子查询查询的字段
    
    参数:
    
    key - 待查询字段
    
    searchKey - 字查询查询字段
    
    query - 子查询
    
    targetClass - 字段对应的类名
    
    返回:
  - get
```
public T get(String objectId)
      throws JBException
```
    根据objectId查询对象同步
    
    参数:
    
    objectId - 对象id
    
    返回:
    
    对象
    
    抛出:
    
    JBException - 信息
  - getInBackground
```
public void getInBackground(String objectId,
                            JBGetCallback<T> callback)
```
    根据objectId查询对象异步
    
    参数:
    
    objectId - 对象id
    
    callback - 查询结果回调
  - find
```
public List<T> find()
             throws JBException
```
    查询同步
    
    返回:
    
    查询结果list
    
    抛出:
    
    JBException - 异常信息
  - findInBackground
```
public void findInBackground(JBFindCallBack<T> callBack)
```
    查询异步
    
    参数:
    
    callBack - 查询结果回调
  - count
```
public int count()
          throws JBException
```
    统计查询同步
    
    返回:
    
    查询结果
    
    抛出:
    
    JBException - 异常信息
  - countInBackground
```
public void countInBackground(JBCountCallback callback)
```
    统计查询异步
    
    参数:
    
    callback - 查询结果回调
  - deleteByQuery
```
public void deleteByQuery()
                   throws JBException
```
    批量删除同步
    
    抛出:
    
    JBException - 异常信息
  - deleteByQueryInBackground
```
public void deleteByQueryInBackground()
```
    批量删除异步
  - deleteByQueryInBackground
```
public void deleteByQueryInBackground(JBBooleanCallback callback)
```
  - assembleParameters
```
protected Map<String,String> assembleParameters()
```
  - processResults
```
protected List<T> processResults(Map<String,Object> map)
                          throws Exception
```
    抛出:
    
    Exception

类 JBQuery<T extends JBObject>

构造器概要

方法概要

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

构造器详细资料

JBQuery

方法详细资料

getClassName

setClassName

getClazz

setClazz

getRunning

setRunning

getInclude

setInclude

getSelectedKeys

setSelectedKeys

getWhereSting

setWhereSting

getParameters

setParameters

getWhere

createQuery

getQuery

getLimit

setLimit

limit

getSkip

setSkip

skip

getOrder

setOrder

order

include

addAscendingOrder

addDescendingOrder

selectKeys

orderByAscending

orderByDescending

whereExists

whereNotExist

whereEqualTo

whereNotEqualTo

whereGreaterThanOrEqualTo

whereGreaterThan

whereLessThan

whereLessThanOrEqualTo

whereContains

whereContainedIn

whereNotContainedIn

whereStartWith

whereEndWith

whereWithinKilometers

whereMatches

whereMatches

addWhereItem

whereMatchesQuery

whereMatchesKeyInQuery

get

getInBackground

find

findInBackground

count

countInBackground

deleteByQuery

deleteByQueryInBackground

deleteByQueryInBackground

assembleParameters

processResults