SQLiteOfflineAdapter

包	mx.data
类	public class SQLiteOfflineAdapter
继承	SQLiteOfflineAdapter DataServiceOfflineAdapter Object

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

为 DataManager 的脱机缓存项提供基于 SQLite 的持久格式。实质上，每个项都将作为一行持久保存在名为 Entity_<destination> 的表中，且每一列都是该项的字段名称。

重写 getQueryCriteria() 方法（也可能是 getQueryCriteriaParameters()）以实现自定义本地查询。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object

受保护的属性

隐藏继承的受保护属性

显示继承的受保护属性

	属性		由以下参数定义
		destination : String [只读] 指示与此脱机适配器相关联的目标。	DataServiceOfflineAdapter

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		SQLiteOfflineAdapter() 构造函数。	SQLiteOfflineAdapter
		addOfflineItem(item:Object):void [覆盖] 向 localStore 中添加指定的脱机项。	SQLiteOfflineAdapter
		appendItemData(archiveData:IDataOutput, version:String, changedItems:ChangedItems):void 追加到指定数据项的字节数组。	SQLiteOfflineAdapter
		beginTransaction():void 针对 localStore 开始事务。	DataServiceOfflineAdapter
		close():void 关闭与此适配器相关联的 localStore。	DataServiceOfflineAdapter
		commit(dispatcher:IEventDispatcher = null, token:mx.rpc:AsyncToken = null, faultsOnly:Boolean = false):void 向本地存储提交当前的所有更改。	DataServiceOfflineAdapter
		connect(cacheID:String):mx.rpc:AsyncToken 连接指定缓存。	DataServiceOfflineAdapter
		deleteOfflineItem(uid:String):void [覆盖] 根据匹配的 uid，在本地存储中删除指定的脱机项。	SQLiteOfflineAdapter
		deleteOfflineItems(uidArray:Array):void 根据匹配的 uid，在本地存储中删除指定的一组脱机项。	DataServiceOfflineAdapter
		executeOfflineQuery(propSpecifier:PropertySpecifier, args:Array, startIndex:int, numItems:int):mx.rpc:AsyncToken [覆盖] 用于 SQLite 适配器以本地执行动态查询。	SQLiteOfflineAdapter
		exportItemData(version:String, changedItems:ChangedItems):ByteArray 生成指定数据项的新序列化归档，之后可在必要时对其进行持久保存。	SQLiteOfflineAdapter
		getFillList():Array 返回在本地存储中缓存的当前文件。	DataServiceOfflineAdapter
		getItemReferenceIds(uid:String, propName:String):Array [覆盖] 获取给定项 uid 的关联项的 ID 和关联属性。	SQLiteOfflineAdapter
		getItems(uidArray:Array):Dictionary [覆盖] 恢复使用为给定目标指定的 uid 数组指定的所有项。	SQLiteOfflineAdapter
		getMessageCache():Object 恢复脱机存储中的消息缓存。	DataServiceOfflineAdapter
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		importItemData(expectedVersion:String, archiveData:IDataInput):mx.rpc:AsyncToken 从字节数组导入归档的已更改项实例，该数组通常来自一个文件。	SQLiteOfflineAdapter
		importItems(changedItems:ChangedItems):mx.rpc:AsyncToken 将归档数据项导入本地缓存。	SQLiteOfflineAdapter
		initializeCacheStore():void 初始化 cacheId 存储。	DataServiceOfflineAdapter
		initializeOfflineMetadata(metadata:Metadata):void [覆盖] 初始化脱机缓存。	SQLiteOfflineAdapter
		isConnected():Boolean 如果本地存储为“connected”（例如，已打开本地数据库），则返回 true。	DataServiceOfflineAdapter
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		isQuerySupported():Boolean [覆盖] 指示适配器是否支持执行查询。	SQLiteOfflineAdapter
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		restoreQuery(queryParams:Object):Object 恢复查询。	DataServiceOfflineAdapter
		retrieveMetaData():Object 查找给定目标的元数据。	DataServiceOfflineAdapter
		rollback():void 回滚本地存储中当前所有更改。	DataServiceOfflineAdapter
		saveItems(items:Array):void [覆盖] 添加/删除字典中指定的所有项。	SQLiteOfflineAdapter
		saveMessageCache(messageCache:DataMessageCache, unmergedMessages:Array):void 保存挂起的未提交消息，并取消合并消息。	DataServiceOfflineAdapter
		saveMetaData(metadata:Object):void 保存给定目标的元数据配置。	DataServiceOfflineAdapter
		saveQuery(queryParams:Object, data:Object):void 保存稍后要脱机重演的查询。	DataServiceOfflineAdapter
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		updateOfflineItem(item:Object, propChangeList:Array):void [覆盖] 更新本地存储中指定脱机项的指定属性。	SQLiteOfflineAdapter
		updateOfflineItems(itemUpdates:Dictionary):void [覆盖] 这用于将已修改的项更新到本地存储中。	SQLiteOfflineAdapter
		valueOf():Object 返回指定对象的原始值。	Object

受保护的方法

	方法		由以下参数定义
		getFieldColumnName(fieldName:String):String 返回指定字段的列名称，如果该字段中没有列，则返回 null。	SQLiteOfflineAdapter
		getQueryCriteria(args:Array):String OfflineAdapter 实现应使用一个实现来重写此方法，该实现根据给定的一组 fill 参数来返回相应的 SQL WHERE 子句。	SQLiteOfflineAdapter
		getQueryCriteriaParameters(args:Array):Object OfflineAdapter 实现应使用一个实现来重写此方法，该实现返回的值用于替代 getQueryCriteria 中 WHERE 子句的参数的值。	SQLiteOfflineAdapter
		getQueryOrder(args:Array):String OfflineAdapter 实现应使用一个实现来重写此方法，该实现根据给定的一组 fill 参数来返回相应的 SQL ORDER BY 子句。	SQLiteOfflineAdapter
		getTargetColumnName(referencePath:Array):String 返回指定路径的列名称。	SQLiteOfflineAdapter
		getTargetTableName(referencePath:Array):String 转到指定路径查找负责属性路径的表。	SQLiteOfflineAdapter
		getUIDColumnName():String 获取包含实体项 UID 值的列。	SQLiteOfflineAdapter
		internalExecuteOfflineQuery(sqlText:String, parameters:Object, startIndex:int, numItems:int):mx.rpc:AsyncToken 对本地存储执行 SQL 查询，并返回强类型项的集合。	SQLiteOfflineAdapter

构造函数详细信息

()

构造函数

public function SQLiteOfflineAdapter()

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

方法详细信息

addOfflineItem

()

方法

override public function addOfflineItem(item:Object):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

向 localStore 中添加指定的脱机项。

参数

item:Object — 保存至本地存储的项。

appendItemData

()

方法

public function appendItemData(archiveData:IDataOutput, version:String, changedItems:ChangedItems):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 4.5

运行时版本:

Flash Player 10.1, AIR 2.0

追加到指定数据项的字节数组。使用该方法将多个数据服务（数据管理器）归档聚合在一起。

参数

	`archiveData:IDataOutput` — - 要追加到的输出流。

	`version:String` — - 要针对其执行格式不匹配检查的版本号。意图是仅在数据格式更改时做出更改。

	`changedItems:ChangedItems` — - 描述要导入本地缓存的已创建项、已更新项和已删除项。请注意，必须指定时间戳和 fillParameters，以允许随后的 synchronizeFill() 调用能正常工作来匹配导入的数据。

deleteOfflineItem

()

方法

override public function deleteOfflineItem(uid:String):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

根据匹配的 uid，在本地存储中删除指定的脱机项。

参数

uid:String — 要删除的项的 uid。

executeOfflineQuery

()

方法

override public function executeOfflineQuery(propSpecifier:PropertySpecifier, args:Array, startIndex:int, numItems:int):mx.rpc:AsyncToken

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

用于 SQLite 适配器以本地执行动态查询。

此函数的默认实现按照以下方式为查询构建 SQL 语句：

SELECT 子句将基于传入的属性说明符。
WHERE 子句将通过调用 getQueryCriteria() 来确定，对于给定的一组 fill 参数，自定义实现应重写该函数来返回相应的 WHERE 子句。
LIMIT（选定项的范围）子句将由 items 参数的起始索引和编号来确定。

构造整个 SQL 语句之后，将其传递到 internalExecuteOfflineQuery 以执行。

如果要自行执行完整的 SQL 语句创建过程，自定义实现应仅重写此方法。

参数

	`propSpecifier:PropertySpecifier` — 属性说明符确定查询的 SELECT 子句

	`args:Array` — 填充自定义实现所使用的参数，以确定查询的 WHERE 子句

	`startIndex:int` — 分页查询的起始索引

	`numItems:int` — 要为分页查询检索的项数，如果为 -1，则表示检索所有项。

mx.rpc:AsyncToken — AsyncToken，其结果为强类型项的数组

exportItemData

()

方法

public function exportItemData(version:String, changedItems:ChangedItems):ByteArray

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 4.5

运行时版本:

Flash Player 10.1, AIR 2.0

生成指定数据项的新序列化归档，之后可在必要时对其进行持久保存。

参数

	`version:String` — - 要针对其执行格式不匹配检查的版本号。意图是仅在数据格式更改时做出更改。

	`changedItems:ChangedItems` — - 描述要导入本地缓存的已创建项、已更新项和已删除项。请注意，必须指定时间戳和 fillParameters，以允许随后的 synchronizeFill() 调用能正常工作来匹配导入的数据。

ByteArray — 序列化数据的 ByteArray。

getFieldColumnName

()

方法

protected function getFieldColumnName(fieldName:String):String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

返回指定字段的列名称，如果该字段中没有列，则返回 null。

默认情况下，列名称与字段名称相同，但是如果名称带有前缀“_”，则会与 SQLite 关键字冲突，此时列名称与字段名称不相同。

参数

fieldName:String — 字段的名称。

String — 给定字段的列名称。

getItemReferenceIds

()

方法

override public function getItemReferenceIds(uid:String, propName:String):Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

获取给定项 uid 的关联项的 ID 和关联属性。仅针对 SQLLite 实现才支持.

参数

	`uid:String` — 拥有关联的项的 uid。

	`propName:String` — 关联属性名称。

Array — 关联的引用项的 ID 数组。

getItems

()

方法

override public function getItems(uidArray:Array):Dictionary

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

恢复使用为给定目标指定的 uid 数组指定的所有项。

参数

uidArray:Array — 要访存的 uid 的数组

Dictionary — uid 到项的映射

getQueryCriteria

()

方法

protected function getQueryCriteria(args:Array):String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

OfflineAdapter 实现应使用一个实现来重写此方法，该实现根据给定的一组 fill 参数来返回相应的 SQL WHERE 子句。WHERE 子句应与上下文中为脱机存储目标而生成的架构保持一致。此架构的约定为：项类属性名称与其存储表中的列名称一一对应。

请注意，WHERE 子句可能仅引用到上下文中目标的表后备项的列。

executeOfflineQuery 调用此方法，以确定执行查询所使用的 WHERE 子句。

参数

args:Array — fill 参数。

String — 针对相应 fill 参数的 SQL WHERE 子句。如果针对相应 fill 参数无需使用 WHERE 子句，则返回 null。默认实现为所有 fill 参数返回 null。

getQueryCriteriaParameters

()

方法

protected function getQueryCriteriaParameters(args:Array):Object

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

OfflineAdapter 实现应使用一个实现来重写此方法，该实现返回的值用于替代 getQueryCriteria 中 WHERE 子句的参数的值。

executeOfflineQuery() 方法调用此方法以确定执行查询所需的替换。

参数

args:Array — fill 参数。

Object — 具有键值对的对象。这些键表示要替换的参数名称，这些值对应于替换值。可以使用整数键来替换位置参数。默认实现返回 null。

getQueryOrder

()

方法

protected function getQueryOrder(args:Array):String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

OfflineAdapter 实现应使用一个实现来重写此方法，该实现根据给定的一组 fill 参数来返回相应的 SQL ORDER BY 子句。ORDER BY 子句应与上下文中为脱机存储目标而生成的架构保持一致。此架构的约定为：项类属性名称与其存储表中的列名称一一对应。请注意，ORDER BY 子句可能仅引用到上下文中目标的表后备项的列。

executeOfflineQuery() 方法调用此方法，以确定执行查询所使用的 ORDER BY 子句。

参数

args:Array — fill 参数。

String — 针对相应 fill 参数的 SQL ORDER BY 子句。默认实现返回该 UID 的列名称。

getTargetColumnName

()

方法

protected function getTargetColumnName(referencePath:Array):String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

返回指定路径的列名称。请注意，列名称可能存储在不同的表中。此例程主要用于辅助模型生成代码。

参数

referencePath:Array — path

String — 与路径相对应的列名称，如果不存在，则为 null

getTargetTableName

()

方法

protected function getTargetTableName(referencePath:Array):String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

转到指定路径查找负责属性路径的表。此例程主要用于辅助模型生成代码。

参数

referencePath:Array — path

String — 表名称

getUIDColumnName

()

方法

protected function getUIDColumnName():String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

获取包含实体项 UID 值的列。

String — 包含实体项 UID 值的列。

importItemData

()

方法

public function importItemData(expectedVersion:String, archiveData:IDataInput):mx.rpc:AsyncToken

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 4.5

运行时版本:

Flash Player 10.1, AIR 2.0

从字节数组导入归档的已更改项实例，该数组通常来自一个文件。

参数

	`expectedVersion:String` — - 归档的预期版本。如果归档版本不匹配，则会引发一个错误。

	`archiveData:IDataInput` — - AMF 序列化 changedItem 实例，如下所述：{

mx.rpc:AsyncToken — 指示项已应用于本地缓存的时间的 AsyncToken。

importItems

()

方法

public function importItems(changedItems:ChangedItems):mx.rpc:AsyncToken

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 4.5

运行时版本:

Flash Player 10.1, AIR 2.0

将归档数据项导入本地缓存。

参数

changedItems:ChangedItems — - 描述要导入本地缓存的已创建项、已更新项和已删除项。请注意，必须指定 resultTimestamp 和 fillParameters，以允许随后的 synchronizeFill() 调用能正常工作来匹配导入的数据。

mx.rpc:AsyncToken — 指示项已应用于本地缓存的时间的 AsyncToken。

initializeOfflineMetadata

()

方法

override public function initializeOfflineMetadata(metadata:Metadata):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

初始化脱机缓存。仅针对 SQLLite 实现才支持.

参数

metadata:Metadata — 描述目标的元数据。

internalExecuteOfflineQuery

()

方法

 protected function internalExecuteOfflineQuery(sqlText:String, parameters:Object, startIndex:int, numItems:int):mx.rpc:AsyncToken

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

对本地存储执行 SQL 查询，并返回强类型项的集合。

参数

	`sqlText:String` — 执行查询所使用的 SQL 子句，由 `executeOfflineQuery()` 方法在 `getQueryCriteria()` 方法的帮助下确定。

	`parameters:Object` — 键值对的映射，用于参数替换

	`startIndex:int` — 分页的起始索引

	`numItems:int` — 要获取的项数，-1 表示返回所有项

mx.rpc:AsyncToken — AsyncToken，其结果为强类型项的数组

isQuerySupported

()

方法

override public function isQuerySupported():Boolean

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

指示适配器是否支持执行查询。要支持执行查询，此适配器的实现必须实现 getQueryCriteria() 方法或重写 executeOfflineQuery() 方法。默认情况下，该值设置为 false。

Boolean — 如果适配器支持查询执行，则为 true。

saveItems

()

方法

override public function saveItems(items:Array):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

添加/删除字典中指定的所有项。如果字典中包含托管对象，则将其持久保存到本地存储中。如果其中包含 UID（作为键），则从存储中删除该项。

参数

items:Array — 要保存的项的数组

updateOfflineItem

()

方法

override public function updateOfflineItem(item:Object, propChangeList:Array):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

更新本地存储中指定脱机项的指定属性。属性更改列表不会用于默认本地共享对象实现，因为不需要。

参数

	`item:Object` — 要更新的项，包含新值。

	`propChangeList:Array` — 要更新的属性列表。

updateOfflineItems

()

方法

override public function updateOfflineItems(itemUpdates:Dictionary):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

运行时版本:

Flash Player 9, AIR 1.1

这用于将已修改的项更新到本地存储中。这将载入一个目录，在其中传递的键是更新的项本身，其值是属性更改的数组。属性更改列表不会用于默认本地共享对象实现，因为不需要。

参数

itemUpdates:Dictionary — 项到已更改属性数组的映射

法律声明 | 在线隐私策略

SQLiteOfflineAdapter - AS3 ADEP Data Services

类 x