public class

SearchParam

extends Object
implements ParamObject
java.lang.Object
   ↳ com.tencent.lbssearch.object.param.SearchParam

Class Overview

地点搜索(Search参数),提供三类范围条件的搜索功能:

指定城市的地点搜索:如在北京搜索餐馆; 圆形区域搜索:一般用于指定位置的周边(附近)地点搜索:如,搜索颐和园附近的酒店; 矩形区域的地点搜索:在地图应用中,往往用于视野内搜索,因为显示地图的区域是个矩形。

Summary

Nested Classes
interface SearchParam.Boundary 边界  
class SearchParam.Nearby 周边搜索(圆形范围): boundary=nearby(lat,lng(中心坐标),radius(半径/米)[, auto_extend])  
class SearchParam.Rectangle 矩形区域范围
示例:boundary=rectangle(lat,lng[左下,西南], lat,lng[右上,东北])  
class SearchParam.Region 指定地区名称,默认不自动扩大范围 示例:boundary=region(city[,auto_extend][,lat,lng])  
Public Constructors
SearchParam()
SearchParam(String keyword, SearchParam.Boundary boundary)
创建搜索参数请求
Public Methods
SearchParam boundary(SearchParam.Boundary boundary)
搜索地理范围
RequestParams buildParameters()
构造参数
boolean checkParams()
检查参数是否完整
SearchParam filter(String... values)
筛选条件
SearchParam getCategoryCode(boolean isNeeded)
是否返回分类代码 注: 分类代码类型参考腾讯POI分类: https://lbs.qq.com/service/webService/webServiceGuide/webServiceAppendix
SearchParam keyword(String keyword)
POI搜索关键字,用于全文检索字段
SearchParam orderby(boolean asce)
设置排序方式
SearchParam pageIndex(int page_index)
第x页,默认第1页
SearchParam pageSize(int pagesize)
每页条目数,最大限制为20条。
SearchParam page_index(int page_index)
This method is deprecated. pageIndex(int)
SearchParam page_size(int pagesize)
This method is deprecated. pageSize(int)
SearchParam region(SearchParam.Region region)
This method is deprecated. 已废弃
SearchParam subPois(boolean isNeeded)
是否返回子地点, 如大厦停车场、出入口等 注: 本参数只对 boundary = nearby()和boundary = region()有效
SearchParam subTitleFormat(boolean isShort)
是否返回子地点简称 注: 本参数只对sub_pois中的title生效
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.tencent.lbssearch.object.param.ParamObject

Public Constructors

public SearchParam ()

public SearchParam (String keyword, SearchParam.Boundary boundary)

创建搜索参数请求

Parameters
keyword POI搜索关键字,用于全文检索字段
boundary 边界类型,可传入以下对象:Rectangle || Nearby || Region

Public Methods

public SearchParam boundary (SearchParam.Boundary boundary)

搜索地理范围

Parameters
boundary 边界类型, 可传入以下对象:Rectangle || Nearby || Region

public RequestParams buildParameters ()

构造参数

public boolean checkParams ()

检查参数是否完整

public SearchParam filter (String... values)

筛选条件

Parameters
values 示例取值范围:http://lbs.qq.com/webservice_v1/guide-appendix.html

public SearchParam getCategoryCode (boolean isNeeded)

是否返回分类代码 注: 分类代码类型参考腾讯POI分类: https://lbs.qq.com/service/webService/webServiceGuide/webServiceAppendix

public SearchParam keyword (String keyword)

POI搜索关键字,用于全文检索字段

public SearchParam orderby (boolean asce)

设置排序方式

Parameters
asce 是否按照距离升序排列

public SearchParam pageIndex (int page_index)

第x页,默认第1页

public SearchParam pageSize (int pagesize)

每页条目数,最大限制为20条。

public SearchParam page_index (int page_index)

This method is deprecated.
pageIndex(int)

第x页,默认第1页

public SearchParam page_size (int pagesize)

This method is deprecated.
pageSize(int)

每页条目数,最大限制为20条。

public SearchParam region (SearchParam.Region region)

This method is deprecated.
已废弃

设置搜查地区@return

public SearchParam subPois (boolean isNeeded)

是否返回子地点, 如大厦停车场、出入口等 注: 本参数只对 boundary = nearby()和boundary = region()有效

public SearchParam subTitleFormat (boolean isShort)

是否返回子地点简称 注: 本参数只对sub_pois中的title生效