PoiQuery (JNaviCore SDK Documentation)

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

```
public class PoiQuery
extends java.lang.Object
```
POI搜索引擎
提供POI相关搜索功能

Notice:

注意：所有接口都应在主线程中调用

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`PoiQuery.Error` 搜索错误类型
`class`	`PoiQuery.Event` POI搜索事件类型
`static interface`	`PoiQuery.EventHandler` 搜索事件回调接口
`class`	`PoiQuery.HostType` 设置的地址Host类型
`class`	`PoiQuery.KeywordType` 搜索关键字类型，分为普通关键字和周边关键字两类
`class`	`PoiQuery.PoiQueryParamsType` 搜索参数类型所有设置都会在下一次搜索时生效

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`cancel()` 取消搜索请求[在线] 此方法仅针对在线搜索起作用，会取消搜索请求
`int`	`classifyKeyword(java.lang.String keyword, java.lang.Object userdata)` 检查关键字分类[离线] 普通关键字建议使用`queryByKeyword(String, Point, Object)`做搜索周边关键字建议使用`queryNearbyKeyword(String, Point, Object)`做搜索
`void`	`cleanup()` 清理搜索模块资源通常在应用程序退出时使用，用来清理搜索引擎所用资源
`void`	`clearResult()` 清空搜索结果[在线&离线] 一般是用来释放内存使用，当需要使用大量内存的时候，可以调用此方法释放已经不需要缓存的搜索结果数据
`int`	`getCurrentPageFirstResultIndex()` 获取当前页第一个元素所在索引[在线&离线] 一般是配合着`getCurrentPageLastResultIndex()`方法共同使用用来生成当前页所需要显示的搜索结果
`int`	`getCurrentPageIndex()` 获取当前页码[在线&离线] 不同模式下的页码是独立的
`int`	`getCurrentPageLastResultIndex()` 获取当前页最后一个元素所在索引[在线&离线] 一般是配合着`getCurrentPageFirstResultIndex()`方法共同使用用来生成当前页所需要显示的搜索结果
`static PoiQuery`	`getInstance()`
`PoiFavoriteInfo`	`getOnlineSpecialResult()` 返回在线搜索中的特殊结果，一般来说，特殊结果包括公交车站和公交线路[在线]
`PoiFavoriteInfo`	`getResultAsPoiFavoriteInfo(int index)` 将结果以POI的形式返回[在线&离线]
`int`	`getResultNumber()` 获取当前已经加载的结果数量[在线&离线]
`SideInfo`	`getResultRoutePosition(int index)` 获取搜索到的指定索引POI所在位置相对路线的关系信息[离线]
`java.lang.String`	`getRwd(java.lang.String input)` 获取联想的候选字[离线]
`int`	`getTotalResultNumber()` 获取搜索结果总数[在线&离线] 使用时，可能还需要`loadNextPage(Object)`来加载
`int`	`getWmrId()` 返回当前搜索时所使用的城市行政区划id[在线&离线]
`boolean`	`hasNextPage()` 判断是否有下一页结果[在线&离线]
`void`	`init(PoiQueryInitParams param)` 初始化搜索模块
`boolean`	`isInited()` POI搜索模块是否已经初始化
`void`	`loadNextPage(java.lang.Object userdata)` 通过回调的形式下载下一页的内容[在线&离线] 下载完后会收到`PoiQuery.Event.pageLoaded`消息
`void`	`loadPreviousPage(java.lang.Object userdata)` 通过回调的形式下载前一页的内容[在线&离线] 下载后会收到`PoiQuery.Event.pageLoaded`消息
`void`	`queryBusStations(java.lang.String keyword, android.graphics.Point center, java.lang.Object userdata)` 搜索公交站[离线]
`void`	`queryByAddress(java.lang.String keyword, android.graphics.Point center, java.lang.Object userdata)` 地址关键字搜索[离线]
`void`	`queryByCurrrentRoute(int poiTypeIndex, android.graphics.Point carPos, java.lang.Object userdata)` 沿路搜索[离线] 路线为当前导航引擎所采纳的路线，所以此方法必须在已经开始导航的情况下使用
`void`	`queryByInitial(java.lang.String initial, android.graphics.Point center, java.lang.Object userdata)` 首字母搜索[离线]
`void`	`queryByKeyword(java.lang.String keyword, android.graphics.Point center, java.lang.Object userdata)` 普通关键字查询[在线&离线]
`void`	`queryByRoute(RouteBase routeBase, int poiTypeIndex, android.graphics.Point carPos, java.lang.Object userdata)` 沿路搜索[离线]
`void`	`queryCrossRoads(java.lang.String keyword, android.graphics.Point center, java.lang.Object userdata)` 搜索路线交叉路口[离线]
`void`	`queryNearby(android.graphics.Point center, int typeIndex, java.lang.Object userdata)` 周边搜索[在线&离线]
`void`	`queryNearbyKeyword(java.lang.String keyword, android.graphics.Point center, java.lang.Object userdata)` 周边关键字搜索[在线&离线] 这是个有些争议的功能，需求(用户什么情况下需要用这个功能？)
`void`	`queryNearbyPoiTypes(android.graphics.Point center, int[] poiIds, java.lang.Object userdata)` POI类型码搜索[在线&离线]
`void`	`setCallback(PoiQuery.EventHandler callback)` 设置POI搜索回调接口[在线&离线]
`void`	`setQueryParams(int type, int value)` 设置在线搜索时的参数[在线&离线]
`boolean`	`setRegion(java.lang.String region)` 利用在线逆地理获取的城市名，设置在线搜索的行政区[在线]
`boolean`	`setWmrId(int id)` 为关键字/首字母/地址/交叉路口/公交车站/联想字搜索设置当前城市[在线&离线]
`void`	`setWmrNationWide()` 设置全国范围搜索[在线]
`void`	`sortByDefault()` 将搜索结果按照默认方式排序[离线] 比如关键字搜索按照相关度排序，周边搜索按照距离排序
`void`	`sortByDistance()` 将搜索结果按照距离排序[离线]

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

- 方法详细资料
  - getInstance
```
public static PoiQuery getInstance()
```
  - init
```
public void init(PoiQueryInitParams param)
          throws java.lang.Exception
```
    初始化搜索模块
    
    参数:
    
    param - 搜索模块参数设置PoiQueryInitParams
    
    抛出:
    
    java.lang.Exception - 如果搜索包SDK无授权，将抛出授权错误异常
    
    另请参阅:
    
    cleanup()
    
    Notice:
    
    注意：需要保证 init(PoiQueryInitParams)和 cleanup()是成对出现的，且只能在主线程中调用初始化过程。
  - cleanup
```
public void cleanup()
```
    清理搜索模块资源
    通常在应用程序退出时使用，用来清理搜索引擎所用资源
    
    另请参阅:
    
    init(PoiQueryInitParams)
    
    Notice:
    
    注意：需要保证 init(PoiQueryInitParams)和 cleanup()是成对出现的，且只能在主线程中调用销毁过程。清除资源后，会释放逆地理占用的Native资源
  - isInited
```
public boolean isInited()
```
    POI搜索模块是否已经初始化
    
    返回:
    
    初始化则返回true，否则返回false
  - setCallback
```
public void setCallback(PoiQuery.EventHandler callback)
```
    设置POI搜索回调接口[在线&离线]
    
    参数:
    
    callback - 回调接口PoiQuery.EventHandler
    
    另请参阅:
    
    PoiQuery.EventHandler
  - setQueryParams
```
public void setQueryParams(int type,
                           int value)
```
    设置在线搜索时的参数[在线&离线]
    
    参数:
    
    type - 需要设置的参数类型PoiQuery.PoiQueryParamsType
    
    value - 需要设置的参数的值
    
    另请参阅:
    
    PoiQuery.PoiQueryParamsType
  - hasNextPage
```
public boolean hasNextPage()
```
    判断是否有下一页结果[在线&离线]
    
    返回:
    
    true表示有下一页，false表示最后一页
    
    Notice:
    
    注意：此方法对在线和离线是独立的，即，同时存在在线和离线搜索结果时，当调用 PoiQuery#setMode(int)切换搜索模式时，此方法仅返回当前模式下的结果。
  - loadNextPage
```
public void loadNextPage(java.lang.Object userdata)
```
    通过回调的形式下载下一页的内容[在线&离线]
    下载完后会收到PoiQuery.Event.pageLoaded消息
    
    参数:
    
    userdata - 回调中的用户数据
    
    Notice:
    
    注意：此方法对在线和离线是独立的，即，同时存在在线和离线搜索结果时，当调用 PoiQuery#setMode(int)切换搜索模式时，此方法仅返回当前模式下的结果。
  - loadPreviousPage
```
public void loadPreviousPage(java.lang.Object userdata)
```
    通过回调的形式下载前一页的内容[在线&离线]
    下载后会收到PoiQuery.Event.pageLoaded消息
    
    参数:
    
    userdata - 回调中的用户数据
    
    Notice:
    
    注意：此方法对在线和离线是独立的，即，同时存在在线和离线搜索结果时，当调用 PoiQuery#setMode(int)切换搜索模式时，此方法仅返回当前模式下的结果。
  - getCurrentPageFirstResultIndex
```
public int getCurrentPageFirstResultIndex()
```
    获取当前页第一个元素所在索引[在线&离线]
    一般是配合着getCurrentPageLastResultIndex()方法共同使用
    用来生成当前页所需要显示的搜索结果
    
    返回:
    
    当前结果页面第一个元素在搜索结果中的下标
    
    Notice:
    
    注意：此方法对在线和离线是独立的，即，同时存在在线和离线搜索结果时，当调用 PoiQuery#setMode(int)切换搜索模式时，此方法仅返回当前模式下的结果。
  - getCurrentPageLastResultIndex
```
public int getCurrentPageLastResultIndex()
```
    获取当前页最后一个元素所在索引[在线&离线]
    一般是配合着getCurrentPageFirstResultIndex()方法共同使用
    用来生成当前页所需要显示的搜索结果
    
    返回:
    
    当前结果页面最后一个元素在搜索结果中的下标
    
    Notice:
    
    注意：此方法对在线和离线是独立的，即，同时存在在线和离线搜索结果时，当调用 PoiQuery#setMode(int)切换搜索模式时，此方法仅返回当前模式下的结果。
  - getCurrentPageIndex
```
public int getCurrentPageIndex()
```
    获取当前页码[在线&离线]
    不同模式下的页码是独立的
    
    返回:
    
    当前页码
    
    Notice:
    
    注意：此方法对在线和离线是独立的，即，同时存在在线和离线搜索结果时，当调用 PoiQuery#setMode(int)切换搜索模式时，此方法仅返回当前模式下的结果。
  - cancel
```
public void cancel()
```
    取消搜索请求[在线]
    此方法仅针对在线搜索起作用，会取消搜索请求
  - setWmrId
```
public boolean setWmrId(int id)
```
    为关键字/首字母/地址/交叉路口/公交车站/联想字搜索设置当前城市[在线&离线]
    
    参数:
    
    id - 当前城市的行政区划id
    
    返回:
    
    设置成功返回true，否则返回false
    
    Notice:
    
    注意：使用搜索前，一定要确保设置了当前城市，否则搜索会失败！
  - setRegion
```
public boolean setRegion(java.lang.String region)
```
    利用在线逆地理获取的城市名，设置在线搜索的行政区[在线]
    
    参数:
    
    region - 在线逆地理获取的城市名
    
    返回:
    
    设置成功返回true，否则返回false
  - setWmrNationWide
```
public void setWmrNationWide()
```
    设置全国范围搜索[在线]
    
    Notice:
    
    注意：对于有全国节点的数据( WorldManager)不要调用此接口，使用 setWmrId(int)来设置全国节点ID，针对离线和在线同时有效。
    此接口属于过渡性接口，用于城市数据不存在全国节点时，在线全国搜索，对离线搜索无效果。
  - getWmrId
```
public int getWmrId()
```
    返回当前搜索时所使用的城市行政区划id[在线&离线]
    
    返回:
    
    城市行政区划id
  - classifyKeyword
```
public int classifyKeyword(java.lang.String keyword,
                           java.lang.Object userdata)
```
    检查关键字分类[离线]
    普通关键字建议使用queryByKeyword(String, Point, Object)做搜索
    周边关键字建议使用queryNearbyKeyword(String, Point, Object)做搜索
    
    参数:
    
    keyword - 关键字
    
    userdata - 回调中的用户数据
    
    返回:
    
    关键字类别
    
    另请参阅:
    
    PoiQuery.KeywordType
  - queryByKeyword
```
public void queryByKeyword(java.lang.String keyword,
                           android.graphics.Point center,
                           java.lang.Object userdata)
```
    普通关键字查询[在线&离线]
    
    参数:
    
    keyword - 关键字
    
    center - 搜索中心点的地理坐标。如果传入null，则不依赖于中心点，如果传入非null则依赖中心点
    
    userdata - 回调中的用户数据
  - queryNearbyKeyword
```
public void queryNearbyKeyword(java.lang.String keyword,
                               android.graphics.Point center,
                               java.lang.Object userdata)
```
    周边关键字搜索[在线&离线]
    这是个有些争议的功能，需求(用户什么情况下需要用这个功能？)和
    定义(这个功能希望搜索出怎样的结果？)都没有弄得很清楚，
    实现出来自然也就问题多多，请尽量避免使用。
    
    参数:
    
    keyword - 关键字
    
    center - 搜索中心点，用于计算到POI的距离
    
    userdata - 回调中的用户数据
  - queryNearbyPoiTypes
```
public void queryNearbyPoiTypes(android.graphics.Point center,
                                int[] poiIds,
                                java.lang.Object userdata)
```
    POI类型码搜索[在线&离线]
    
    参数:
    
    center - 搜索中心点，用于计算到POI的距离
    
    poiIds - 要搜索的POI类型码数组
    
    userdata - 回调中的用户数据
  - queryNearby
```
public void queryNearby(android.graphics.Point center,
                        int typeIndex,
                        java.lang.Object userdata)
```
    周边搜索[在线&离线]
    
    参数:
    
    center - 搜素中心点的地理经纬度坐标
    
    typeIndex - 周边搜索的类型码索引,需要通过PoiTypeManager的相关方法来获取
    
    userdata - 回调中的用户数据
  - queryByInitial
```
public void queryByInitial(java.lang.String initial,
                           android.graphics.Point center,
                           java.lang.Object userdata)
```
    首字母搜索[离线]
    
    参数:
    
    initial - 首字母字符串
    
    center - 搜索中心点
    
    userdata - 回调中的用户数据
  - queryByAddress
```
public void queryByAddress(java.lang.String keyword,
                           android.graphics.Point center,
                           java.lang.Object userdata)
```
    地址关键字搜索[离线]
    
    参数:
    
    keyword - 地址关键字
    
    center - 搜索中心点
    
    userdata - 回调中的用户数据
  - queryCrossRoads
```
public void queryCrossRoads(java.lang.String keyword,
                            android.graphics.Point center,
                            java.lang.Object userdata)
```
    搜索路线交叉路口[离线]
    
    参数:
    
    keyword - 路口关键字
    
    center - 搜索中心点坐标
    
    userdata - 回调中的用户数据
  - queryBusStations
```
public void queryBusStations(java.lang.String keyword,
                             android.graphics.Point center,
                             java.lang.Object userdata)
```
    搜索公交站[离线]
    
    参数:
    
    keyword - 公交站关键字
    
    center - 搜索中心点坐标
    
    userdata - 回调中的用户数据
  - queryByCurrrentRoute
```
public void queryByCurrrentRoute(int poiTypeIndex,
                                 android.graphics.Point carPos,
                                 java.lang.Object userdata)
```
    沿路搜索[离线]
    路线为当前导航引擎所采纳的路线，所以此方法必须在已经开始导航的情况下使用
    
    参数:
    
    poiTypeIndex - POI类型索引
    
    carPos - 车所在位置
    
    userdata - 回调中的用户数据
  - queryByRoute
```
public void queryByRoute(RouteBase routeBase,
                         int poiTypeIndex,
                         android.graphics.Point carPos,
                         java.lang.Object userdata)
```
    沿路搜索[离线]
    
    参数:
    
    routeBase - 路线，RouteBase
    
    poiTypeIndex - POI类型索引
    
    carPos - 车所在位置
    
    userdata - 回调中的用户数据
    
    另请参阅:
    
    queryByCurrrentRoute(int, Point, Object)
  - clearResult
```
public void clearResult()
```
    清空搜索结果[在线&离线]
    一般是用来释放内存使用，当需要使用大量内存的时候，可以调用此方法释放已经不需要缓存的搜索结果数据
  - getTotalResultNumber
```
public int getTotalResultNumber()
```
    获取搜索结果总数[在线&离线]
    使用时，可能还需要loadNextPage(Object)来加载
    
    返回:
    
    搜索结果总数量
  - getResultNumber
```
public int getResultNumber()
```
    获取当前已经加载的结果数量[在线&离线]
    
    返回:
    
    已加载结果数量
  - getOnlineSpecialResult
```
public PoiFavoriteInfo getOnlineSpecialResult()
```
    返回在线搜索中的特殊结果，一般来说，特殊结果包括公交车站和公交线路[在线]
    
    返回:
    
    如果存在特殊结果，那么返回特殊结果对应的PoiFavoriteInfo,否则返回null
  - getResultAsPoiFavoriteInfo
```
public PoiFavoriteInfo getResultAsPoiFavoriteInfo(int index)
```
    将结果以POI的形式返回[在线&离线]
    
    参数:
    
    index - 对应索引值
    
    返回:
    
    符合条件的PoiFavoriteInfo
    
    另请参阅:
    
    PoiFavoriteInfo
  - getResultRoutePosition
```
public SideInfo getResultRoutePosition(int index)
```
    获取搜索到的指定索引POI所在位置相对路线的关系信息[离线]
    
    参数:
    
    index - 结果索引
    
    返回:
    
    相对路线的关系信息SideInfo
    
    另请参阅:
    
    SideInfo
  - sortByDistance
```
public void sortByDistance()
```
    将搜索结果按照距离排序[离线]
  - sortByDefault
```
public void sortByDefault()
```
    将搜索结果按照默认方式排序[离线]
    比如关键字搜索按照相关度排序，周边搜索按照距离排序
  - getRwd
```
public java.lang.String getRwd(java.lang.String input)
```
    获取联想的候选字[离线]
    
    参数:
    
    input - 输入的词
    
    返回:
    
    候选字
    
    Notice:
    
    调用前先确保设置了城市setWmrId(int),且存在离线数据

类 PoiQuery

嵌套类概要

方法概要

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

方法详细资料

getInstance

init

cleanup

isInited

setCallback

setQueryParams

hasNextPage

loadNextPage

loadPreviousPage

getCurrentPageFirstResultIndex

getCurrentPageLastResultIndex

getCurrentPageIndex

cancel

setWmrId

setRegion

setWmrNationWide

getWmrId

classifyKeyword

queryByKeyword

queryNearbyKeyword

queryNearbyPoiTypes

queryNearby

queryByInitial

queryByAddress

queryCrossRoads

queryBusStations

queryByCurrrentRoute

queryByRoute

clearResult

getTotalResultNumber

getResultNumber

getOnlineSpecialResult

getResultAsPoiFavoriteInfo

getResultRoutePosition

sortByDistance

sortByDefault

getRwd