com.baidu.mapapi.search.poi

Class PoiCitySearchOption

java.lang.Object

com.baidu.mapapi.search.poi.PoiCitySearchOption

public class PoiCitySearchOption
extends java.lang.Object

poi城市内检索参数

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	mCity 检索行政区划区域。可输入行政区划名或对应cityCode 必须参数 如需严格限制召回数据在区域内，请设置mIsCityLimit参数为true
boolean	mIsCityLimit 区域数据召回限制 为true时，仅返回mCity对应区域内数据
boolean	mIsExtendAdcode 是召回行政区域编码
boolean	mIsReturnAddr 是否返回地址信息
java.lang.String	mKeyword 检索关键字，必须参数
LanguageType	mLanguageType 检索语言类型 默认中文
int	mPageCapacity 单页展示POI数量，默认为10条记录，最大返回20条。 多关键字检索时，返回的记录数为关键字个数*mPageNum
int	mPageNum 分页页码 默认为0,0代表第一页，1代表第二页，以此类推
PoiFilter	mPoiFilter 检索过滤条件。 当scope取值为2时，可以设置filter进行排序
int	mScope 检索结果详细程度。 取值为 或空，则返回基本信息；取值为2，返回检索POI详细信息
java.lang.String	mTag 检索分类， 多个分类以","分割

Constructor Summary

Constructors

Constructor and Description
PoiCitySearchOption()

Method Summary

Modifier and Type	Method and Description
PoiCitySearchOption	city(java.lang.String city) 检索城市
PoiCitySearchOption	cityLimit(boolean cityLimit) 设置检索分类
PoiCitySearchOption	extendAdcode(boolean adCodeEnabled) 设置是否召回行政区域编码 true 召回 false 不召回
boolean	isExtendAdcode() 是否召回行政区域编码
PoiCitySearchOption	isReturnAddr(boolean returnAddr) Deprecated. 设置是否返回门址类信息，默认返回
PoiCitySearchOption	keyword(java.lang.String key) 搜索关键字
PoiCitySearchOption	language(LanguageType language) 设置检索语言类型
PoiCitySearchOption	pageCapacity(int pageCapacity) 设置每页容量，默认为每页10条
PoiCitySearchOption	pageNum(int pageNum) 分页编号
PoiCitySearchOption	poiFilter(PoiFilter poiFilter) 设置检索过滤条件 scope字段取值为2时有效
PoiCitySearchOption	scope(int scope) 设置检索分类
PoiCitySearchOption	tag(java.lang.String tag) 设置检索分类

Methods inherited from class java.lang.Object

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

Field Detail

mCity

public java.lang.String mCity

检索行政区划区域。可输入行政区划名或对应cityCode 必须参数 如需严格限制召回数据在区域内，请设置mIsCityLimit参数为true

mKeyword

public java.lang.String mKeyword

检索关键字，必须参数

mPageNum

public int mPageNum

分页页码 默认为0,0代表第一页，1代表第二页，以此类推

mPageCapacity

public int mPageCapacity

单页展示POI数量，默认为10条记录，最大返回20条。 多关键字检索时，返回的记录数为关键字个数*mPageNum

mIsReturnAddr

public boolean mIsReturnAddr

是否返回地址信息

mTag

public java.lang.String mTag

检索分类， 多个分类以","分割

mScope

public int mScope

检索结果详细程度。 取值为 或空，则返回基本信息；取值为2，返回检索POI详细信息

mIsCityLimit

public boolean mIsCityLimit

区域数据召回限制 为true时，仅返回mCity对应区域内数据

mPoiFilter

public PoiFilter mPoiFilter

检索过滤条件。 当scope取值为2时，可以设置filter进行排序

mIsExtendAdcode

public boolean mIsExtendAdcode

是召回行政区域编码

mLanguageType

public LanguageType mLanguageType

检索语言类型 默认中文

Constructor Detail

PoiCitySearchOption

public PoiCitySearchOption()

Method Detail

city

public PoiCitySearchOption city(java.lang.String city)

检索城市

Parameters:

city - 检索城市

Returns:

该poi城市内检索参数对象

keyword

public PoiCitySearchOption keyword(java.lang.String key)

搜索关键字

Parameters:

key - 搜索关键字

Returns:

该poi城市内检索参数对象

pageNum

public PoiCitySearchOption pageNum(int pageNum)

分页编号

Parameters:

pageNum - 分页编号

Returns:

该poi城市内检索参数对象

pageCapacity

public PoiCitySearchOption pageCapacity(int pageCapacity)

设置每页容量，默认为每页10条

Parameters:

pageCapacity - 每页容量

Returns:

该poi城市内检索参数对象

isReturnAddr

public PoiCitySearchOption isReturnAddr(boolean returnAddr)

Deprecated. 设置是否返回门址类信息，默认返回

Parameters:

returnAddr - true:表示返回门址类，false：表示不返回门址类

Returns:

tag

public PoiCitySearchOption tag(java.lang.String tag)

设置检索分类

Parameters:

tag - 检索分类：多个分类以","分隔，如：美食

Returns:

该附近检索参数对象

scope

public PoiCitySearchOption scope(int scope)

设置检索分类

Parameters:

scope - 检索结果详细程度：取值为1 或空，则返回基本信息；取值为2，返回检索POI详细信息

Returns:

该附近检索参数对象

cityLimit

public PoiCitySearchOption cityLimit(boolean cityLimit)

设置检索分类

Parameters:

cityLimit - 区域数据召回限制，为true时，仅召回city对应区域内数据。

Returns:

该附近检索参数对象

poiFilter

public PoiCitySearchOption poiFilter(PoiFilter poiFilter)

设置检索过滤条件 scope字段取值为2时有效

Parameters:

poiFilter - 检索过滤条件

Returns:

该附近检索参数对象

language

public PoiCitySearchOption language(LanguageType language)

设置检索语言类型

Parameters:

language -

Returns:

该附近检索参数对象

extendAdcode

public PoiCitySearchOption extendAdcode(boolean adCodeEnabled)

设置是否召回行政区域编码 true 召回 false 不召回

Parameters:

adCodeEnabled -

isExtendAdcode

public boolean isExtendAdcode()

是否召回行政区域编码

Returns: