DistrictSearchQuery

java.lang.Object
- com.amap.api.services.district.DistrictSearchQuery

所有已实现的接口:

java.lang.Cloneable
```
public class DistrictSearchQuery
extends java.lang.Object
implements java.lang.Cloneable
```
此类定义了行政区划搜索的参数。

从以下版本开始:

2.3.0

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`KEYWORDS_BUSINESS` 已过时。 3.6.1 不再需要此参数限制
`static java.lang.String`	`KEYWORDS_CITY` 已过时。 3.6.1 不再需要此参数限制
`static java.lang.String`	`KEYWORDS_COUNTRY` 已过时。 3.6.1 不再需要此参数限制
`static java.lang.String`	`KEYWORDS_DISTRICT` 已过时。 3.6.1 不再需要此参数限制
`static java.lang.String`	`KEYWORDS_PROVINCE` 已过时。 3.6.1 不再需要此参数限制

构造器概要

构造器
构造器和说明
`DistrictSearchQuery()` 构造 DistrictSearchQuery 对象。
`DistrictSearchQuery(java.lang.String keywords, java.lang.String keywordsLevel, int pageNum)` 已过时。自V3.6.1废除此接口，建议用 `DistrictSearchQuery.DistrictSearchQuery()` 构造。
`DistrictSearchQuery(java.lang.String keywords, java.lang.String keywordsLevel, int pageNum, boolean showChild, int pageSize)` 已过时。自V3.6.1废除此接口，建议用 `DistrictSearchQuery.DistrictSearchQuery()` 构造。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`checkLevels()` 已过时。 3.6.1 不再需要此参数限制
`boolean`	`equals(java.lang.Object obj)` 比较两个查询条件是否相同。
`java.lang.String`	`getKeywords()` 返回查询时所用字符串关键字。
`java.lang.String`	`getKeywordsLevel()` 已过时。 3.6.1 不再需要此参数限制
`int`	`getPageNum()` 获取设置查询的是第几页，从0开始。
`int`	`getPageSize()` 返回查询页面的结果数目。
`int`	`getSubDistrict()` 是否返回下级区划。
`boolean`	`isShowBoundary()` 返回行政区域查询是否返回边界值。
`boolean`	`isShowBusinessArea()` 已过时。自 5.1.0 废弃，用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置
`boolean`	`isShowChild()` 已过时。自 7.1.0 废弃，返回下级行政区划参考 `DistrictSearchQuery.getSubDistrict()`
`void`	`setKeywords(java.lang.String mKeywords)` 设置查询字符串关键字。
`void`	`setKeywordsLevel(java.lang.String mLevel)` 已过时。 3.6.1 不再需要此参数限制
`void`	`setPageNum(int mPageNum)` 设置查询第几页的结果数目。
`void`	`setPageSize(int mPageSize)` 设置查询每页的结果数目，默认值是20 条，取值范围在[1-50]。
`void`	`setShowBoundary(boolean isBoundary)` 设置行政区域搜索是否返回边界值，true为返回，false为不返回。
`void`	`setShowBusinessArea(boolean showbiz)` 已过时。自 5.1.0 废弃，使用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置
`void`	`setShowChild(boolean mShowChild)` 已过时。自 7.1.0 废弃，设置下级行政区划参考 `DistrictSearchQuery.setSubDistrict(int)` ()}
`void`	`setSubDistrict(int subDistrict)` 设置显示下级行政区级数（行政区级别包括：国家、省/直辖市、市、区/县、乡镇/街道多级数据）

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

- 字段详细资料
  - KEYWORDS_COUNTRY
```
public static final java.lang.String KEYWORDS_COUNTRY
```
    已过时。 3.6.1 不再需要此参数限制
    
    行政区划级别-国家。
    
    从以下版本开始:
    
    2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_PROVINCE
```
public static final java.lang.String KEYWORDS_PROVINCE
```
    已过时。 3.6.1 不再需要此参数限制
    
    行政区划级别-省。
    
    从以下版本开始:
    
    2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_CITY
```
public static final java.lang.String KEYWORDS_CITY
```
    已过时。 3.6.1 不再需要此参数限制
    
    行政区划级别-市。
    
    从以下版本开始:
    
    2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_DISTRICT
```
public static final java.lang.String KEYWORDS_DISTRICT
```
    已过时。 3.6.1 不再需要此参数限制
    
    行政区划级别-区/县。
    
    从以下版本开始:
    
    2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_BUSINESS
```
public static final java.lang.String KEYWORDS_BUSINESS
```
    已过时。 3.6.1 不再需要此参数限制
    
    行政区划级别-商圈。
    
    从以下版本开始:
    
    2.3.0
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - DistrictSearchQuery
```
public DistrictSearchQuery()
```
    构造 DistrictSearchQuery 对象。
    
    从以下版本开始:
    
    2.3.0
  - DistrictSearchQuery
```
public DistrictSearchQuery(java.lang.String keywords,
                           java.lang.String keywordsLevel,
                           int pageNum)
```
    已过时。自V3.6.1废除此接口，建议用 DistrictSearchQuery.DistrictSearchQuery() 构造。
    
    根据给定的参数来构造一个 DistrictSearchQuery 的新对象。
    
    参数:
    
    keywords - 关键词，支持：行政区名称、城市编码、区域编码。
    
    keywordsLevel - 关键词级别，可参见 DistrictSearch 中的常量定义。（V3.6.1以后此参数已无效）
    
    pageNum - 查询第几页的结果，从0开始，默认为0，最大为第99页。
    
    从以下版本开始:
    
    2.3.0
  - DistrictSearchQuery
```
public DistrictSearchQuery(java.lang.String keywords,
                           java.lang.String keywordsLevel,
                           int pageNum,
                           boolean showChild,
                           int pageSize)
```
    已过时。自V3.6.1废除此接口，建议用 DistrictSearchQuery.DistrictSearchQuery() 构造。
    
    根据给定的参数来构造一个 DistrictSearchQuery 的新对象。
    
    参数:
    
    keywords - 关键词，支持：行政区名称、城市编码、区域编码。
    
    keywordsLevel - 关键词级别，可参见 DistrictSearch 中的常量定义。（V3.6.1以后此参数已无效）
    
    pageNum - 查询第几页的结果，从0开始，默认为0，最大为第99页。
    
    showChild - 是否显示下一级别的行政区。
    
    pageSize - 每页显示多少个数据，默认值是20 条，取值范围在[1-50] 。
    
    从以下版本开始:
    
    2.3.0
- 方法详细资料
  - setShowBoundary
```
public void setShowBoundary(boolean isBoundary)
```
    设置行政区域搜索是否返回边界值，true为返回，false为不返回。
    
    参数:
    
    isBoundary - – true/false。
    
    从以下版本开始:
    
    2.5.0
  - isShowBoundary
```
public boolean isShowBoundary()
```
    返回行政区域查询是否返回边界值。
    
    返回:
    
    true为返回边界值，false为不返回。
    
    从以下版本开始:
    
    2.5.0
  - getPageNum
```
public int getPageNum()
```
    获取设置查询的是第几页，从0开始。自 5.2.1后修改成从1开始，和iOS保持一致。
    
    返回:
    
    查询的是第几页。
    
    从以下版本开始:
    
    2.3.0
  - setPageNum
```
public void setPageNum(int mPageNum)
```
    设置查询第几页的结果数目。
    
    参数:
    
    mPageNum - 查询第几页的结果，从0开始。自 5.2.1后修改成从1开始，和iOS保持一致。
    
    从以下版本开始:
    
    2.3.0
  - getPageSize
```
public int getPageSize()
```
    返回查询页面的结果数目。
    
    返回:
    
    查询页面的结果数目。
    
    从以下版本开始:
    
    2.3.0
  - setPageSize
```
public void setPageSize(int mPageSize)
```
    设置查询每页的结果数目，默认值是20 条，取值范围在[1-50]。
    
    参数:
    
    mPageSize - 每页的最大结果数目。
    
    从以下版本开始:
    
    2.3.0
  - getKeywords
```
public java.lang.String getKeywords()
```
    返回查询时所用字符串关键字。
    
    返回:
    
    查询字符串关键字。
    
    从以下版本开始:
    
    2.3.0
  - setKeywords
```
public void setKeywords(java.lang.String mKeywords)
```
    设置查询字符串关键字。关键词支持：行政区名称、城市编码、区域编码。
    
    参数:
    
    mKeywords - 查询字符串关键字。
    
    从以下版本开始:
    
    2.3.0
  - getKeywordsLevel
```
public java.lang.String getKeywordsLevel()
```
    已过时。 3.6.1 不再需要此参数限制
    
    返回查询关键字的级别。
    
    返回:
    
    查询关键字的级别。
    
    从以下版本开始:
    
    2.3.0
  - setKeywordsLevel
```
public void setKeywordsLevel(java.lang.String mLevel)
```
    已过时。 3.6.1 不再需要此参数限制
    
    设置查询关键字的级别。
    
    参数:
    
    mLevel - 查询关键字的级别，请参见 DistrictSearch 中定义的常量。
    
    从以下版本开始:
    
    2.3.0
  - isShowChild
```
public boolean isShowChild()
```
    已过时。自 7.1.0 废弃，返回下级行政区划参考 DistrictSearchQuery.getSubDistrict()
    
    是否返回下级区划。
    
    返回:
    
    true表示返回下级区划，反之，不返回下级区划。
    
    从以下版本开始:
    
    2.3.0
  - setShowChild
```
public void setShowChild(boolean mShowChild)
```
    已过时。自 7.1.0 废弃，设置下级行政区划参考 DistrictSearchQuery.setSubDistrict(int) ()}
    
    设置是否返回下级区划。
    
    参数:
    
    mShowChild - 是否返回下级区划，默认为true，返回下级区划。
    
    从以下版本开始:
    
    2.3.0
  - getSubDistrict
```
public int getSubDistrict()
```
    是否返回下级区划。
    
    返回:
    
    0:不返回下级行政区,1：返回下一级行政区;2：返回下两级行政区;3：返回下三级行政区。
    
    从以下版本开始:
    
    7.1.0
  - setSubDistrict
```
public void setSubDistrict(int subDistrict)
```
    设置显示下级行政区级数（行政区级别包括：国家、省/直辖市、市、区/县、乡镇/街道多级数据）
    
    参数:
    
    subDistrict - 0:不返回下级行政区,1：返回下一级行政区;2：返回下两级行政区;3：返回下三级行政区。需要在此特殊说明，目前部分城市和省直辖县因为没有区县的概念，故在市级下方直接显示街道。例如：广东-东莞、海南-文昌市
    
    从以下版本开始:
    
    7.1.0
  - isShowBusinessArea
```
public boolean isShowBusinessArea()
```
    已过时。自 5.1.0 废弃，用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置
    
    返回是否显示商圈。
    
    返回:
    
    true表示下级行政区划会返回商圈（keyword级别为区/县）。
    
    从以下版本开始:
    
    3.5.0
  - setShowBusinessArea
```
public void setShowBusinessArea(boolean showbiz)
```
    已过时。自 5.1.0 废弃，使用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置
    
    设置是否显示商圈
    
    参数:
    
    showbiz - 可选为true/false，为了能够精准的定位到街道，特别是在快递、物流、送餐等场景下，强烈建议将此设置为false。
    
    从以下版本开始:
    
    3.5.0
  - checkLevels
```
public boolean checkLevels()
```
    已过时。 3.6.1 不再需要此参数限制
    
    检查行政区划级别参数是否正确
    
    返回:
    
    行政区划级别参数是否正确
    
    从以下版本开始:
    
    2.3.0
  - equals
```
public boolean equals(java.lang.Object obj)
```
    比较两个查询条件是否相同。
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj - 查询条件。
    
    返回:
    
    查询条件是否相同。
    
    从以下版本开始:
    
    2.3.0

类 DistrictSearchQuery

字段概要

构造器概要

方法概要

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

字段详细资料

KEYWORDS_COUNTRY

KEYWORDS_PROVINCE

KEYWORDS_CITY

KEYWORDS_DISTRICT

KEYWORDS_BUSINESS

构造器详细资料

DistrictSearchQuery

DistrictSearchQuery

DistrictSearchQuery

方法详细资料

setShowBoundary

isShowBoundary

getPageNum

setPageNum

getPageSize

setPageSize

getKeywords

setKeywords

getKeywordsLevel

setKeywordsLevel

isShowChild

setShowChild

getSubDistrict

setSubDistrict

isShowBusinessArea

setShowBusinessArea

checkLevels

equals