com.baidu.mapapi.search.poi

Class PoiNearbySearchOption

java.lang.Object

com.baidu.mapapi.search.poi.PoiNearbySearchOption

public class PoiNearbySearchOption
extends java.lang.Object

附近检索参数

Field Summary

Fields

Modifier and Type	Field and Description
boolean	mIsExtendAdcode 是否召回行政区域编码
java.lang.String	mKeyword 检索关键字，必须参数 支持多个关键字并集检索，不同关键字间以$符号分隔，最多支持10个关键字检索。如:”银行$酒店”
LanguageType	mLanguageType 检索语言类型 默认中文
LatLng	mLocation 周边检索中心点，不支持多个点 必须参数
int	mPageCapacity 单页展示POI数量 默认为10条记录，最大返回20条。多关键字检索时，返回的记录数为关键字个数*mPageNum
int	mPageNum 分页页码，默认为0 0代表第一页，1代表第二页，以此类推
PoiFilter	mPoiFilter 检索过滤条件。 当scope取值为2时，可以设置filter进行排序
int	mRadius 周边检索半径，单位为米 当半径过大，超过中心点所在城市边界时，会变为城市范围检索，检索范围为中心点所在城市
boolean	mRadiusLimit 是否严格限定召回结果在设置检索半径范围内 true（是），false（否）
int	mScope 检索结果详细程度。 取值为 或空，则返回基本信息；取值为2，返回检索POI详细信息
java.lang.String	mTag 检索分类， 多个分类以","分割
PoiSortType	sortType 检索结果排序策略

Constructor Summary

Constructors

Constructor and Description
PoiNearbySearchOption()

Method Summary

Modifier and Type	Method and Description
PoiNearbySearchOption	extendAdcode(boolean adCodeEnabled) 设置是否召回行政区域编码 true 召回 false 不召回
boolean	isExtendAdcode() 是否召回行政区域编码
PoiNearbySearchOption	keyword(java.lang.String key) 检索关键字
PoiNearbySearchOption	language(LanguageType language) 设置检索语言类型
PoiNearbySearchOption	location(LatLng location) 检索位置
PoiNearbySearchOption	pageCapacity(int pageCapacity) 设置每页容量，默认为每页10条
PoiNearbySearchOption	pageNum(int pageNum) 分页编号
PoiNearbySearchOption	poiFilter(PoiFilter poiFilter) 设置检索过滤条件 scope字段取值为2时有效
PoiNearbySearchOption	radius(int radius) 设置检索的半径范围
PoiNearbySearchOption	radiusLimit(boolean radiusLimit) 设置是否严格限定召回结果在设置检索半径范围内
PoiNearbySearchOption	scope(int scope) 设置检索分类
PoiNearbySearchOption	sortType(PoiSortType sortType) Deprecated. 搜索结果排序规则，可选，默认(从5.1.0版本之后，废弃该接口)
PoiNearbySearchOption	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

mKeyword

public java.lang.String mKeyword

检索关键字，必须参数 支持多个关键字并集检索，不同关键字间以$符号分隔，最多支持10个关键字检索。如:”银行$酒店”

mLocation

public LatLng mLocation

周边检索中心点，不支持多个点 必须参数

mRadius

public int mRadius

周边检索半径，单位为米 当半径过大，超过中心点所在城市边界时，会变为城市范围检索，检索范围为中心点所在城市

mPageNum

public int mPageNum

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

mPageCapacity

public int mPageCapacity

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

sortType

public PoiSortType sortType

检索结果排序策略

mTag

public java.lang.String mTag

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

mScope

public int mScope

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

mRadiusLimit

public boolean mRadiusLimit

是否严格限定召回结果在设置检索半径范围内 true（是），false（否）

mPoiFilter

public PoiFilter mPoiFilter

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

mIsExtendAdcode

public boolean mIsExtendAdcode

是否召回行政区域编码

mLanguageType

public LanguageType mLanguageType

检索语言类型 默认中文

Constructor Detail

PoiNearbySearchOption

public PoiNearbySearchOption()

Method Detail

keyword

public PoiNearbySearchOption keyword(java.lang.String key)

检索关键字

Parameters:

key - 关键字

Returns:

该附近检索参数对象

location

public PoiNearbySearchOption location(LatLng location)

检索位置

Parameters:

location - 位置

Returns:

该附近检索参数对象

sortType

public PoiNearbySearchOption sortType(PoiSortType sortType)

Deprecated. 搜索结果排序规则，可选，默认(从5.1.0版本之后，废弃该接口)

Parameters:

sortType - 搜索结果排序规则

Returns:

该附近检索参数对象

radius

public PoiNearbySearchOption radius(int radius)

设置检索的半径范围

Parameters:

radius - 检索半径 单位： m

Returns:

该附近检索参数对象

radiusLimit

public PoiNearbySearchOption radiusLimit(boolean radiusLimit)

设置是否严格限定召回结果在设置检索半径范围内

Parameters:

radiusLimit - 是否严格限定召回结果在设置检索半径范围内,(默认值为false)设置为true时会影响返回结果中total准确性及每页召回poi数量

Returns:

该附近检索参数对象

pageNum

public PoiNearbySearchOption pageNum(int pageNum)

分页编号

Parameters:

pageNum - 分页编号

Returns:

该附近检索参数对象

pageCapacity

public PoiNearbySearchOption pageCapacity(int pageCapacity)

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

Parameters:

pageCapacity - 每页容量

Returns:

该附近检索参数对象

tag

public PoiNearbySearchOption tag(java.lang.String tag)

设置检索分类

Parameters:

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

Returns:

该附近检索参数对象

scope

public PoiNearbySearchOption scope(int scope)

设置检索分类

Parameters:

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

Returns:

该附近检索参数对象

poiFilter

public PoiNearbySearchOption poiFilter(PoiFilter poiFilter)

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

Parameters:

poiFilter - 检索过滤条件

Returns:

该附近检索参数对象

language

public PoiNearbySearchOption language(LanguageType language)

设置检索语言类型

Parameters:

language -

Returns:

该附近检索参数对象

extendAdcode

public PoiNearbySearchOption extendAdcode(boolean adCodeEnabled)

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

Parameters:

adCodeEnabled -

isExtendAdcode

public boolean isExtendAdcode()

是否召回行政区域编码

Returns: