BusQuery (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.bus.BusQuery

```
public final class BusQuery
extends java.lang.Object
```
公交搜索接口

Notice:

注意：所有的API调用应该保证都是在主线程中

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`BusQuery.Event` 回调接口事件类型
`static interface`	`BusQuery.Listener` 发起搜索的回调接口
`class`	`BusQuery.Option` 查询结果有效字段选项 [在线]

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`cancel()` 取消当前查询
`void`	`cleanup()` 模块引擎销毁清理资源
`static BusQuery`	`getInstance()` 获取单例类的实例
`BusLine`	`getResultAsBusLine(int index)` 根据索引获取查询结果集中的公交线路信息
`BusLine[]`	`getResultAsBusLine(int start, int end)` 已过时。
`BusLine[]`	`getResultAsBusLines(int start, int number)` 根据索引区间获取查询结果集中的公交线路信息，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, `getResultNumber()`) 此方法效率高于通过单个索引获取结果的效率
`BusRoute`	`getResultAsBusRoute(int index)` 根据索引获取查询结果集中的换乘路段信息(包括公交线路，步行路和地铁线路)
`BusRoute[]`	`getResultAsBusRoute(int start, int end)` 已过时。
`BusRoute[]`	`getResultAsBusRoutes(int start, int number)` 根据索引区间获取查询结果集中的换乘路段信息(包括公交线路，步行路和地铁线路)，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, `getResultNumber()`) 此方法效率高于通过单个索引获取结果的效率
`BusStation`	`getResultAsStation(int index)` 根据索引获取查询结果集中的站点(公交/地铁)信息
`BusStation[]`	`getResultAsStation(int start, int end)` 已过时。
`BusStation[]`	`getResultAsStations(int start, int number)` 根据索引区间获取查询结果集中的站点(公交/地铁)信息，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, `getResultNumber()`) 此方法效率高于通过单个索引获取结果的效率
`SubwayEntrance`	`getResultAsSubwayEntrance(int index)` 根据索引获取查询结果集中的地铁入口信息
`SubwayEntrance[]`	`getResultAsSubwayEntrance(int start, int end)` 已过时。
`SubwayEntrance[]`	`getResultAsSubwayEntrances(int start, int number)` 根据索引区间获取查询结果集中的地铁入口信息，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, `getResultNumber()`) 此方法效率高于通过单个索引获取结果的效率
`int`	`getResultNumber()` 获取本次查询的结果个数
`int`	`getWmrId()` 获取设置的搜索城市Id
`boolean`	`init(BusQueryInitParams params)` 模块引擎初始化，必须在使用模块的其他功能之前调用此方法，且不能重复调用，需要和`cleanup()`成对出现
`boolean`	`isInited()` 公交搜索模块是否初始化过
`void`	`queryBusLineDetail(BusLine line)` 根据公交线路id查询线路详细信息 [在线] 通过`getResultAsBusLine(int)` 获取查询结果，所有字段有效
`void`	`queryBusLinesByKeyword(java.lang.String keyword, int options, boolean suggestOnly)` 根据关键字查询所有包含此关键字的公交线路 [在线] 通过 `getResultAsBusLine(int)`或 `getResultAsBusLines(int, int)` 获取查询结果
`void`	`queryBusLinesByPosition(android.graphics.Point point, int options)` 根据指定经纬度获取周边的公交线路信息，返回多条匹配的线路信息[在线] 通过 `getResultAsBusLine(int)`或 `getResultAsBusLines(int, int)` 获取查询结果
`void`	`queryBusLinesByStation(java.lang.String name, int options)` 根据公交站点名称查询途径的公交线路，返回多条路线 [在线] 通过 `getResultAsBusLine(int)`或 `getResultAsBusLines(int, int)` 获取查询结果
`void`	`queryBusRoutes(BusRoutePlan plan)` 给定起点和终点，查询换乘信息 [在线] 通过`getResultAsBusRoute(int)`或 `getResultAsBusRoutes(int, int)`获取结果
`void`	`queryBusRoutesWalkOnly(BusRoutePlan plan)` 给定起点和终点，查询步行换乘信息 [在线] 通过`getResultAsBusRoute(int)`或 `getResultAsBusRoutes(int, int)`获取结果
`void`	`queryStationsByKeyword(java.lang.String keyword, int options, boolean suggestOnly)` 根据关键字查询公交站点，返回多个匹配的公交站点 [在线] 通过 `getResultAsStation(int)`或 `getResultAsStations(int, int)` 获取结果
`void`	`queryStationsByPosition(android.graphics.Point pos, int options)` 根据输入的经纬度取周边的站点信息，返回多条站点信息 [在线] 通过 `getResultAsStation(int)`或 `getResultAsStations(int, int)` 获取结果
`void`	`querySubwayEntrances(java.lang.String stationName)` 根据地铁站点名称查询入口信息，返回多条信息 [在线] 通过 `getResultAsSubwayEntrance(int)`或 `getResultAsSubwayEntrances(int, int)`获取结果
`void`	`setHost(java.lang.String host)` 设置主站host，完整搜索URL中"?"
`void`	`setWmrId(int id)` 设置城市当前城市ID，必须要设置，否则总是搜索失败

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

- 方法详细资料
  - getInstance
```
public static BusQuery getInstance()
```
    获取单例类的实例
    
    返回:
    
    该单例类BusQuery的实例
  - init
```
public boolean init(BusQueryInitParams params)
             throws java.lang.Exception
```
    模块引擎初始化，必须在使用模块的其他功能之前调用此方法，且不能重复调用，需要和cleanup()成对出现
    
    参数:
    
    params - 初始化参数BusQueryInitParams
    
    返回:
    
    没有wmr文件导致初始化失败时返回false，否则返回true
    
    抛出:
    
    java.lang.Exception
    
    另请参阅:
    
    BusQueryInitParams
    
    Notice:
    
    注意：模块初始化过程必须在主线程中调用。
  - cleanup
```
public void cleanup()
```
    模块引擎销毁清理资源
    
    Notice:
    
    注意：模块销毁过程必须在主线程中调用。
  - isInited
```
public boolean isInited()
```
    公交搜索模块是否初始化过
    
    返回:
    
    如果初始化过则返回true,否则返回false
  - setHost
```
public void setHost(java.lang.String host)
```
    设置主站host，完整搜索URL中"?"之前的部分，不含搜索参数
    
    参数:
    
    host - HOST字符串
  - setWmrId
```
public void setWmrId(int id)
```
    设置城市当前城市ID，必须要设置，否则总是搜索失败
    
    参数:
    
    id - 城市ID，通过WorldManager相关API获取
  - getWmrId
```
public int getWmrId()
```
    获取设置的搜索城市Id
    
    返回:
    
    已经设置的城市ID
  - queryBusLinesByKeyword
```
public void queryBusLinesByKeyword(java.lang.String keyword,
                                   int options,
                                   boolean suggestOnly)
```
    根据关键字查询所有包含此关键字的公交线路 [在线]
    通过 getResultAsBusLine(int)或 getResultAsBusLines(int, int) 获取查询结果
    
    参数:
    
    keyword - 查询关键字
    
    options - 设置返回结果中有效字段选项BusQuery.Option [未实现]
    
    suggestOnly - 为true时不做实际查询，快速提示用，查询结果中只有BusLine.name 字段有效
  - queryBusLinesByPosition
```
public void queryBusLinesByPosition(android.graphics.Point point,
                                    int options)
```
    根据指定经纬度获取周边的公交线路信息，返回多条匹配的线路信息[在线]
    通过 getResultAsBusLine(int)或 getResultAsBusLines(int, int) 获取查询结果
    
    参数:
    
    point - 经纬度
    
    options - 设置返回结果中有效字段选项BusQuery.Option [未实现]
    
    Notice:
    
    在线查询的base url是 http://mobilebus.mapbar.com/bus/
  - queryBusLinesByStation
```
public void queryBusLinesByStation(java.lang.String name,
                                   int options)
```
    根据公交站点名称查询途径的公交线路，返回多条路线 [在线]
    通过 getResultAsBusLine(int)或 getResultAsBusLines(int, int) 获取查询结果
    
    参数:
    
    name - 公交站点名称BusStation.name
    
    options - 设置返回结果中有效字段选项BusQuery.Option [未实现]
  - queryBusLineDetail
```
public void queryBusLineDetail(BusLine line)
```
    根据公交线路id查询线路详细信息 [在线]
    通过getResultAsBusLine(int) 获取查询结果，所有字段有效
    
    参数:
    
    line - 公交线路
  - queryStationsByKeyword
```
public void queryStationsByKeyword(java.lang.String keyword,
                                   int options,
                                   boolean suggestOnly)
```
    根据关键字查询公交站点，返回多个匹配的公交站点 [在线]
    通过 getResultAsStation(int)或 getResultAsStations(int, int) 获取结果
    
    参数:
    
    keyword - 查询关键字
    
    options - 设置返回结果中有效字段选项 BusQuery.Option [未实现]
    
    suggestOnly - 为true时不做实际查询，快速提示用，查询结果中只有 BusStation.name字段有效
  - queryStationsByPosition
```
public void queryStationsByPosition(android.graphics.Point pos,
                                    int options)
```
    根据输入的经纬度取周边的站点信息，返回多条站点信息 [在线]
    通过 getResultAsStation(int)或 getResultAsStations(int, int) 获取结果
    
    参数:
    
    pos - 经纬度
    
    options - 设置返回结果中有效字段选项 BusQuery.Option [未实现]
  - querySubwayEntrances
```
public void querySubwayEntrances(java.lang.String stationName)
```
    根据地铁站点名称查询入口信息，返回多条信息 [在线]
    通过 getResultAsSubwayEntrance(int)或 getResultAsSubwayEntrances(int, int)获取结果
    
    参数:
    
    stationName - 地铁站
  - queryBusRoutes
```
public void queryBusRoutes(BusRoutePlan plan)
```
    给定起点和终点，查询换乘信息 [在线]
    通过getResultAsBusRoute(int)或 getResultAsBusRoutes(int, int)获取结果
    
    参数:
    
    plan - 查询路线规划
  - queryBusRoutesWalkOnly
```
public void queryBusRoutesWalkOnly(BusRoutePlan plan)
```
    给定起点和终点，查询步行换乘信息 [在线]
    通过getResultAsBusRoute(int)或 getResultAsBusRoutes(int, int)获取结果
    
    参数:
    
    plan - 查询路线规划
  - cancel
```
public void cancel()
```
    取消当前查询
    
    Notice:
    
    在线查询模式有效；如果查询已经结束，则取消操作不起作用
  - getResultNumber
```
public int getResultNumber()
```
    获取本次查询的结果个数
    
    返回:
    
    查询结果个数
    
    Notice:
    
    注意：此方法只能在回调中调用，在调用 getResultAsxxx 前调用
  - getResultAsBusLine
```
public BusLine getResultAsBusLine(int index)
```
    根据索引获取查询结果集中的公交线路信息
    
    参数:
    
    index - 线路索引
    
    返回:
    
    该公交线路的详细信息BusLine,如果指定索引不存在，则返回null
    
    另请参阅:
    
    getResultAsBusLines(int, int)
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsBusLines
```
public BusLine[] getResultAsBusLines(int start,
                                     int number)
```
    根据索引区间获取查询结果集中的公交线路信息，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, getResultNumber())
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    number - 个数
    
    返回:
    
    公交线路BusLine数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsBusLine
```
public BusLine[] getResultAsBusLine(int start,
                                    int end)
```
    已过时。
    
    根据索引区间获取查询结果集中的公交线路信息，索引区间为闭区间
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    end - 结束位置
    
    返回:
    
    公交线路BusLine数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsStation
```
public BusStation getResultAsStation(int index)
```
    根据索引获取查询结果集中的站点(公交/地铁)信息
    
    参数:
    
    index - 结果集中的索引值
    
    返回:
    
    该站点的详细信息BusStation，如果指定索引不存在，返回null
    
    另请参阅:
    
    getResultAsStations(int, int)
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsStations
```
public BusStation[] getResultAsStations(int start,
                                        int number)
```
    根据索引区间获取查询结果集中的站点(公交/地铁)信息，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, getResultNumber())
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    number - 个数
    
    返回:
    
    公交站点BusStation数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsStation
```
public BusStation[] getResultAsStation(int start,
                                       int end)
```
    已过时。
    
    根据索引区间获取查询结果集中的站点(公交/地铁)信息，索引区间为闭区间
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    end - 结束位置
    
    返回:
    
    公交站点BusStation数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsBusRoute
```
public BusRoute getResultAsBusRoute(int index)
```
    根据索引获取查询结果集中的换乘路段信息(包括公交线路，步行路和地铁线路)
    
    参数:
    
    index - 换乘路段的索引
    
    返回:
    
    换乘路段详细信息BusRoute，如果指定索引不存在，返回null
    
    另请参阅:
    
    getResultAsBusRoutes(int, int)
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsBusRoutes
```
public BusRoute[] getResultAsBusRoutes(int start,
                                       int number)
```
    根据索引区间获取查询结果集中的换乘路段信息(包括公交线路，步行路和地铁线路)，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, getResultNumber())
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    number - 个数
    
    返回:
    
    换乘路段BusRoute数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsBusRoute
```
public BusRoute[] getResultAsBusRoute(int start,
                                      int end)
```
    已过时。
    
    根据索引区间获取查询结果集中的换乘路段信息(包括公交线路，步行路和地铁线路)，索引区间为闭区间
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    end - 结束位置
    
    返回:
    
    换乘路段BusRoute数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsSubwayEntrance
```
public SubwayEntrance getResultAsSubwayEntrance(int index)
```
    根据索引获取查询结果集中的地铁入口信息
    
    参数:
    
    index - 地铁入口索引
    
    返回:
    
    地铁入口详细信息SubwayEntrance，如果指定索引不存在，返回null
    
    另请参阅:
    
    getResultAsSubwayEntrances(int, int)
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsSubwayEntrances
```
public SubwayEntrance[] getResultAsSubwayEntrances(int start,
                                                   int number)
```
    根据索引区间获取查询结果集中的地铁入口信息，索引区间用开始位置和长度表示，例如获取全部结果的参数为(0, getResultNumber())
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    number - 个数
    
    返回:
    
    地铁入口SubwayEntrance数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()
  - getResultAsSubwayEntrance
```
public SubwayEntrance[] getResultAsSubwayEntrance(int start,
                                                  int end)
```
    已过时。
    
    根据索引区间获取查询结果集中的地铁入口信息，索引区间为闭区间
    此方法效率高于通过单个索引获取结果的效率
    
    参数:
    
    start - 开始位置
    
    end - 结束位置
    
    返回:
    
    地铁入口SubwayEntrance数组, 未初始化时返回null
    
    Notice:
    
    注意：此方法只能在回调中调用，调用前应先调用 getResultNumber()

类 BusQuery

嵌套类概要

方法概要

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

方法详细资料

getInstance

init

cleanup

isInited

setHost

setWmrId

getWmrId

queryBusLinesByKeyword

queryBusLinesByPosition

queryBusLinesByStation

queryBusLineDetail

queryStationsByKeyword

queryStationsByPosition

querySubwayEntrances

queryBusRoutes

queryBusRoutesWalkOnly

cancel

getResultNumber

getResultAsBusLine

getResultAsBusLines

getResultAsBusLine

getResultAsStation

getResultAsStations

getResultAsStation

getResultAsBusRoute

getResultAsBusRoutes

getResultAsBusRoute

getResultAsSubwayEntrance

getResultAsSubwayEntrances

getResultAsSubwayEntrance