Main Page | Packages | Class Tree | Index | Help

xp.data

class DeltaPacket

Object
  |
  +--xp.data.DeltaPacket


class DeltaPacket
extends Object

The DeltaPacket lets you manage changes made to the data.

A delta packet is an optimized set of instructions that describe all changes that have been made to the data in a data set.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
deleteItems
Associative array of deleted items indexed by itemId

public
hasDelta: Boolean
Do we have delta items

public
insertItems
Associative array of insered items indexed by itemId

public
logChanges: Boolean
Indicates whether the consumer of the delta packet should log the changes it specifies.

public
schema: Object
Get or set the schema associated with the delta items

public
transactionId: String
The delta packets tx number

public
updateItems
Associative array of updated items indexed by itemId

Constructor

public
DeltaPacket ( )
Creates a new DeltaPacket instance

Method Summary

public
addDeleteItem ( oldItem: Object )
Adds the currentItem as a deleted item to the deltaPacket

public
addInsertItem ( newItem: Object )
Adds the currentItem as an insert item to the deltaPacket

public
addUpdateItem ( oldItem, newItem: Object )
Adds the currentItem as an update item to the deltaPacket



Field Documentation

deleteItems

public var deleteItems
Associative array of deleted items indexed by itemId

hasDelta

public var hasDelta: Boolean
Do we have delta items

insertItems

public var insertItems
Associative array of insered items indexed by itemId

logChanges

public var logChanges: Boolean
Indicates whether the consumer of the delta packet should log the changes it specifies.

True if the consumer of this delta packet should log the changes it specifies

schema

public var schema: Object
Get or set the schema associated with the delta items

transactionId

public var transactionId: String
The delta packets tx number

updateItems

public var updateItems
Associative array of updated items indexed by itemId


Constructor Documentation

DeltaPacket

public function DeltaPacket()
Creates a new DeltaPacket instance


Method Documentation

addDeleteItem

public function addDeleteItem(oldItem: Object)
Adds the currentItem as a deleted item to the deltaPacket

addInsertItem

public function addInsertItem(newItem: Object)
Adds the currentItem as an insert item to the deltaPacket

addUpdateItem

public function addUpdateItem(oldItem,
 newItem: Object)
Adds the currentItem as an update item to the deltaPacket


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc