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

public class LCSearchQuery<T extends LCObject>
extends java.lang.Object

字段概要

字段
修饰符和类型	字段	说明
`static java.lang.String`	`AVSEARCH_APP_URL`
`static java.lang.String`	`AVSEARCH_DEEP_LINK`
`static java.lang.String`	`AVSEARCH_HIGHTLIGHT`
`static java.lang.String`	`DATA_EXTRA_SEARCH_KEY`

构造器概要

构造器
构造器说明

LCSearchQuery()

LCSearchQuery(java.lang.String queryString)

LCSearchQuery(java.lang.String queryString, java.lang.Class<T> clazz)

方法概要

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

构造器	说明
`LCSearchQuery()`
`LCSearchQuery(java.lang.String queryString)`
`LCSearchQuery(java.lang.String queryString, java.lang.Class<T> clazz)`

类 LCSearchQuery<T extends LCObject>

字段概要

构造器概要

方法概要

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

字段详细资料

AVSEARCH_HIGHTLIGHT

AVSEARCH_APP_URL

AVSEARCH_DEEP_LINK

DATA_EXTRA_SEARCH_KEY

构造器详细资料

LCSearchQuery

LCSearchQuery

LCSearchQuery

方法详细资料

getSortBuilder

setSortBuilder

getClassName

order

orderByAscending

orderByDescending

addAscendingOrder

addDescendingOrder

setClassName

setLimit

getLimit

getSkip

setSkip

setHightLights

getHightLights

setFields

getFields

setSid

getSid

setTitleAttribute

getTitleAttribute

setQueryString

getQueryString

getHits

include

findInBackground

findInBackground

getSearchResult