PoiSearch.Query

java.lang.Object
- com.amap.api.services.poisearch.PoiSearch.Query

所有已实现的接口:

java.lang.Cloneable

封闭类:

PoiSearch
```
public static class PoiSearch.Query
extends java.lang.Object
implements java.lang.Cloneable
```
此类定义了搜索的关键字，类别及城市。
This class defines the search keywords, categories, and city.

从以下版本开始:

V2.0.0

构造器概要

构造器
构造器和说明
`Query(java.lang.String query, java.lang.String ctgr)` Query构造函数参数 query 及 ctgr 至少需要定义一个。
`Query(java.lang.String query, java.lang.String ctgr, java.lang.String city)` 根据给定的参数来构造一个 PoiSearch.Query 的新对象。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`PoiSearch.Query`	`clone()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getBuilding()` 返回待查询建筑物的标识 Return the identifier of the building to be queried.
`java.lang.String`	`getCategory()` 返回待查分类组合。
`java.lang.String`	`getCity()` 返回待查城市（地区）的电话区号。
`boolean`	`getCityLimit()` 返回是否严格按照设定城市搜索 Whether to strictly search according to the set city
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomParams()` 获取自定义参数 Get custom parameters
`java.lang.String`	`getExtensions()` 扩展字段 base表示只返回基础数据，all表示所有数据，默认 base The extended field base indicates returning only basic data, all indicates all data, default is base.
`LatLonPoint`	`getLocation()` 获取设置的经纬度 Get the set latitude and longitude
`int`	`getPageNum()` 获取设置查询的是第几页，从0开始。
`int`	`getPageSize()` 获取设置的查询页面的结果数目。
`java.lang.String`	`getQueryString()` 返回待查字符串。
`int`	`hashCode()`
`boolean`	`isDistanceSort()` 返回是否按照距离排序。
`boolean`	`isRequireSubPois()` 返回是否按照父子关系展示POI Whether to display POIs according to parent-child relationships
`boolean`	`isSpecial()` 是否对结果进行人工干预，如火车站，原因为POI较为特殊，结果存在人工干预，干预结果优先，所以距离优先的排序未生效仅周边搜索支持 Whether to manually intervene in the results, such as train stations, because the POI is special, the results have manual intervention, intervention results take priority, so the distance-first sorting does not take effect Only supported for nearby searches
`boolean`	`queryEquals(PoiSearch.Query query)` 比较两个查询条件是否相同（不包括查询第几页）。
`void`	`requireSubPois(boolean isSubPois)` 设置是否返回父子关系。
`void`	`setBuilding(java.lang.String mBuilding)` 如果要进行室内搜索，需要添加该字段 If indoor search is to be performed, this field needs to be added.
`void`	`setCityLimit(boolean isLimit)` 仅在通过关键字搜索时进行限制严格按照设置城市搜索 Only restrict strictly according to the set city search when searching by keywords.
`void`	`setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)` 设置自定义参数，格式K-V Set custom parameters, format K-V
`void`	`setDistanceSort(boolean distanceSort)` 设置是否按距离排序 Set whether to sort by distance
`void`	`setExtensions(java.lang.String extensions)` 扩展字段 base表示只返回基础数据，all表示所有数据，默认 base The extended field base indicates returning only basic data, all indicates all data, default is base.
`void`	`setLocation(LatLonPoint location)` 设置经纬度 Set latitude and longitude
`void`	`setPageNum(int pageNum)` 设置查询第几页的结果数目。
`void`	`setPageSize(int size)` 设置查询每页的结果数目。
`void`	`setQueryLanguage(java.lang.String language)` 已过时。请参考 `ServiceSettings.setLanguage(String)` Please refer to `ServiceSettings.setLanguage(String)`
`void`	`setSpecial(boolean special)` 是否对结果进行人工干预，如火车站，原因为POI较为特殊，结果存在人工干预，干预结果优先，所以距离优先的排序未生效仅周边搜索支持默认为 true Whether to manually intervene in the results, such as train stations, because the POI is special, the results have manual intervention, intervention results take priority, so the distance-first sorting does not take effect Only supported for nearby searches Default is true

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

- 构造器详细资料
  - Query
```
public Query(java.lang.String query,
             java.lang.String ctgr)
```
    Query构造函数
    参数 query 及 ctgr 至少需要定义一个。
    Query constructor
    At least one of the parameters query or ctgr must be defined.
    
    参数:
    
    query - 查询字符串，多个关键字用“|”分割。
    Query string, with multiple keywords separated by "|".
    
    ctgr - POI 类型的组合，比如定义如下组合：餐馆|电影院|景点（POI类型请在网站“相关下载”处获取）。
    Combination of POI types, for example: restaurant|cinema|attraction (POI types can be obtained from the "Related Downloads" section on the website).
    
    从以下版本开始:
    
    V2.0.0
  - Query
```
public Query(java.lang.String query,
             java.lang.String ctgr,
             java.lang.String city)
```
    根据给定的参数来构造一个 PoiSearch.Query 的新对象。
    参数 query 及 ctgr 至少需要定义一个，并且参数 city 必须定义，不能为空。
    Construct a new object of PoiSearch.Query based on the given parameters.
    At least one of the parameters query and ctgr must be defined, and the parameter city must be defined and cannot be empty.
    
    参数:
    
    query - 查询字符串，多个关键字用“|”分割。
    Query string, with multiple keywords separated by "|".
    
    ctgr - POI 类型的组合，比如定义如下组合：餐馆|电影院|景点（POI类型请在网站“相关下载”处获取）。
    Combination of POI types, for example: restaurant|cinema|attraction (POI types can be obtained from the "Related Downloads" section on the website).
    
    city - 待查询城市（地区）的城市编码 citycode、城市名称（中文或中文全拼）、行政区划代码adcode。必设参数。
    The city code citycode, city name (in Chinese or Chinese Pinyin), and administrative division code adcode of the city (region) to be queried. Required parameters.
    
    从以下版本开始:
    
    V2.0.0
- 方法详细资料
  - getBuilding
```
public java.lang.String getBuilding()
```
    返回待查询建筑物的标识
    Return the identifier of the building to be queried.
    
    返回:
    
    待查询建筑物的标识
    The identifier of the building to be queried.
    
    从以下版本开始:
    
    V4.0.0
  - setBuilding
```
public void setBuilding(java.lang.String mBuilding)
```
    如果要进行室内搜索，需要添加该字段
    If indoor search is to be performed, this field needs to be added.
    
    参数:
    
    mBuilding - 待查询建筑物的标识
    The identifier of the building to be queried.
    
    从以下版本开始:
    
    V4.0.0
  - getQueryString
```
public java.lang.String getQueryString()
```
    返回待查字符串。
    Return the string to be queried.
    
    返回:
    
    待查字符串。
    The string to be queried.
    
    从以下版本开始:
    
    V2.0.0
  - setQueryLanguage
```
public void setQueryLanguage(java.lang.String language)
```
    已过时。请参考 ServiceSettings.setLanguage(String)
    Please refer to ServiceSettings.setLanguage(String)
    
    从以下版本开始:
    
    V2.0.0
  - getCategory
```
public java.lang.String getCategory()
```
    返回待查分类组合。
    Return the category combination to be queried.
    
    返回:
    
    待查分类组合。
    The category combination to be queried.
    
    从以下版本开始:
    
    V2.0.0
  - getCity
```
public java.lang.String getCity()
```
    返回待查城市（地区）的电话区号。
    Return the telephone area code of the city (region) to be queried.
    
    返回:
    
    待查城市（地区）的电话区号。
    The telephone area code of the city (region) to be queried.
    
    从以下版本开始:
    
    V2.0.0
  - getPageNum
```
public int getPageNum()
```
    获取设置查询的是第几页，从0开始。自 5.2.1后修改成从1开始，和iOS保持一致。
    Get the page number of the query, starting from 0.Changed to start from 1 after version 5.2.1 to be consistent with iOS.
    
    返回:
    
    查询的是第几页。
    Query which page it is.
    
    从以下版本开始:
    
    V2.1.0
  - setPageNum
```
public void setPageNum(int pageNum)
```
    设置查询第几页的结果数目。
    Set the number of results for the query page.
    
    参数:
    
    pageNum - 查询第几页的结果，从0开始。自 5.2.1后修改成从1开始，和iOS保持一致。
    Query the results of which page, starting from 0.Changed to start from 1 after version 5.2.1 to align with iOS.
    
    从以下版本开始:
    
    V2.1.0
  - setPageSize
```
public void setPageSize(int size)
```
    设置查询每页的结果数目。
    Set the number of results per page for the query.
    
    参数:
    
    size - 新的查询条件，默认值是20 条,取值范围在1-30 条。
    New query conditions, the default value is 20, ranging from 1 to 30.
    
    从以下版本开始:
    
    V2.1.0
  - getPageSize
```
public int getPageSize()
```
    获取设置的查询页面的结果数目。
    Get the number of results set for the query page.
    
    返回:
    
    查询页面的结果数目。
    The number of results on the query page.
    
    从以下版本开始:
    
    V2.1.0
  - setCityLimit
```
public void setCityLimit(boolean isLimit)
```
    仅在通过关键字搜索时进行限制严格按照设置城市搜索
    Only restrict strictly according to the set city search when searching by keywords.
    
    参数:
    
    isLimit - true，城市限制；false，输入文字是权重词汇时，全国搜索。默认为false。
    true, city restriction; false, nationwide search when the input text is a weighted word. The default is false.
    
    从以下版本开始:
    
    V2.8.0
  - getCityLimit
```
public boolean getCityLimit()
```
    返回是否严格按照设定城市搜索
    Whether to strictly search according to the set city
    
    返回:
    
    true，城市限制；false，关键字是权重词汇时，全国搜索
    true, city restriction; false, nationwide search when the keyword is a weight term
    
    从以下版本开始:
    
    V2.8.0
  - requireSubPois
```
public void requireSubPois(boolean isSubPois)
```
    设置是否返回父子关系。
    Set whether to return parent-child relationships.
    
    参数:
    
    isSubPois - true 按照父子关系层级返回。false不返回父子关系。
    true returns according to parent-child relationship hierarchy. false does not return parent-child relationships.
    
    从以下版本开始:
    
    V2.8.0
  - isRequireSubPois
```
public boolean isRequireSubPois()
```
    返回是否按照父子关系展示POI
    Whether to display POIs according to parent-child relationships
    
    返回:
    
    true 按照父子关系层级返回。false不返回父子关系。
    true returns according to parent-child relationship hierarchy. false does not return parent-child relationships.
    
    从以下版本开始:
    
    V2.8.0
  - isDistanceSort
```
public boolean isDistanceSort()
```
    返回是否按照距离排序。
    Returns whether to sort by distance.
    
    返回:
    
    true 按照距离排序，false不按照距离排序。
    true sorts by distance, false does not sort by distance.
    
    从以下版本开始:
    
    V5.2.0
  - setDistanceSort
```
public void setDistanceSort(boolean distanceSort)
```
    设置是否按距离排序
    Set whether to sort by distance
    
    参数:
    
    distanceSort - 是否按照距离排序
    Whether to sort by distance
    
    从以下版本开始:
    
    V5.2.0
  - getLocation
```
public LatLonPoint getLocation()
```
    获取设置的经纬度
    Get the set latitude and longitude
    
    返回:
    
    经纬度
    latitude and longitude
    
    从以下版本开始:
    
    V5.2.0
  - setLocation
```
public void setLocation(LatLonPoint location)
```
    设置经纬度
    Set latitude and longitude
    
    参数:
    
    location -
    
    从以下版本开始:
    
    V5.2.0
  - isSpecial
```
public boolean isSpecial()
```
    是否对结果进行人工干预，如火车站，原因为POI较为特殊，结果存在人工干预，干预结果优先，所以距离优先的排序未生效仅周边搜索支持
    Whether to manually intervene in the results, such as train stations, because the POI is special, the results have manual intervention, intervention results take priority, so the distance-first sorting does not take effect Only supported for nearby searches
    
    返回:
    
    是否对结果进行人工干预
    Whether to manually intervene in the results
    
    从以下版本开始:
    
    7.6.0
  - setSpecial
```
public void setSpecial(boolean special)
```
    是否对结果进行人工干预，如火车站，原因为POI较为特殊，结果存在人工干预，干预结果优先，所以距离优先的排序未生效仅周边搜索支持默认为 true
    Whether to manually intervene in the results, such as train stations, because the POI is special, the results have manual intervention, intervention results take priority, so the distance-first sorting does not take effect Only supported for nearby searches Default is true
    
    从以下版本开始:
    
    7.6.0
  - getExtensions
```
public java.lang.String getExtensions()
```
    扩展字段 base表示只返回基础数据，all表示所有数据，默认 base
    The extended field base indicates returning only basic data, all indicates all data, default is base.
    
    从以下版本开始:
    
    7.6.0
  - setExtensions
```
public void setExtensions(java.lang.String extensions)
```
    扩展字段 base表示只返回基础数据，all表示所有数据，默认 base
    The extended field base indicates returning only basic data, all indicates all data, default is base.
    
    从以下版本开始:
    
    7.6.0
  - setCustomParams
```
public void setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)
```
    设置自定义参数，格式K-V
    Set custom parameters, format K-V
    
    参数:
    
    customParams -
    
    从以下版本开始:
    
    9.7.2
  - getCustomParams
```
public java.util.Map<java.lang.String,java.lang.String> getCustomParams()
```
    获取自定义参数
    Get custom parameters
    
    返回:
  - queryEquals
```
public boolean queryEquals(PoiSearch.Query query)
```
    比较两个查询条件是否相同（不包括查询第几页）。
    Compare whether two query conditions are the same (excluding the page number).
    
    参数:
    
    query - 待比较的对象
    Object to be compared
    
    返回:
    
    查询条件是否相同
    Whether the query conditions are the same.
    
    从以下版本开始:
    
    V2.1.0
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - clone
```
public PoiSearch.Query clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object

类 PoiSearch.Query

构造器概要

方法概要

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

构造器详细资料

Query

Query

方法详细资料

getBuilding

setBuilding

getQueryString

setQueryLanguage

getCategory

getCity

getPageNum

setPageNum

setPageSize

getPageSize

setCityLimit

getCityLimit

requireSubPois

isRequireSubPois

isDistanceSort

setDistanceSort

getLocation

setLocation

isSpecial

setSpecial

getExtensions

setExtensions

setCustomParams

getCustomParams

queryEquals

hashCode

equals

clone