com.tencent.lbssearch.object.param

## 类 SearchParam

- java.lang.Object
- - com.tencent.lbssearch.object.param.SearchParam

- 所有已实现的接口:
    ParamObject

      public class SearchParam
      extends java.lang.Object
      implements ParamObject

  地点搜索（Search参数），提供三类范围条件的搜索功能：

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

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static interface` | `SearchParam.Boundary` 边界
    `static class` | `SearchParam.Nearby` 周边搜索（圆形范围）： boundary=nearby(lat,lng(中心坐标),radius(半径/米)[, auto_extend])
    `static class` | `SearchParam.Rectangle` 矩形区域范围 示例：boundary=rectangle(lat,lng[左下,西南], lat,lng[右上,东北])
    `static class` | `SearchParam.Region` 指定地区名称，默认不自动扩大范围 示例：boundary=region(city[,auto_extend][,lat,lng])

  - ### 构造器概要

    构造器
    构造器和说明
    `SearchParam()`
    `SearchParam(java.lang.String keyword, SearchParam.Boundary boundary)` 创建搜索参数请求

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `SearchParam` | `boundary(SearchParam.Boundary boundary)` 搜索地理范围
    `com.tencent.lbssearch.object.RequestParams` | `buildParameters()` 构造参数
    `boolean` | `checkParams()` 检查参数是否完整
    `SearchParam` | `filter(java.lang.String... values)` 筛选条件
    `SearchParam` | `getCategoryCode(boolean isNeeded)` 是否返回分类代码 注: 分类代码类型参考腾讯POI分类： https://lbs.qq.com/service/webService/webServiceGuide/webServiceAppendix
    `SearchParam` | `keyword(java.lang.String keyword)` POI搜索关键字，用于全文检索字段
    `SearchParam` | `orderby(boolean asce)` 设置排序方式
    `SearchParam` | `page_index(int page_index)` 已过时。 `pageIndex(int)`
    `SearchParam` | `page_size(int pagesize)` 已过时。 `pageSize(int)`
    `SearchParam` | `pageIndex(int page_index)` 第x页，默认第1页
    `SearchParam` | `pageSize(int pagesize)` 每页条目数，最大限制为20条。
    `SearchParam` | `region(SearchParam.Region region)` 已过时。 已废弃
    `SearchParam` | `subPois(boolean isNeeded)` 是否返回子地点, 如大厦停车场、出入口等 注: 本参数只对 boundary = nearby()和boundary = region()有效
    `SearchParam` | `subTitleFormat(boolean isShort)` 是否返回子地点简称 注: 本参数只对sub_pois中的title生效

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

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

- - ### 构造器详细资料

    - #### SearchParam

          public SearchParam()

    - #### SearchParam

          public SearchParam(java.lang.String keyword,
                             SearchParam.Boundary boundary)

      创建搜索参数请求
      参数:
        `keyword` - POI搜索关键字，用于全文检索字段
        `boundary` - 边界类型，可传入以下对象：Rectangle || Nearby || Region

  - ### 方法详细资料

    - #### keyword

          public SearchParam keyword(java.lang.String keyword)

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

    - #### boundary

          public SearchParam boundary(SearchParam.Boundary boundary)

      搜索地理范围
      参数:
        `boundary` - 边界类型， 可传入以下对象：Rectangle || Nearby || Region

    - #### filter

          public SearchParam filter(java.lang.String... values)

      筛选条件
      参数:
        `values` - 示例取值范围：http://lbs.qq.com/webservice_v1/guide-appendix.html

    - #### orderby

          public SearchParam orderby(boolean asce)

      设置排序方式
      参数:
        `asce` - 是否按照距离升序排列

    - #### pageSize

          public SearchParam pageSize(int pagesize)

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

    - #### page_size

          public SearchParam page_size(int pagesize)

      已过时。 `pageSize(int)`
      每页条目数，最大限制为20条。

    - #### pageIndex

          public SearchParam pageIndex(int page_index)

      第x页，默认第1页

    - #### page_index

          public SearchParam page_index(int page_index)

      已过时。 `pageIndex(int)`
      第x页，默认第1页

    - #### subPois

          public SearchParam subPois(boolean isNeeded)

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

    - #### subTitleFormat

          public SearchParam subTitleFormat(boolean isShort)

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

    - #### getCategoryCode

          public SearchParam getCategoryCode(boolean isNeeded)

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

    - #### region

          public SearchParam region(SearchParam.Region region)

      已过时。 已废弃
      设置搜查地区
      参数:
        `region` -
      返回:

    - #### checkParams

          public boolean checkParams()

      检查参数是否完整
      指定者:
        `checkParams` 在接口中 `ParamObject`

    - #### buildParameters

          public com.tencent.lbssearch.object.RequestParams buildParameters()

      构造参数
      指定者:
        `buildParameters` 在接口中 `ParamObject`