DistrictSearchQuery

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

所有已实现的接口:

android.os.Parcelable, java.lang.Cloneable
```
public class DistrictSearchQuery
extends java.lang.Object
implements android.os.Parcelable, java.lang.Cloneable
```
此类定义了行政区划搜索的参数。
This class defines the parameters for administrative division search.

从以下版本开始:

V2.3.0

嵌套类概要
- 从接口继承的嵌套类/接口 android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

字段概要

字段
限定符和类型	字段和说明
`static android.os.Parcelable.Creator<DistrictSearchQuery>`	`CREATOR`
`static java.lang.String`	`KEYWORDS_BUSINESS` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`static java.lang.String`	`KEYWORDS_CITY` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`static java.lang.String`	`KEYWORDS_COUNTRY` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`static java.lang.String`	`KEYWORDS_DISTRICT` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`static java.lang.String`	`KEYWORDS_PROVINCE` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.

从接口继承的字段 android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

构造器概要

构造器
构造器和说明
`DistrictSearchQuery()` 构造 DistrictSearchQuery 对象 Construct a DistrictSearchQuery object.
`DistrictSearchQuery(java.lang.String keywords, java.lang.String keywordsLevel, int pageNum)` 已过时。自V3.6.1废除此接口，建议用 `DistrictSearchQuery()` 构造。 This interface is deprecated since V3.6.1, it is recommended to use `DistrictSearchQuery()` to construct.
`DistrictSearchQuery(java.lang.String keywords, java.lang.String keywordsLevel, int pageNum, boolean showChild, int pageSize)` 已过时。自V3.6.1废除此接口，建议用 `DistrictSearchQuery()` 构造。 This interface is deprecated since V3.6.1, it is recommended to use `DistrictSearchQuery()` to construct.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`checkKeyWords()` 返回行政区划查询条件的关键字是否为非空 Whether the keyword of the administrative division query condition is non-empty.
`boolean`	`checkLevels()` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`DistrictSearchQuery`	`clone()`
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object obj)` 比较两个查询条件是否相同 Compare whether two query conditions are the same.
`java.lang.String`	`getKeywords()` 返回查询时所用字符串关键字 Returns the string keyword used in the query.
`java.lang.String`	`getKeywordsLevel()` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`int`	`getPageNum()` 获取设置查询的是第几页，从0开始 Get the setting of which page to query, starting from 0.
`int`	`getPageSize()` 返回查询页面的结果数目 Returns the number of results on the query page.
`int`	`getSubDistrict()` 是否返回下级区划 Whether to return sub-level administrative divisions.
`int`	`hashCode()`
`boolean`	`isShowBoundary()` 返回行政区域查询是否返回边界值 Returns whether the administrative region query returns boundary values.
`boolean`	`isShowBusinessArea()` 已过时。自 5.1.0 废弃，用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置 Deprecated since 5.1.0, rarely used and affects accuracy. The business district (biz_area) level data is removed and replaced with street (street) data.
`boolean`	`isShowChild()` 已过时。自 7.1.0 废弃，返回下级行政区划参考 `getSubDistrict()` Deprecated since 7.1.0, return sub-administrative divisions refer to `getSubDistrict()`
`void`	`setKeywords(java.lang.String mKeywords)` 设置查询字符串关键字 Set the query string keyword.
`void`	`setKeywordsLevel(java.lang.String mLevel)` 已过时。 V3.6.1 不再需要此参数限制 V3.6.1 no longer requires this parameter restriction.
`void`	`setPageNum(int mPageNum)` 设置查询第几页的结果数目 Set the number of results for the query page.
`void`	`setPageSize(int mPageSize)` 设置查询每页的结果数目，默认值是20 条，取值范围在[1-50] Set the number of results per page for the query, default is 20, range is [1-50].
`void`	`setShowBoundary(boolean isBoundary)` 设置行政区域搜索是否返回边界值，true为返回，false为不返回 Set whether the administrative region search returns boundary values, true to return, false not to return.
`void`	`setShowBusinessArea(boolean showbiz)` 已过时。自 5.1.0 废弃，使用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置 Deprecated since 5.1.0, rarely used and affects accuracy. The business district (biz_area) level data is removed and replaced with street (street) data.
`void`	`setShowChild(boolean mShowChild)` 已过时。自 7.1.0 废弃，设置下级行政区划参考 `setSubDistrict(int)` ()} Deprecated since 7.1.0, set sub-administrative divisions refer to `setSubDistrict(int)` ()}
`void`	`setSubDistrict(int subDistrict)` 设置显示下级行政区级数（行政区级别包括：国家、省/直辖市、市、区/县、乡镇/街道多级数据） Set the number of sub-level administrative divisions to display (administrative levels include: country, province/municipality, city, district/county, township/street, etc.).
`boolean`	`weakEquals(DistrictSearchQuery districtQuery)`
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

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

- 字段详细资料
  - KEYWORDS_COUNTRY
```
public static final java.lang.String KEYWORDS_COUNTRY
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    行政区划级别-国家
    Administrative division level - Country.
    
    从以下版本开始:
    
    V2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_PROVINCE
```
public static final java.lang.String KEYWORDS_PROVINCE
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    行政区划级别-省
    Administrative division level - Province.
    
    从以下版本开始:
    
    V2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_CITY
```
public static final java.lang.String KEYWORDS_CITY
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    行政区划级别-市
    Administrative division level - City.
    
    从以下版本开始:
    
    V2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_DISTRICT
```
public static final java.lang.String KEYWORDS_DISTRICT
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    行政区划级别-区/县
    Administrative division level - District/County.
    
    从以下版本开始:
    
    V2.3.0
    
    另请参阅:
    
    常量字段值
  - KEYWORDS_BUSINESS
```
public static final java.lang.String KEYWORDS_BUSINESS
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    行政区划级别-商圈
    Administrative division level - Business district.
    
    从以下版本开始:
    
    V2.3.0
    
    另请参阅:
    
    常量字段值
  - CREATOR
```
public static final android.os.Parcelable.Creator<DistrictSearchQuery> CREATOR
```
- 构造器详细资料
  - DistrictSearchQuery
```
public DistrictSearchQuery()
```
    构造 DistrictSearchQuery 对象
    Construct a DistrictSearchQuery object.
    
    从以下版本开始:
    
    V2.3.0
  - DistrictSearchQuery
```
public DistrictSearchQuery(java.lang.String keywords,
                           java.lang.String keywordsLevel,
                           int pageNum)
```
    已过时。自V3.6.1废除此接口，建议用 DistrictSearchQuery() 构造。
    This interface is deprecated since V3.6.1, it is recommended to use DistrictSearchQuery() to construct.
    
    根据给定的参数来构造一个 DistrictSearchQuery 的新对象
    Construct a new DistrictSearchQuery object based on the given parameters.
    
    参数:
    
    keywords - 关键词，支持：行政区名称、城市编码、区域编码。
    Keywords, supported: administrative region name, city code, region code.
    
    keywordsLevel - 关键词级别，可参见 DistrictSearch 中的常量定义。（V3.6.1以后此参数已无效）
    Keyword level, refer to the constant definitions in DistrictSearch. (This parameter is invalid after V3.6.1)
    
    pageNum - 查询第几页的结果，从0开始，默认为0，最大为第99页。
    Query the results of which page, starting from 0, default is 0, maximum is the 99th page.
    
    从以下版本开始:
    
    V2.3.0
  - DistrictSearchQuery
```
public DistrictSearchQuery(java.lang.String keywords,
                           java.lang.String keywordsLevel,
                           int pageNum,
                           boolean showChild,
                           int pageSize)
```
    已过时。自V3.6.1废除此接口，建议用 DistrictSearchQuery() 构造。
    This interface is deprecated since V3.6.1, it is recommended to use DistrictSearchQuery() to construct.
    
    根据给定的参数来构造一个 DistrictSearchQuery 的新对象
    Construct a new DistrictSearchQuery object based on the given parameters.
    
    参数:
    
    keywords - 关键词，支持：行政区名称、城市编码、区域编码。
    Keywords, supported: administrative region name, city code, region code.
    
    keywordsLevel - 关键词级别，可参见 DistrictSearch 中的常量定义。（V3.6.1以后此参数已无效）
    Keyword level, refer to the constant definitions in DistrictSearch. (This parameter is invalid after V3.6.1)
    
    pageNum - 查询第几页的结果，从0开始，默认为0，最大为第99页。
    Query the results of which page, starting from 0, default is 0, maximum is the 99th page.
    
    showChild - 是否显示下一级别的行政区。
    Whether to display the administrative region at the next lower level.
    
    pageSize - 每页显示多少个数据，默认值是20 条，取值范围在[1-50] 。
    How many data items are displayed per page,The default value is 20 items, and the value range is [1-50].
    
    从以下版本开始:
    
    V2.3.0
- 方法详细资料
  - setShowBoundary
```
public void setShowBoundary(boolean isBoundary)
```
    设置行政区域搜索是否返回边界值，true为返回，false为不返回
    Set whether the administrative region search returns boundary values, true to return, false not to return.
    
    参数:
    
    isBoundary - – true/false。
    
    从以下版本开始:
    
    V2.5.0
  - isShowBoundary
```
public boolean isShowBoundary()
```
    返回行政区域查询是否返回边界值
    Returns whether the administrative region query returns boundary values.
    
    返回:
    
    true为返回边界值，false为不返回。
    true to return boundary values, false not to return.
    
    从以下版本开始:
    
    V2.5.0
  - getPageNum
```
public int getPageNum()
```
    获取设置查询的是第几页，从0开始
    Get the setting of which page to query, starting from 0.
    自 5.2.1后修改成从1开始，和iOS保持一致。
    Changed to start from 1 after 5.2.1, consistent with iOS.
    
    返回:
    
    查询的是第几页。
    Query which page it is.
    
    从以下版本开始:
    
    V2.3.0
  - setPageNum
```
public void setPageNum(int mPageNum)
```
    设置查询第几页的结果数目
    Set the number of results for the query page.
    
    参数:
    
    mPageNum - 查询第几页的结果，从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.3.0
  - getPageSize
```
public int getPageSize()
```
    返回查询页面的结果数目
    Returns the number of results on the query page.
    
    返回:
    
    查询页面的结果数目。
    The number of results on the query page.
    
    从以下版本开始:
    
    V2.3.0
  - setPageSize
```
public void setPageSize(int mPageSize)
```
    设置查询每页的结果数目，默认值是20 条，取值范围在[1-50]
    Set the number of results per page for the query, default is 20, range is [1-50].
    
    参数:
    
    mPageSize - 每页的最大结果数目。
    The maximum number of results per page.
    
    从以下版本开始:
    
    V2.3.0
  - getKeywords
```
public java.lang.String getKeywords()
```
    返回查询时所用字符串关键字
    Returns the string keyword used in the query.
    
    返回:
    
    查询字符串关键字。
    Query string keyword.
    
    从以下版本开始:
    
    V2.3.0
  - setKeywords
```
public void setKeywords(java.lang.String mKeywords)
```
    设置查询字符串关键字
    Set the query string keyword.
    关键词支持：行政区名称、城市编码、区域编码。
    Keywords supported: administrative region name, city code, region code.
    
    参数:
    
    mKeywords - 查询字符串关键字。
    Query string keyword.
    
    从以下版本开始:
    
    V2.3.0
  - getKeywordsLevel
```
public java.lang.String getKeywordsLevel()
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    返回查询关键字的级别
    Returns the level of the query keyword.
    
    返回:
    
    查询关键字的级别。
    Query string keyword.
    
    从以下版本开始:
    
    V2.3.0
  - setKeywordsLevel
```
public void setKeywordsLevel(java.lang.String mLevel)
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    设置查询关键字的级别
    Set the level of the query keyword.
    
    参数:
    
    mLevel - 查询关键字的级别，请参见 DistrictSearch 中定义的常量。
    The level of the query keyword, refer to the constants defined in DistrictSearch.
    
    从以下版本开始:
    
    V2.3.0
  - isShowChild
```
public boolean isShowChild()
```
    已过时。自 7.1.0 废弃，返回下级行政区划参考 getSubDistrict()
    Deprecated since 7.1.0, return sub-administrative divisions refer to getSubDistrict()
    
    是否返回下级区划
    Whether to return sub-districts.
    
    返回:
    
    true表示返回下级区划，反之，不返回下级区划。
    true means to return sub-districts, otherwise, do not return sub-districts.
    
    从以下版本开始:
    
    V2.3.0
  - setShowChild
```
public void setShowChild(boolean mShowChild)
```
    已过时。自 7.1.0 废弃，设置下级行政区划参考 setSubDistrict(int) ()}
    Deprecated since 7.1.0, set sub-administrative divisions refer to setSubDistrict(int) ()}
    
    设置是否返回下级区划
    Set whether to return sub-districts.
    
    参数:
    
    mShowChild - 是否返回下级区划，默认为true，返回下级区划。
    Whether to return sub-districts, default is true, return sub-districts.
    
    从以下版本开始:
    
    V2.3.0
  - getSubDistrict
```
public int getSubDistrict()
```
    是否返回下级区划
    Whether to return sub-level administrative divisions.
    
    返回:
    
    0:不返回下级行政区,1：返回下一级行政区;2：返回下两级行政区;3：返回下三级行政区。
    0: Do not return sub-level administrative divisions; 1: Return the next level of administrative divisions; 2: Return the next two levels of administrative divisions; 3: Return the next three levels of administrative divisions.
    
    从以下版本开始:
    
    V7.1.0
  - setSubDistrict
```
public void setSubDistrict(int subDistrict)
```
    设置显示下级行政区级数（行政区级别包括：国家、省/直辖市、市、区/县、乡镇/街道多级数据）
    Set the number of sub-level administrative divisions to display (administrative levels include: country, province/municipality, city, district/county, township/street, etc.).
    
    参数:
    
    subDistrict - 0:不返回下级行政区,1：返回下一级行政区;2：返回下两级行政区;3：返回下三级行政区。需要在此特殊说明，目前部分城市和省直辖县因为没有区县的概念，故在市级下方直接显示街道。例如：广东-东莞、海南-文昌市
    0: Do not return sub-level administrative divisions; 1: Return the next level of administrative divisions; 2: Return the next two levels of administrative divisions; 3: Return the next three levels of administrative divisions. Special note: Currently, some cities and provincial directly-administered counties do not have the concept of districts/counties, so streets are displayed directly under the city level. For example: Guangdong-Dongguan, Hainan-Wenchang City.
    
    从以下版本开始:
    
    V7.1.0
  - isShowBusinessArea
```
public boolean isShowBusinessArea()
```
    已过时。自 5.1.0 废弃，用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置
    Deprecated since 5.1.0, rarely used and affects accuracy. The business district (biz_area) level data is removed and replaced with street (street) data.
    
    返回是否显示商圈
    Whether to display business districts.
    
    返回:
    
    true表示下级行政区划会返回商圈（keyword级别为区/县）。
    true means sub-level administrative divisions will return business districts (keyword level is district/county).
    
    从以下版本开始:
    
    V3.5.0
  - setShowBusinessArea
```
public void setShowBusinessArea(boolean showbiz)
```
    已过时。自 5.1.0 废弃，使用率极低，而且会影响精准度，取消商圈（biz_area）级别数据，用街道（street）顶替商圈位置
    Deprecated since 5.1.0, rarely used and affects accuracy. The business district (biz_area) level data is removed and replaced with street (street) data.
    
    设置是否显示商圈
    Set whether to display business districts.
    
    参数:
    
    showbiz - 可选为true/false，为了能够精准的定位到街道，特别是在快递、物流、送餐等场景下，强烈建议将此设置为false。
    Optional values are true/false. To accurately locate streets, especially in scenarios like delivery, logistics, and food delivery, it is strongly recommended to set this to false.
    
    从以下版本开始:
    
    V3.5.0
  - checkLevels
```
public boolean checkLevels()
```
    已过时。 V3.6.1 不再需要此参数限制
    V3.6.1 no longer requires this parameter restriction.
    
    检查行政区划级别参数是否正确
    Check if the administrative division level parameter is correct.
    
    返回:
    
    行政区划级别参数是否正确
    Whether the administrative division level parameter is correct.
    
    从以下版本开始:
    
    V2.3.0
  - checkKeyWords
```
public boolean checkKeyWords()
```
    返回行政区划查询条件的关键字是否为非空
    Whether the keyword of the administrative division query condition is non-empty.
    
    返回:
    
    true关键字不为空，false关键字为空。
    true means the keyword is not empty, false means the keyword is empty.
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    比较两个查询条件是否相同
    Compare whether two query conditions are the same.
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj - 查询条件。
    Query conditions.
    
    返回:
    
    查询条件是否相同。
    Whether the query conditions are the same.
    
    从以下版本开始:
    
    V2.3.0
  - weakEquals
```
public boolean weakEquals(DistrictSearchQuery districtQuery)
```
  - clone
```
public DistrictSearchQuery clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
  - describeContents
```
public int describeContents()
```
    指定者:
    
    describeContents 在接口中 android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    指定者:
    
    writeToParcel 在接口中 android.os.Parcelable

类 DistrictSearchQuery

嵌套类概要

从接口继承的嵌套类/接口 android.os.Parcelable

字段概要

从接口继承的字段 android.os.Parcelable

构造器概要

方法概要

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

字段详细资料

KEYWORDS_COUNTRY

KEYWORDS_PROVINCE

KEYWORDS_CITY

KEYWORDS_DISTRICT

KEYWORDS_BUSINESS

CREATOR

构造器详细资料

DistrictSearchQuery

DistrictSearchQuery

DistrictSearchQuery

方法详细资料

setShowBoundary

isShowBoundary

getPageNum

setPageNum

getPageSize

setPageSize

getKeywords

setKeywords

getKeywordsLevel

setKeywordsLevel

isShowChild

setShowChild

getSubDistrict

setSubDistrict

isShowBusinessArea

setShowBusinessArea

checkLevels

checkKeyWords

hashCode

equals

weakEquals

clone

describeContents

writeToParcel