| 套件 | 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 |
Override the getQueryCriteria() method and possibly the getQueryCriteriaParameters() to implement
custom local queries.
隱藏繼承公用屬性
顯示繼承公用屬性| 方法 | 定義自 | ||
|---|---|---|---|
Constructor. | SQLiteOfflineAdapter | ||
[覆寫]
Adds the specified offline item to the localStore. | SQLiteOfflineAdapter | ||
Appends to the byte array the specified data items. | SQLiteOfflineAdapter | ||
 |
Begins a transaction on the localStore. | DataServiceOfflineAdapter | |
|
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 to the specified cache. | DataServiceOfflineAdapter | |
[覆寫]
Deletes the specified offine item with the matching uid from the local store. | SQLiteOfflineAdapter | ||
|
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 [覆寫]
Used with SQLite adapters to execute dynamic queries locally. | SQLiteOfflineAdapter | ||
Generates a new serialized archive of the specified data items which then can
be persisted as appropriate. | SQLiteOfflineAdapter | ||
|
Returns the current fills that have been cached in the local store. | DataServiceOfflineAdapter | |
[覆寫]
Get the ids of the associated items for a given item uid and an association property. | SQLiteOfflineAdapter | ||
[覆寫]
Restores all the items specified using the uid array specified for a given destination. | SQLiteOfflineAdapter | ||
|
Restores the message cache from the offline store. | DataServiceOfflineAdapter | |
|
指出物件是否有已定義的指定屬性。 | Object | |
Imports archived changed items instance from the byte array, which typically comes
from a file. | SQLiteOfflineAdapter | ||
Imports archived data items into the local cache. | SQLiteOfflineAdapter | ||
|
Initialize the cacheId store. | DataServiceOfflineAdapter | |
initializeOfflineMetadata(metadata:Metadata):void [覆寫]
Initializes the offline cache. | SQLiteOfflineAdapter | ||
|
Returns true if the local store is "connected"; for example, if the local database is open. | DataServiceOfflineAdapter | |
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
[覆寫]
Indicates whether the adapter supports query execution. | SQLiteOfflineAdapter | ||
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
|
Restores queries. | DataServiceOfflineAdapter | |
|
Look up the metadata for a given destination. | DataServiceOfflineAdapter | |
|
Rolls back any current changes on the local store. | DataServiceOfflineAdapter | |
[覆寫]
Add/Remove all the items specified within the dictionary. | SQLiteOfflineAdapter | ||
|
Saves the pending uncommitted messages and unmerges messages. | DataServiceOfflineAdapter | |
|
Save the meta data configuration for a given destination. | DataServiceOfflineAdapter | |
|
Saves queries to be replayed offline later. | DataServiceOfflineAdapter | |
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
|
會傳回指定之物件的字串形式。 | Object | |
[覆寫]
Updates the specified properties of the specified offline item in the local store. | SQLiteOfflineAdapter | ||
[覆寫]
It is used to update the items that were modified to the local store. | SQLiteOfflineAdapter | ||
|
會傳回指定之物件的基本值。 | Object | |
| 方法 | 定義自 | ||
|---|---|---|---|
Returns the column name for the specified field, or null if there is no column for
the field. | SQLiteOfflineAdapter | ||
OfflineAdapter implementations should override this method with an implementation
that returns an appropriate SQL WHERE clause for a given set of fill parameters. | SQLiteOfflineAdapter | ||
OfflineAdapter implementation should override this method with an implementation
that returns the values used to substitute parameters in the WHERE clause from
getQueryCriteria. | SQLiteOfflineAdapter | ||
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 | ||
Returns the column name for the specified path. | SQLiteOfflineAdapter | ||
Walk the specified path to find the table responsible for the property path. | SQLiteOfflineAdapter | ||
Obtain 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 | ||
SQLiteOfflineAdapter | () | 建構函式 |
public function SQLiteOfflineAdapter()| 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Constructor.
addOfflineItem | () | 方法 |
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 |
Appends to the byte array the specified data items. Use this method to aggregate multiple data service (data manager) archives together.
參數
archiveData:IDataOutput — - the output stream to append to.
| |
version:String — - the version number to perform format mismatch checking with.
The intention is that this should change only when the data format changes.
| |
changedItems:ChangedItems — - describes the created, updated, and deleted items to be imported
into the local cache. Note that the timestamp and fillParameters must be specified,
to allow subsequent synchronizeFill() calls to work properly to match the imported
data.
|
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 |
Deletes the specified offine item with the matching uid from the local store.
參數
uid:String — the uid of the item to delete.
|
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 |
Used with SQLite adapters to execute dynamic queries locally.
The default implementation of this function will build a SQL statement for the query in the following manner:
- The SELECT clause will be based on the passed-in property specifier.
-
The WHERE clause will be determined by an invocation to
getQueryCriteria(), which custom implementations should override to return the appropriate WHERE clause for a given set of fill parameters. - The LIMIT (range of selected items) clause will be determined by the start index and number of items arguments.
Once the whole SQL statement has been constructed, it is passed to
internalExecuteOfflineQuery for execution.
Custom implementations should only override this method if they want to perform the full SQL statement creation process on their own.
參數
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.
|
mx.rpc:AsyncToken — AsyncToken with the result being an array of strongly typed items
|
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 |
Generates a new serialized archive of the specified data items which then can be persisted as appropriate.
參數
version:String — - the version number to perform format mismatch checking with.
The intention is that this should change only when the data format changes.
| |
changedItems:ChangedItems — - describes the created, updated, and deleted items to be imported
into the local cache. Note that the timestamp and fillParameters must be specified,
to allow subsequent synchronizeFill() calls to work properly to match the imported
data.
|
ByteArray — a ByteArray of the serialized data.
|
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 |
Returns the column name for the specified field, or null if there is no column for the field.
By default the column name is the same as the field name, unless it conflicts with an SQLite keyword, in which case it is prefixed with an _.
參數
fieldName:String — name of the field.
|
String — column name for the given field.
|
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 |
Get the ids of the associated items for a given item uid and an association property. Supported only for SQLLite implementations.
參數
uid:String — the uid of the item owning the association.
| |
propName:String — the association property name.
|
Array — an array of ids for referenced items of the association.
|
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 |
Restores all the items specified using the uid array specified for a given destination.
參數
uidArray:Array — an array of uids to fetch
|
Dictionary — a map of uid to items
|
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 implementations should override this method with an implementation that returns an appropriate SQL WHERE clause for a given set of fill parameters. The WHERE clause should conform to the schema generated for the offline store for the destination in context. The convention for this schema is that item-class property names are mapped one-to-one to the column names of their storage tables.
Note that the WHERE clause may refer only to columns of the table backing items for the destination in context.
This method is called by executeOfflineQuery in order to determine
the WHERE clause to use for the query being executed.
參數
args:Array — fill parameters.
|
String — SQL WHERE clause for the corresponding fill parameters. Returns null if no WHERE
clause need be used for the corresponding fill paramters. Default implementation returns
null for all fill parameters.
|
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 implementation should override this method with an implementation
that returns the values used to substitute parameters in the WHERE clause from
getQueryCriteria.
This method is called by the executeOfflineQuery() method to determine
the substitutions that are required for the query being executed.
參數
args:Array — fill parameters.
|
Object — Object with key-value pairs. The keys represent the names of the parameters to
replace and the values correspond to the substitution values. Positional parameters
can be substituted using integer keys. Default implementation returns 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 implementations should override this method with an implementation that returns an appropriate SQL ORDER BY clause for a given set of fill parameters. The ORDER BY clause should conform to the schema generated for the offline store for the destination in context. The convention for this schema is that item-class property names are mapped one-to-one to the column names of their storage tables. Note that the ORDER BY clause can refer only to columns of the table backing items for the destination in context.
This method is called by the executeOfflineQuery() method to determine
the ORDER BY clause to use for the query being executed.
參數
args:Array — fill parameters.
|
String — SQL ORDER BY clause for the corresponding fill parameters. Default implementation returns
the column name for the 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 |
Returns the column name for the specified path. Note that the column name might be stored in a different table. This routine is mainly used to assist model-generated code.
參數
referencePath:Array — path
|
String — the column name that corresponds to the path, or null if there is none
|
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 |
Walk the specified path to find the table responsible for the property path. This routine is mainly used to assist model-generated code.
參數
referencePath:Array — path
|
String — the table name
|
getUIDColumnName | () | 方法 |
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 |
Imports archived changed items instance from the byte array, which typically comes from a file.
參數
expectedVersion:String — - the expected version of the archive. An error is
thrown if the archive version does not match.
| |
archiveData:IDataInput — - the AMF serialized changedItem instance, as described
in the { |
mx.rpc:AsyncToken — AsyncToken that indicates when the items have been applied to the local cache.
|
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 |
Imports archived data items into the local cache.
參數
changedItems:ChangedItems — - describes the created, updated, and deleted items to be imported
into the local cache. Note that the resultTimestamp and fillParameters must be specified,
to allow subsequent synchronizeFill() calls to work properly to match the imported
data.
|
mx.rpc:AsyncToken — AsyncToken that indicates when the items have been applied to the local cache.
|
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 |
Initializes the offline cache. Supported only for SQLLite implementations.
參數
metadata:Metadata — the metadata describing the destination.
|
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 |
Executes a SQL query against the local store and returns a collection of strongly typed items.
參數
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
|
mx.rpc:AsyncToken — AsyncToken with the result being an array of strongly typed items
|
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 |
Indicates whether the adapter supports query execution. To support
query execution, implementations of this adapter must implement
the getQueryCriteria() method or override the executeOfflineQuery() method
By default, the value is set to false.
Boolean — true if the adapter supports query execution.
|
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 |
Add/Remove all the items specified within the dictionary. If the dictionary contains the managed object, then it is persisted to the local store. If it contains the UID as the key, then the item is removed from the store.
參數
items:Array — an array of items to save
|
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 |
Updates the specified properties of the specified offline item in the local store. The property change list is not used with default local shared object implementation as it is not needed.
參數
item:Object — the item to update, containing new values.
| |
propChangeList:Array — a list of properties that are being updated.
|
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 |
It is used to update the items that were modified to the local store. It takes in a dictionary where the key passed in is the updated item self and the value would be a array of the properties changes. The property change list is not used with default local shared object implementation as it is not needed.
參數
itemUpdates:Dictionary — the map of items to the array of changed properties
|
Tue Jun 12 2018, 03:47 PM Z