AVSearchQuery (storage core library 6.0.3 API)

java.lang.Object
- cn.leancloud.search.AVSearchQuery<T>

public class AVSearchQuery<T extends AVObject>
extends Object

字段概要

字段
限定符和类型字段和说明

static String AVSEARCH_APP_URL

static String AVSEARCH_DEEP_LINK

static String AVSEARCH_HIGHTLIGHT

static String DATA_EXTRA_SEARCH_KEY

字段
限定符和类型	字段和说明
`static String`	`AVSEARCH_APP_URL`
`static String`	`AVSEARCH_DEEP_LINK`
`static String`	`AVSEARCH_HIGHTLIGHT`
`static String`	`DATA_EXTRA_SEARCH_KEY`

构造器概要

构造器
构造器和说明

AVSearchQuery()

AVSearchQuery(String queryString)

AVSearchQuery(String queryString, Class<T> clazz)

构造器
构造器和说明
`AVSearchQuery()`
`AVSearchQuery(String queryString)`
`AVSearchQuery(String queryString, Class<T> clazz)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`AVSearchQuery`	`addAscendingOrder(String key)` Also sorts the results in ascending order by the given key.
`AVSearchQuery`	`addDescendingOrder(String key)` Also sorts the results in descending order by the given key.
`io.reactivex.Observable<List<T>>`	`findInBackground()`
`String`	`getClassName()` 获取查询的className，默认为null，即包括所有启用了应用内搜索的class
`List<String>`	`getFields()`
`String`	`getHightLights()` 获取当前设定的语法高亮
`int`	`getHits()`
`String`	`getLastId()` 已过时。请使用getSid()替代。
`int`	`getLimit()` 获得搜索结果的单页大小限制
`String`	`getQueryString()`
`protected io.reactivex.Observable<List<T>>`	`getSearchResult(Map<String,String> params)`
`String`	`getSid()` 获取本次查询的id，注意，它不是返回结果中对象的objectId，而是表示本次AVSearchQuery查询的id
`int`	`getSkip()` 返回当前返回集合的其实位置
`AVSearchSortBuilder`	`getSortBuilder()` 获取当前的AVSearchSortBuilder对象
`String`	`getTitleAttribute()` 获取当前指定的title 对应的Field
`void`	`include(String key)`
`AVSearchQuery`	`order(String order)` 设置查询字段列表，以逗号隔开的字符串，例如"a,b,c"，表示按照a,b,c三个字段的顺序排序，如果字段前面有负号，表示倒序，例如"a,-b"
`AVSearchQuery`	`orderByAscending(String key)` 根据提供的key进行升序排序
`AVSearchQuery`	`orderByDescending(String key)` 根据提供的key进行降序排序
`void`	`setClassName(String className)` 设置查询的className，否则将包括所有启用了应用内搜索的class
`void`	`setFields(List<String> fields)`
`void`	`setHightLights(String hightlights)` 设置返回的高亮语法，默认为"*" 语法规则可以参考　　http://www.elasticsearch.org/guide/en/elasticsearch/reference/current /search-request-highlighting.html#highlighting-settings
`void`	`setLastId(String lastId)` 已过时。使用setSid(String)替代
`void`	`setLimit(int limit)` 设置搜索的结果单页大小限制,默认值为100，最大为1000
`void`	`setQueryString(String query)` 设置搜索的查询语句。
`void`	`setSid(String sid)` 设置查询id，通常您都不需要调用这个方法来设置，只要不停调用find就可以实现分页。
`void`	`setSkip(int skip)` 设置返回集合的起始位置，一般用于分页
`void`	`setSortBuilder(AVSearchSortBuilder sortBuilder)` 设置查询的AVSearchSortBuilder，使用更丰富的排序选项。
`void`	`setTitleAttribute(String titleAttribute)` 此选项为AVOSCloud SearchActivity使用指定Title所对应的Field

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

- 字段详细资料
  - AVSEARCH_HIGHTLIGHT
```
public static final String AVSEARCH_HIGHTLIGHT
```
    另请参阅:
    
    常量字段值
  - AVSEARCH_APP_URL
```
public static final String AVSEARCH_APP_URL
```
    另请参阅:
    
    常量字段值
  - AVSEARCH_DEEP_LINK
```
public static final String AVSEARCH_DEEP_LINK
```
    另请参阅:
    
    常量字段值
  - DATA_EXTRA_SEARCH_KEY
```
public static final String DATA_EXTRA_SEARCH_KEY
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AVSearchQuery
```
public AVSearchQuery()
```
  - AVSearchQuery
```
public AVSearchQuery(String queryString)
```
  - AVSearchQuery
```
public AVSearchQuery(String queryString,
                     Class<T> clazz)
```
- 方法详细资料
  - getSortBuilder
```
public AVSearchSortBuilder getSortBuilder()
```
    获取当前的AVSearchSortBuilder对象
    
    返回:
  - setSortBuilder
```
public void setSortBuilder(AVSearchSortBuilder sortBuilder)
```
    设置查询的AVSearchSortBuilder，使用更丰富的排序选项。
    
    参数:
    
    sortBuilder -
  - getClassName
```
public String getClassName()
```
    获取查询的className，默认为null，即包括所有启用了应用内搜索的class
    
    返回:
  - order
```
public AVSearchQuery order(String order)
```
    设置查询字段列表，以逗号隔开的字符串，例如"a,b,c"，表示按照a,b,c三个字段的顺序排序，如果字段前面有负号，表示倒序，例如"a,-b"
    
    参数:
    
    order -
    
    返回:
    
    this query.
  - orderByAscending
```
public AVSearchQuery orderByAscending(String key)
```
    根据提供的key进行升序排序
    
    参数:
    
    key - 需要排序的key
  - orderByDescending
```
public AVSearchQuery orderByDescending(String key)
```
    根据提供的key进行降序排序
    
    参数:
    
    key - The key to order by.
    
    返回:
    
    Returns the query, so you can chain this call.
  - addAscendingOrder
```
public AVSearchQuery addAscendingOrder(String key)
```
    Also sorts the results in ascending order by the given key. The previous sort keys have precedence over this key.
    
    参数:
    
    key - The key to order by
    
    返回:
    
    Returns the query so you can chain this call.
  - addDescendingOrder
```
public AVSearchQuery addDescendingOrder(String key)
```
    Also sorts the results in descending order by the given key. The previous sort keys have precedence over this key.
    
    参数:
    
    key - The key to order by
    
    返回:
    
    Returns the query so you can chain this call.
  - setClassName
```
public void setClassName(String className)
```
    设置查询的className，否则将包括所有启用了应用内搜索的class
    
    参数:
    
    className -
  - setLimit
```
public void setLimit(int limit)
```
    设置搜索的结果单页大小限制,默认值为100，最大为1000
    
    参数:
    
    limit -
  - getLimit
```
public int getLimit()
```
    获得搜索结果的单页大小限制
    
    返回:
  - getSkip
```
public int getSkip()
```
    返回当前返回集合的其实位置
  - setSkip
```
public void setSkip(int skip)
```
    设置返回集合的起始位置，一般用于分页
  - setHightLights
```
public void setHightLights(String hightlights)
```
    设置返回的高亮语法，默认为"*" 语法规则可以参考　　http://www.elasticsearch.org/guide/en/elasticsearch/reference/current /search-request-highlighting.html#highlighting-settings
    
    参数:
    
    hightlights -
  - getHightLights
```
public String getHightLights()
```
    获取当前设定的语法高亮
    
    返回:
  - setFields
```
public void setFields(List<String> fields)
```
  - getFields
```
public List<String> getFields()
```
  - setLastId
```
@Deprecated
public void setLastId(String lastId)
```
    已过时。使用setSid(String)替代
    
    lastId是作为分页的依据，根据设置lastId需要查询的页数设置为null回到第一页
    
    参数:
    
    lastId -
  - setSid
```
public void setSid(String sid)
```
    设置查询id，通常您都不需要调用这个方法来设置，只要不停调用find就可以实现分页。不过如果需要将查询分页传递到其他Activity，则可能需要通过传递sid来实现。
    
    参数:
    
    sid -
  - getLastId
```
@Deprecated
public String getLastId()
```
    已过时。请使用getSid()替代。
    
    获取本次查询的id，注意，它不是返回结果中对象的objectId，而是表示本次AVSearchQuery查询的id
    
    返回:
  - getSid
```
public String getSid()
```
    获取本次查询的id，注意，它不是返回结果中对象的objectId，而是表示本次AVSearchQuery查询的id
    
    返回:
  - setTitleAttribute
```
public void setTitleAttribute(String titleAttribute)
```
    此选项为AVOSCloud SearchActivity使用指定Title所对应的Field
    
    参数:
    
    titleAttribute -
  - getTitleAttribute
```
public String getTitleAttribute()
```
    获取当前指定的title 对应的Field
    
    返回:
  - setQueryString
```
public void setQueryString(String query)
```
    设置搜索的查询语句。详细语法可以参考http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl -query-string-query.html#query-string-syntax
    
    参数:
    
    query -
  - getQueryString
```
public String getQueryString()
```
  - getHits
```
public int getHits()
```
  - include
```
public void include(String key)
```
  - findInBackground
```
public io.reactivex.Observable<List<T>> findInBackground()
```
  - getSearchResult
```
protected io.reactivex.Observable<List<T>> getSearchResult(Map<String,String> params)
```

类 AVSearchQuery<T extends AVObject>

字段概要

构造器概要

方法概要

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

字段详细资料

AVSEARCH_HIGHTLIGHT

AVSEARCH_APP_URL

AVSEARCH_DEEP_LINK

DATA_EXTRA_SEARCH_KEY

构造器详细资料

AVSearchQuery

AVSearchQuery

AVSearchQuery

方法详细资料

getSortBuilder

setSortBuilder

getClassName

order

orderByAscending

orderByDescending

addAscendingOrder

addDescendingOrder

setClassName

setLimit

getLimit

getSkip

setSkip

setHightLights

getHightLights

setFields

getFields

setLastId

setSid

getLastId

getSid

setTitleAttribute

getTitleAttribute

setQueryString

getQueryString

getHits

include

findInBackground

getSearchResult