SQLiteOfflineAdapter

(Preview)

Package	mx.data
Class	public class SQLiteOfflineAdapter
Inheritance	SQLiteOfflineAdapter DataServiceOfflineAdapter Object

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Provides a SQLite-based persistence format for a DataManager's offline cached items. Essentially each item is persisted as a row in a table named Entity_<destination>, with each column being a field name of the item.

Override the getQueryCriteria() method and possibly the getQueryCriteriaParameters() to implement custom local queries.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		destination : String [read-only] Indicates the destination associated with this offline adapter.	DataServiceOfflineAdapter

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SQLiteOfflineAdapter()	SQLiteOfflineAdapter
		addOfflineItem(item:Object):void [override]	SQLiteOfflineAdapter
		beginTransaction():void Begins a transaction on the localStore.	DataServiceOfflineAdapter
		close():void Closes the localStore associated with this adapter.	DataServiceOfflineAdapter
		commit(dispatcher:IEventDispatcher = null, token:mx.rpc:AsyncToken = null, faultsOnly:Boolean = false):void Commits any current changes to the local store.	DataServiceOfflineAdapter
		connect(cacheID:String):mx.rpc:AsyncToken Connect to the specified cache.	DataServiceOfflineAdapter
		deleteOfflineItem(uid:String):void [override]	SQLiteOfflineAdapter
		deleteOfflineItems(uidArray:Array):void Deletes the specified set of offine items with the matching uids from the local store.	DataServiceOfflineAdapter
		executeOfflineQuery(propSpecifier:PropertySpecifier, args:Array, startIndex:int, numItems:int):mx.rpc:AsyncToken [override] Used with SQLite adapters to execute dynamic queries locally.	SQLiteOfflineAdapter
		getFillList():Array Returns the current fills that have been cached in the local store.	DataServiceOfflineAdapter
		getItemReferenceIds(uid:String, propName:String):Array [override]	SQLiteOfflineAdapter
		getItems(uidArray:Array):Dictionary [override]	SQLiteOfflineAdapter
		getMessageCache():Object Restores the message cache from the offline store.	DataServiceOfflineAdapter
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initializeCacheStore():void Initialize the cacheId store.	DataServiceOfflineAdapter
		initializeOfflineMetadata(metadata:Metadata):void [override]	SQLiteOfflineAdapter
		isConnected():Boolean Returns true if the local store is "connected"; for example, if the local database is open.	DataServiceOfflineAdapter
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		isQuerySupported():Boolean [override] Indicates whether the adapter supports query execution.	SQLiteOfflineAdapter
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		restoreQuery(queryParams:Object):Object Restores queries.	DataServiceOfflineAdapter
		retrieveMetaData():Object Look up the metadata for a given destination.	DataServiceOfflineAdapter
		rollback():void Rolls back any current changes on the local store.	DataServiceOfflineAdapter
		saveItems(items:Array):void [override]	SQLiteOfflineAdapter
		saveMessageCache(messageCache:DataMessageCache, unmergedMessages:Array):void Saves the pending uncommitted messages and unmerges messages.	DataServiceOfflineAdapter
		saveMetaData(metadata:Object):void Save the meta data configuration for a given destination.	DataServiceOfflineAdapter
		saveQuery(queryParams:Object, data:Object):void Saves queries to be replayed offline later.	DataServiceOfflineAdapter
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateOfflineItem(item:Object, propChangeList:Array):void [override] Used to update a particular item with the properties that were updated to the offline store.	SQLiteOfflineAdapter
		updateOfflineItems(itemUpdates:Dictionary):void [override] Used to update the items that were modified to the local store.	SQLiteOfflineAdapter
		valueOf():Object Returns the primitive value of the specified object.	Object

Protected Methods

	Method		Defined By
		getFieldColumnName(fieldName:String):String Returns the column name for the specified field, or null if there is no column for the field.	SQLiteOfflineAdapter
		getQueryCriteria(args:Array):String OfflineAdapter implementations should override this method with an implementation that returns an appropriate SQL WHERE clause for a given set of fill parameters.	SQLiteOfflineAdapter
		getQueryCriteriaParameters(args:Array):Object OfflineAdapter implementation should override this method with an implementation that returns the values used to substitute parameters in the WHERE clause from getQueryCriteria.	SQLiteOfflineAdapter
		getQueryOrder(args:Array):String OfflineAdapter implementations should override this method with an implementation that returns an appropriate SQL ORDER BY clause for a given set of fill parameters.	SQLiteOfflineAdapter
		getTargetColumnName(referencePath:Array):String Returns the column name for the specified path.	SQLiteOfflineAdapter
		getTargetTableName(referencePath:Array):String Walk the specified path to find the table responsible for the property path.	SQLiteOfflineAdapter
		getUIDColumnName():String Returns the column that contains the entity item UID values.	SQLiteOfflineAdapter
		internalExecuteOfflineQuery(sqlText:String, parameters:Object, startIndex:int, numItems:int):mx.rpc:AsyncToken Executes a SQL query against the local store and returns a collection of strongly typed items.	SQLiteOfflineAdapter

Constructor Detail

()

Constructor

public function SQLiteOfflineAdapter()

Method Detail

addOfflineItem

()

method

override public function addOfflineItem(item:Object):void

Parameters

item:Object

deleteOfflineItem

()

method

override public function deleteOfflineItem(uid:String):void

Parameters

uid:String

getItemReferenceIds

()

method

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

Parameters

	`uid:String`

	`propName:String`

Returns

Array

getItems

()

method

override public function getItems(uidArray:Array):Dictionary

Parameters

uidArray:Array

Returns

Dictionary

initializeOfflineMetadata

()

method

override public function initializeOfflineMetadata(metadata:Metadata):void

Parameters

metadata:Metadata

saveItems

()

method

override public function saveItems(items:Array):void

Parameters

items:Array

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

	`propSpecifier:PropertySpecifier` — property specifier determines the SELECT clause for the query

	`args:Array` — fill arguments used by custom implementations to determine the WHERE clause for the query

	`startIndex:int` — start index for a paged query

	`numItems:int` — number of items to retrieve for a paged query or -1 to retrieve all.

	`sqlText:String` — SQL clause to use during query exectuion, as determined by the `executeOfflineQuery()` method with the help of the `getQueryCriteria()` method

	`parameters:Object` — map of key-value pairs used for parameter replacements

	`startIndex:int` — the starting index for paging

	`numItems:int` — number of items to get or -1 if everything should be returned

SQLiteOfflineAdapter - AS3 LiveCycle Data Services

Packagesx

Language Elements

Appendixes

Package mx.data