com.amap.api.services.cloud

## 类 CloudSearch.Query

- java.lang.Object
- - com.amap.api.services.cloud.CloudSearch.Query

- 所有已实现的接口:
    java.lang.Cloneable
  封闭类:
    CloudSearch

      public static class CloudSearch.Query
      extends java.lang.Object
      implements java.lang.Cloneable

  此类定义了搜索的关键字，区域范围。
  从以下版本开始:
    2.7.0

- - ### 构造器概要

    构造器
    构造器和说明
    `Query(java.lang.String tableid, java.lang.String query, CloudSearch.SearchBound bound)` 根据给定的参数构造一个 CloudSearch.Query 的新对象。

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `void` | `addFilterNum(java.lang.String key, java.lang.String value1, java.lang.String value2)` 已过时。 使用 `CloudSearch.Query.addFilterString(String, String)` 替换
    `void` | `addFilterString(java.lang.String key, java.lang.String value)` 1：支持建立索引的字段根据多个条件筛选，多个条件用&&符号连接。
    `boolean` | `equals(java.lang.Object query)` 比较两个查询条件是否相同(包括查询第几页)
    `CloudSearch.SearchBound` | `getBound()` 返回查询的范围（本地、圆形、矩形或者多边形）。
    `java.lang.String` | `getFilterNumString()` 已过时。 使用 `CloudSearch.Query.addFilterString(String, String)`替换
    `java.lang.String` | `getFilterString()` 将筛选字段转换为字符串返回
    `int` | `getPageNum()` 返回设置查询的是第几页，从0开始。
    `int` | `getPageSize()` 返回查询每页的结果数目。
    `java.lang.String` | `getQueryString()` 返回搜索的关键词。
    `CloudSearch.Sortingrules` | `getSortingrules()` 返回排序规则。
    `java.lang.String` | `getTableID()` 返回搜索的表tableid。
    `boolean` | `queryEquals(CloudSearch.Query query)` 比较两个查询条件是否相同(不包括查询第几页)
    `void` | `setBound(CloudSearch.SearchBound bnd)` 设置查询的范围（本地、圆形、矩形或者多边形）。
    `void` | `setPageNum(int pageNum)` 设置查询第几页的结果数目。
    `void` | `setPageSize(int size)`
    `void` | `setSortingrules(CloudSearch.Sortingrules sortingrules)` 设置排序规则。
    `void` | `setTableID(java.lang.String tableID)` 设置搜索的表tableid。

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

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

- - ### 构造器详细资料

    - #### Query

          public Query(java.lang.String tableid,
                       java.lang.String query,
                       CloudSearch.SearchBound bound)
                throws AMapException

      根据给定的参数构造一个 CloudSearch.Query 的新对象。

      参数中：tableid和bound必填，query可选。

      如果tableid和bound为空，则抛出IllegalArgumentException 异常。

      如果查询范围不是圆形，则没有距离排序；如果查询范围是圆形，有关键字时默认为权重降序排列，无关键字时默认为距离升序排列。

      参数:
        `tableid` - 必填，数据表的唯一标示。
        `query` -

        1. 支持关键字检索，即对建立过索引的字段进行检索；如keywords=工商银行，检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。
        2.支持关键字多值检索；（只支持建立过文本索引的字段查询）如keywords=招商银行&&华夏银行&&工商银行，检索返回已建立索引列值中包含“招商银行”且“华夏银行”且“工商银行”的POI结果集，不会返回检索词切分后，如仅包含“招商”或者“银行”的POI集；。

        `bound` - 查询的城市或范围（支持圆形、多边形）。
      抛出:
        `AMapException` - 如果为空或者bounds为空时会抛出 `AMapException.AMAP_CLIENT_INVALID_PARAMETER`
      从以下版本开始:
        2.7.0

  - ### 方法详细资料

    - #### getQueryString

          public java.lang.String getQueryString()

      返回搜索的关键词。
      返回:
        搜索的关键词。
      从以下版本开始:
        2.7.0

    - #### setTableID

          public void setTableID(java.lang.String tableID)

      设置搜索的表tableid。
      参数:
        `tableID` - 数据表的唯一标示。
      从以下版本开始:
        2.7.0

    - #### getTableID

          public java.lang.String getTableID()

      返回搜索的表tableid。
      返回:
        tableid。
      从以下版本开始:
        2.7.0

    - #### getPageNum

          public int getPageNum()

      返回设置查询的是第几页，从0开始。自 5.2.1后修改成从1开始，和iOS保持一致。
      返回:
        查询的是第几页。
      从以下版本开始:
        2.7.0

    - #### setPageNum

          public void setPageNum(int pageNum)

      设置查询第几页的结果数目。
      参数:
        `pageNum` - 查询第几页的结果，从0开始。自 5.2.1后修改成从1开始，和iOS保持一致。
      从以下版本开始:
        2.7.0

    - #### setPageSize

          public void setPageSize(int size)

      参数:
        `size` - 每页结果数
      从以下版本开始:
        2.7.0

    - #### getPageSize

          public int getPageSize()

      返回查询每页的结果数目。
      返回:
        查询每页的结果数目。
      从以下版本开始:
        2.7.0

    - #### setBound

          public void setBound(CloudSearch.SearchBound bnd)

      设置查询的范围（本地、圆形、矩形或者多边形）。
      参数:
        `bnd` - 新的查询范围（本地、圆形、矩形或者多边形）。
      从以下版本开始:
        2.7.0

    - #### getBound

          public CloudSearch.SearchBound getBound()

      返回查询的范围（本地、圆形、矩形或者多边形）。
      返回:
        查询的范围（本地、圆形、矩形或者多边形）。
      从以下版本开始:
        2.7.0

    - #### addFilterString

          public void addFilterString(java.lang.String key,
                                      java.lang.String value)

      1：支持建立索引的字段根据多个条件筛选，多个条件用&&符号连接。
      2：判断符合支持
      >= 大于等于
      <= 小于等于
      >大于
      <小于
      = 精确匹配(text索引不可用)
      示例规则：key1=value1&&key2=value2&&lastloctime>=1469817532
      示例："name=王师傅|张师傅&&lastloctime>=1469817532
      参数:
        `key` - 文字筛选条件精确匹配的键。
        `value` - 键对应的文字。
      从以下版本开始:
        2.7.0

    - #### getFilterString

          public java.lang.String getFilterString()

      将筛选字段转换为字符串返回
      返回:
        筛选字段名称和对应关键字的字符串

    - #### addFilterNum

          public void addFilterNum(java.lang.String key,
                                   java.lang.String value1,
                                   java.lang.String value2)

      已过时。 使用 `CloudSearch.Query.addFilterString(String, String)` 替换
      支持对数值字段的连续区间筛选，例如对酒店字段筛选3星-5星的酒店。
      参数:
        `key` - 数值筛选条件的键。
        `value1` - 键对应的数值连续区间的开始数值。
        `value2` - 键对应的数值连续区间的结束数值。
      从以下版本开始:
        2.7.0

    - #### getFilterNumString

          public java.lang.String getFilterNumString()

      已过时。 使用 `CloudSearch.Query.addFilterString(String, String)`替换
      返回排序规则。
      返回:
        排序规则。
      从以下版本开始:
        2.7.0

    - #### setSortingrules

          public void setSortingrules(CloudSearch.Sortingrules sortingrules)

      设置排序规则。
      参数:
        `sortingrules` - 排序规则。
      从以下版本开始:
        2.7.0

    - #### getSortingrules

          public CloudSearch.Sortingrules getSortingrules()

      返回排序规则。
      返回:
        排序规则。
      从以下版本开始:
        2.7.0

    - #### queryEquals

          public boolean queryEquals(CloudSearch.Query query)

      比较两个查询条件是否相同(不包括查询第几页)
      参数:
        `query` - 查询条件
      返回:
        查询条件是否相同
      从以下版本开始:
        2.7.0

    - #### equals

          public boolean equals(java.lang.Object query)

      比较两个查询条件是否相同(包括查询第几页)
      覆盖:
        `equals` 在类中 `java.lang.Object`
      参数:
        `query` - 查询条件
      返回:
        查询条件是否相同
      从以下版本开始:
        2.7.0