PoiSearch (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.poiquery.PoiSearch

```
public class PoiSearch
extends java.lang.Object
```
POI 在线搜索引擎
扩展了PoiQuery 在线关键字搜索功能，支持搜索提示(suggestion)、关键字纠错、搜索城市建议功能，优化了搜索和排序结果，支持多实例。

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`PoiSearch.ChildrenLevel` 要设置的poi搜索层级
`class`	`PoiSearch.Error` 错误码
`class`	`PoiSearch.Event` 搜索事件
`static interface`	`PoiSearch.Listener` 搜索回调

构造器概要

构造器
构造器和说明

PoiSearch()

构造器
构造器和说明
`PoiSearch()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`backSearch()` 返回上一次查询结果，当当前search实例正在执行`select(int, int)` 进行查询过程中，调用该接口无效，将返回false.
`void`	`cancelSearch()` 取消本次查询
`void`	`clearResult()` 清除对离线数据的占用
`void`	`enableCompensation(boolean enabled)` 开启沿路搜的搜索补偿策略相关`isCompensationEnabled()`
`void`	`enableOnlySearchInCurrentRegion(boolean isOnlySearchInCurrentRegion)` 设置是否只在当前行政区内搜索
`void`	`forceNearBy(boolean isNearBy)` 设置强制使用周边搜索
`android.graphics.Point`	`getCenter()` 获取搜索中心点
`int`	`getChildrenLevel()` 当前搜索设置的子poi搜索等级
`java.lang.String`	`getCity()` 查看当前设置的城市
`int`	`getCurrentPoiNum()` 获取当前已加载的PoiItem总数量
`RegionPoiItem`	`getCurrentRegionPoiItem()` 获取当前的行政区PoiItem，`RegionPoiItem`
`int`	`getError()` 获取查询失败时的错误信息码
`java.lang.String`	`getErrorInfo()` 获取查询失败时的错误信息
`BaseItem`	`getItemByIndex(int itemType, int index)` 获取对应itemType，对应index的Item
`int`	`getItemNum(int itemType)` 获取对应itemType已加载的结果数量
`java.lang.String`	`getKeyword()` 获取当前查询的关键字
`int`	`getPageSize()` 获取当前设置的页大小，范围为[1,15]
`PoiItem`	`getPoiItemByIndex(int index)` 根据索引获取PoiItem
`int`	`getRange()` 获取搜索半径
`int`	`getTotalPoiItemSum()` 获取全部`PoiItem`数量，包括未加载的
`static TypeNode`	`getTypeTree()` 获取类型搜的类型树
`static java.lang.String`	`getTypeTreeString()` 获取类型树的json字符串
`boolean`	`hasNextPage()` 是否还有下一页PoiItem结果
`boolean`	`isCompensationEnabled()` 沿路搜索的搜索补偿策略是否开启相关`enableCompensation(boolean)`
`boolean`	`isCurrentDistrictChanged()` 是否发生城市跳转
`boolean`	`isNearBy()` 当前是否正在使用周边搜索
`boolean`	`isOnlySearchInCurrentRegion()` 获取是否只在当前行政区内搜索
`void`	`loadNextEnroutePage()` 用于沿路搜时加载下一页结果,`searchAlongRoute(String, RouteBase)`
`void`	`loadNextPage()` 加载下一页结果,调用之应调用`hasNextPage()`查看是否还有下一页结果
`void`	`searchAlongRoute(java.lang.String keyword, RouteBase route)` 进行沿路搜索注：进行沿路搜加载下一页需要调用`loadNextEnroutePage()` 必须设置参数有：keyword, routeBase, center 自定义参数有：`setMaxDistance(int)`, `setMaxRadius(int)`, `enableCompensation(boolean)`
`int`	`searchWithKeyword(java.lang.String keyword)` 进行关键字查询，需要设置合理的城市和查询中心点
`void`	`select(int itemType, int index)` 根据搜索到的结果发起新的搜索
`void`	`setCenter(android.graphics.Point center)` 设置查询中心点,`searchWithKeyword(String)`以及 `searchAlongRoute(String, RouteBase)`均需设置合理的查询中心点
`void`	`setChildrenLevel(int level)` 设置子poi搜索等级
`boolean`	`setCity(java.lang.String cityName)` 设置搜索时的城市名称注意：在线不用设置城市，如果设置了城市，会优先使用它；否则会根据传的中心点算城市; 中心点的设置`setCity(String)`，在线离线都必须设置
`void`	`setKeyword(java.lang.String keyword)` 设置要查询的关键字
`void`	`setListener(PoiSearch.Listener callback)` 设置查询回调
`void`	`setMaxDistance(int maxDistance)` 设置沿路搜索的最大距离，默认值50000m
`void`	`setMaxRadius(int maxRadius)` 设置沿路搜索的最大半径，默认值300m
`void`	`setMaxResultNum(int maxNum)` 设置搜索结果的最大数量，对普通的关键字搜索以及沿路搜均适用
`void`	`setPageSize(int size)` 设置页大小，仅针对`PoiItem`，默认：10，最大为15，
`void`	`setRange(int range)` 设置搜索半径，默认值:3000米
`void`	`sortByDistance()` 调用此方法，获得的搜索结果为按距离排序后的结果
`void`	`startSearch()` 开始查询，进行关键字查询，需要设置合理的城市和查询中心点

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

- 构造器详细资料
  - PoiSearch
```
public PoiSearch()
```
- 方法详细资料
  - setCenter
```
public void setCenter(android.graphics.Point center)
```
    设置查询中心点,searchWithKeyword(String)以及 searchAlongRoute(String, RouteBase)均需设置合理的查询中心点
    
    参数:
    
    center -
  - startSearch
```
public void startSearch()
```
    开始查询，进行关键字查询，需要设置合理的城市和查询中心点
  - searchWithKeyword
```
public int searchWithKeyword(java.lang.String keyword)
```
    进行关键字查询，需要设置合理的城市和查询中心点
    
    参数:
    
    keyword - 要查询的关键字
    
    返回:
    
    结果
  - searchAlongRoute
```
public void searchAlongRoute(java.lang.String keyword,
                             RouteBase route)
```
    进行沿路搜索注：进行沿路搜加载下一页需要调用loadNextEnroutePage() 必须设置参数有：keyword, routeBase, center 自定义参数有：setMaxDistance(int), setMaxRadius(int), enableCompensation(boolean)
    
    参数:
    
    keyword - 查询关键字
    
    route - routeBase对象实例
  - select
```
public void select(int itemType,
                   int index)
```
    根据搜索到的结果发起新的搜索
    
    参数:
    
    itemType - 进行search搜索后获取的结果类型,BaseItem.ItemType itemType设置为 BaseItem.ItemType.poi时，select接口无效
    
    index - 索引
  - backSearch
```
public boolean backSearch()
```
    返回上一次查询结果，当当前search实例正在执行select(int, int) 进行查询过程中，调用该接口无效，将返回false. backSearch()与 select(int, int)相对应
    
    返回:
    
    加载上一次搜索会话是否成功
  - setListener
```
public void setListener(PoiSearch.Listener callback)
```
    设置查询回调
    
    参数:
    
    callback - PoiSearch.Listener
  - getError
```
public int getError()
```
    获取查询失败时的错误信息码
    
    返回:
    
    查询失败时返回的错误信息码 Error
  - getErrorInfo
```
public java.lang.String getErrorInfo()
```
    获取查询失败时的错误信息
    
    返回:
    
    查询失败时的错误信息
  - cancelSearch
```
public void cancelSearch()
```
    取消本次查询
  - hasNextPage
```
public boolean hasNextPage()
```
    是否还有下一页PoiItem结果
  - loadNextPage
```
public void loadNextPage()
```
    加载下一页结果,调用之应调用hasNextPage()查看是否还有下一页结果
  - loadNextEnroutePage
```
public void loadNextEnroutePage()
```
    用于沿路搜时加载下一页结果,searchAlongRoute(String, RouteBase)
  - getCenter
```
public android.graphics.Point getCenter()
```
    获取搜索中心点
    
    返回:
    
    搜索中心点坐标
  - setRange
```
public void setRange(int range)
```
    设置搜索半径，默认值:3000米
    
    参数:
    
    range - 要设置的搜索半径，单位：米
  - getRange
```
public int getRange()
```
    获取搜索半径
    
    返回:
    
    当前搜索的搜索半径，单位：米
  - getTypeTree
```
public static TypeNode getTypeTree()
```
    获取类型搜的类型树
    
    返回:
    
    类型树根节点
  - getTypeTreeString
```
public static java.lang.String getTypeTreeString()
```
    获取类型树的json字符串
    
    返回:
    
    类型树json字符串
  - setKeyword
```
public void setKeyword(java.lang.String keyword)
```
    设置要查询的关键字
    
    参数:
    
    keyword - 要查询的关键字
  - getKeyword
```
public java.lang.String getKeyword()
```
    获取当前查询的关键字
    
    返回:
  - setCity
```
public boolean setCity(java.lang.String cityName)
```
    设置搜索时的城市名称
    注意：在线不用设置城市，如果设置了城市，会优先使用它；否则会根据传的中心点算城市;
    中心点的设置setCity(String)，在线离线都必须设置
    
    参数:
    
    cityName - 要设置搜索的城市名称
    
    返回:
    
    设置城市是否成功
  - getCity
```
public java.lang.String getCity()
```
    查看当前设置的城市
    
    返回:
    
    当前设置的城市名称
  - forceNearBy
```
public void forceNearBy(boolean isNearBy)
```
    设置强制使用周边搜索
    
    参数:
    
    isNearBy - true是/false否
  - isNearBy
```
public boolean isNearBy()
```
    当前是否正在使用周边搜索
    
    返回:
  - setChildrenLevel
```
public void setChildrenLevel(int level)
```
    设置子poi搜索等级
    
    参数:
    
    level - 要设置的搜索等级等级说明见PoiSearch.ChildrenLevel
  - getChildrenLevel
```
public int getChildrenLevel()
```
    当前搜索设置的子poi搜索等级
    
    返回:
    
    当前设置的子poi搜索等级
  - setPageSize
```
public void setPageSize(int size)
```
    设置页大小，仅针对PoiItem，默认：10，最大为15，
    
    参数:
    
    size - 页大小
  - getPageSize
```
public int getPageSize()
```
    获取当前设置的页大小，范围为[1,15]
    
    返回:
    
    当前查询实例设置的页大小
  - getTotalPoiItemSum
```
public int getTotalPoiItemSum()
```
    获取全部PoiItem数量，包括未加载的
    
    返回:
    
    PoiItem的数量
  - getCurrentPoiNum
```
public int getCurrentPoiNum()
```
    获取当前已加载的PoiItem总数量
    
    返回:
    
    已加载的PoiItem总数量
  - getPoiItemByIndex
```
public PoiItem getPoiItemByIndex(int index)
```
    根据索引获取PoiItem
    
    参数:
    
    index - 索引，取值范围[0, getCurrentPoiNum() ()})
    
    返回:
    
    poi搜索结果，为空代表当前搜索是例的句柄为空
  - getCurrentRegionPoiItem
```
public RegionPoiItem getCurrentRegionPoiItem()
```
    获取当前的行政区PoiItem，RegionPoiItem
    
    返回:
    
    当前的行政区PoiItem
  - setMaxResultNum
```
public void setMaxResultNum(int maxNum)
```
    设置搜索结果的最大数量，对普通的关键字搜索以及沿路搜均适用
    
    参数:
    
    maxNum - 设置的最大数量
  - setMaxDistance
```
public void setMaxDistance(int maxDistance)
```
    设置沿路搜索的最大距离，默认值50000m
    
    参数:
    
    maxDistance - 设置沿路搜索的最大距离，单位m
  - setMaxRadius
```
public void setMaxRadius(int maxRadius)
```
    设置沿路搜索的最大半径，默认值300m
    
    参数:
    
    maxRadius - 设置沿路搜索的最大半径，单位m
  - enableCompensation
```
public void enableCompensation(boolean enabled)
```
    开启沿路搜的搜索补偿策略相关isCompensationEnabled()
    
    参数:
    
    enabled -
  - isCompensationEnabled
```
public boolean isCompensationEnabled()
```
    沿路搜索的搜索补偿策略是否开启
    相关enableCompensation(boolean)
  - sortByDistance
```
public void sortByDistance()
```
    调用此方法，获得的搜索结果为按距离排序后的结果
  - getItemNum
```
public int getItemNum(int itemType)
```
    获取对应itemType已加载的结果数量
    
    参数:
    
    itemType - 见BaseItem.ItemType
    
    返回:
    
    结果数量
  - getItemByIndex
```
public BaseItem getItemByIndex(int itemType,
                               int index)
```
    获取对应itemType，对应index的Item
    
    参数:
    
    itemType - item的类型，见BaseItem.ItemType
    
    index - item在对应类型的结果集中的索引
  - isCurrentDistrictChanged
```
public boolean isCurrentDistrictChanged()
```
    是否发生城市跳转
    
    返回:
  - enableOnlySearchInCurrentRegion
```
public void enableOnlySearchInCurrentRegion(boolean isOnlySearchInCurrentRegion)
```
    设置是否只在当前行政区内搜索
    
    参数:
    
    isOnlySearchInCurrentRegion - 是否只在当前行政区内搜索
  - isOnlySearchInCurrentRegion
```
public boolean isOnlySearchInCurrentRegion()
```
    获取是否只在当前行政区内搜索
    
    返回:
    
    是否只在当前行政区内搜索
  - clearResult
```
public void clearResult()
```
    清除对离线数据的占用

类 PoiSearch

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

PoiSearch

方法详细资料

setCenter

startSearch

searchWithKeyword

searchAlongRoute

select

backSearch

setListener

getError

getErrorInfo

cancelSearch

hasNextPage

loadNextPage

loadNextEnroutePage

getCenter

setRange

getRange

getTypeTree

getTypeTreeString

setKeyword

getKeyword

setCity

getCity

forceNearBy

isNearBy

setChildrenLevel

getChildrenLevel

setPageSize

getPageSize

getTotalPoiItemSum

getCurrentPoiNum

getPoiItemByIndex

getCurrentRegionPoiItem

setMaxResultNum

setMaxDistance

setMaxRadius

enableCompensation

isCompensationEnabled

sortByDistance

getItemNum

getItemByIndex

isCurrentDistrictChanged

enableOnlySearchInCurrentRegion

isOnlySearchInCurrentRegion

clearResult