Datastore (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.mapdal.Datastore

```
public class Datastore
extends java.lang.Object
```
要想清除对离线数据的引用，必须把下面的引用全部释放掉
1. 每个PoiSuggest实例释放掉，调用：clearResult（）
2. 每个PoiSearch实例释放掉，调用：clearResult（）
3. 每个RouteBase实例释放掉，调用：release()
4. 每个RouteOverlay实例释放掉，调用：relese()
5. 自己加的锁释放掉
6. navisession清除路线，调用：removeRoute()

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`Datastore.DataType` 数据商店类型: 可选下载离线地图数据, 离线语音包
`static class`	`Datastore.ErrorCode` 错误码
`static interface`	`Datastore.EventHandler` 事件回调
`class`	`Datastore.JsonType`

构造器概要

构造器
构造器和说明

Datastore(int dataType, java.lang.String localPath)
Datastore构造方法

构造器
构造器和说明
`Datastore(int dataType, java.lang.String localPath)` Datastore构造方法

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addEventHandler(Datastore.EventHandler datastoreEventHandler)` 设置数据商店监听
`boolean`	`cancelDataItem(java.lang.String id)` 取消数据条目下载任务
`void`	`cancelRefreshing()` 取消刷新，会收到`Datastore.EventHandler.onDatastoreRefreshCanceled()`
`boolean`	`createUpdateTaskForItem(java.lang.String id)` 创建下载任务
`void`	`deleteDataItem(java.lang.String id)` 删除数据条目下载任务，异步删除，不会立即生效
`DatastoreItem[]`	`filterNodesWithKeyword(java.lang.String keyword)` 根据关键字、拼音或首字母过滤数据节点，比如根据吉林或jilin，结果中包含吉林省和吉林市
`int`	`getCurrentServerVersion()` 获取当前版本号
`DatastoreItem`	`getDatastoreItemById(java.lang.String id)` 通过id来获取数据条目
`DataUpdateTask`	`getDataUpdateTaskWithId(java.lang.String id)` 获取对应id的下载任务
`DataUpdateTask[]`	`getDownloadTaskList()` 获取当前下载任务列表，客户端收到刷新事件`Datastore.EventHandler.onDatastoreRefreshed()`须重新获取
`static java.lang.String`	`getJsonPath(int type)` 获取数据商店信息json路径，相对于appPath
`java.lang.String`	`getLocalDataPath()` 获取本地数据存放路径
`DatastoreItem`	`getRoot()` 获取下载列表根节点，节点中包含子节点的信息，适用于一次性获取数据商店各级列表
`java.lang.String`	`getServerUrl()` 获取数据商店信息url
`static void`	`lockForReadingOfflineData(java.lang.String lockDescription)` 锁住离线数据，必须与`unlockForReadingOfflineData(String)`成对使用
`static DatastoreItem[]`	`nativeFilterNodesWithKeyword(long handle, java.lang.String keyword)`
`static void`	`nativeLockForReadingOfflineData(java.lang.String lockDescription)`
`static java.lang.String[]`	`nativeRetainLockDescriptions()`
`static void`	`nativeSaveLocalDataToJson(long handle)`
`static void`	`nativeUnlockForReadingOfflineData(java.lang.String lockDescription)`
`boolean`	`pauseDataItem(java.lang.String id)` 暂停数据条目下载任务
`void`	`release()` 释放数据商店占用的资源，销毁时必须调用
`void`	`removeEventHandler(Datastore.EventHandler datastoreEventHandler)` 删除数据商店监听
`boolean`	`resumeDataItem(java.lang.String id)` 恢复数据条目的下载任务，`pauseDataItem(String)`后才可以恢复
`static java.lang.String[]`	`retainLockDescriptions()` 返回当前正在占用离线数据的锁的信息输出锁信息日志，检索词：retainLockDescriptions
`void`	`retryDataItem(java.lang.String id)` 下载或安装失败后，重试
`void`	`saveLocalDataToJson()` 保存local.json等的数据
`void`	`setNeedsRefresh()` 刷新数据商店信息，刷新后会收到`Datastore.EventHandler.onDatastoreRefreshed()` 事件，在此回调中客户端需要重新获取整个数据列表和下载列表
`void`	`setServerVersion(int version)` 设置版本号，-1表示最新版本
`static void`	`unlockForReadingOfflineData(java.lang.String lockDescription)` 解锁离线数据，必须与`lockForReadingOfflineData(String)`成对使用

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

- 构造器详细资料
  - Datastore
```
public Datastore(int dataType,
                 java.lang.String localPath)
```
    Datastore构造方法
    
    参数:
    
    dataType - 要下载的数据类型, 可选Datastore.DataType.map 和 Datastore.DataType.voice
    
    localPath - 要下载数据的目录路径
- 方法详细资料
  - nativeFilterNodesWithKeyword
```
public static DatastoreItem[] nativeFilterNodesWithKeyword(long handle,
                                                           java.lang.String keyword)
```
  - nativeLockForReadingOfflineData
```
public static void nativeLockForReadingOfflineData(java.lang.String lockDescription)
```
  - nativeUnlockForReadingOfflineData
```
public static void nativeUnlockForReadingOfflineData(java.lang.String lockDescription)
```
  - nativeRetainLockDescriptions
```
public static java.lang.String[] nativeRetainLockDescriptions()
```
  - nativeSaveLocalDataToJson
```
public static void nativeSaveLocalDataToJson(long handle)
```
  - release
```
public void release()
```
    释放数据商店占用的资源，销毁时必须调用
  - addEventHandler
```
public void addEventHandler(Datastore.EventHandler datastoreEventHandler)
```
    设置数据商店监听
    
    参数:
    
    datastoreEventHandler - 外部eventHandler
  - removeEventHandler
```
public void removeEventHandler(Datastore.EventHandler datastoreEventHandler)
```
    删除数据商店监听
    
    参数:
    
    datastoreEventHandler - 外部eventHandler
  - getServerUrl
```
public java.lang.String getServerUrl()
```
    获取数据商店信息url
    
    返回:
    
    数据商店信息url
  - setServerVersion
```
public void setServerVersion(int version)
```
    设置版本号，-1表示最新版本
    
    参数:
    
    version - 版本号
  - getCurrentServerVersion
```
public int getCurrentServerVersion()
```
    获取当前版本号
  - getRoot
```
public DatastoreItem getRoot()
```
    获取下载列表根节点，节点中包含子节点的信息，适用于一次性获取数据商店各级列表
    
    返回:
    
    下载列表根节点
  - getLocalDataPath
```
public java.lang.String getLocalDataPath()
```
    获取本地数据存放路径
    
    返回:
    
    本地数据存放路径
  - getDataUpdateTaskWithId
```
public DataUpdateTask getDataUpdateTaskWithId(java.lang.String id)
```
    获取对应id的下载任务
    
    参数:
    
    id - 数据item id
    
    返回:
    
    下载任务
  - setNeedsRefresh
```
public void setNeedsRefresh()
```
    刷新数据商店信息，刷新后会收到Datastore.EventHandler.onDatastoreRefreshed() 事件，在此回调中客户端需要重新获取整个数据列表和下载列表
  - cancelRefreshing
```
public void cancelRefreshing()
```
    取消刷新，会收到Datastore.EventHandler.onDatastoreRefreshCanceled()
  - getDatastoreItemById
```
public DatastoreItem getDatastoreItemById(java.lang.String id)
```
    通过id来获取数据条目
    
    参数:
    
    id - 数据条目id
    
    返回:
    
    数据条目
  - createUpdateTaskForItem
```
public boolean createUpdateTaskForItem(java.lang.String id)
```
    创建下载任务
    
    参数:
    
    id - 数据条目id
    
    返回:
    
    id对应的下载条目
  - resumeDataItem
```
public boolean resumeDataItem(java.lang.String id)
```
    恢复数据条目的下载任务，pauseDataItem(String)后才可以恢复
    
    参数:
    
    id - 数据条目的id
    
    返回:
    
    是否成功
  - pauseDataItem
```
public boolean pauseDataItem(java.lang.String id)
```
    暂停数据条目下载任务
    
    参数:
    
    id - 数据条目的id
    
    返回:
    
    是否暂停成功
  - cancelDataItem
```
public boolean cancelDataItem(java.lang.String id)
```
    取消数据条目下载任务
    
    参数:
    
    id - 数据条目id
    
    返回:
    
    是否成功
  - deleteDataItem
```
public void deleteDataItem(java.lang.String id)
```
    删除数据条目下载任务，异步删除，不会立即生效
    
    参数:
    
    id - 数据条目id
  - retryDataItem
```
public void retryDataItem(java.lang.String id)
```
    下载或安装失败后，重试
    
    参数:
    
    id - 数据条目id
  - getDownloadTaskList
```
public DataUpdateTask[] getDownloadTaskList()
```
    获取当前下载任务列表，客户端收到刷新事件Datastore.EventHandler.onDatastoreRefreshed()须重新获取
    
    返回:
    
    下载任务列表
  - filterNodesWithKeyword
```
public DatastoreItem[] filterNodesWithKeyword(java.lang.String keyword)
```
    根据关键字、拼音或首字母过滤数据节点，比如根据吉林或jilin，结果中包含吉林省和吉林市
    
    参数:
    
    keyword - 关键、拼音或者首字母
    
    返回:
    
    符合过滤关键字的节点
  - getJsonPath
```
public static java.lang.String getJsonPath(int type)
```
    获取数据商店信息json路径，相对于appPath
    
    参数:
    
    type - 见Datastore.JsonType
    
    返回:
  - lockForReadingOfflineData
```
public static void lockForReadingOfflineData(java.lang.String lockDescription)
```
    锁住离线数据，必须与unlockForReadingOfflineData(String)成对使用
    
    参数:
    
    lockDescription - 锁的id，解锁时必须传入相同的id
  - unlockForReadingOfflineData
```
public static void unlockForReadingOfflineData(java.lang.String lockDescription)
```
    解锁离线数据，必须与lockForReadingOfflineData(String)成对使用
    
    参数:
    
    lockDescription - 锁的id，加锁时必须传入相同的id
  - retainLockDescriptions
```
public static java.lang.String[] retainLockDescriptions()
```
    返回当前正在占用离线数据的锁的信息输出锁信息日志，检索词：retainLockDescriptions
  - saveLocalDataToJson
```
public void saveLocalDataToJson()
```
    保存local.json等的数据

类 Datastore

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

Datastore

方法详细资料

nativeFilterNodesWithKeyword

nativeLockForReadingOfflineData

nativeUnlockForReadingOfflineData

nativeRetainLockDescriptions

nativeSaveLocalDataToJson

release

addEventHandler

removeEventHandler

getServerUrl

setServerVersion

getCurrentServerVersion

getRoot

getLocalDataPath

getDataUpdateTaskWithId

setNeedsRefresh

cancelRefreshing

getDatastoreItemById

createUpdateTaskForItem

resumeDataItem

pauseDataItem

cancelDataItem

deleteDataItem

retryDataItem

getDownloadTaskList

filterNodesWithKeyword

getJsonPath

lockForReadingOfflineData

unlockForReadingOfflineData

retainLockDescriptions

saveLocalDataToJson