Changeset
pentaho.type.changes. Changeset
The Changeset class describes a set of changes occurring in a structured value, the owner value.
A changeset is a container for a set of PrimitiveChange instances.
AMD Module
require(["pentaho/type/changes/Changeset"], function(Changeset) { /* code goes here */ }); Extends
Constructor
| Name | Description |
|---|---|
| new Changeset(transaction, owner) Abstract | Creates an empty |
Members
| Name | Description |
|---|---|
base : Protected | If a method has been overridden, then the base method provides access to the overridden method. |
hasChanges : Abstract | Gets a value that indicates if this changeset contains any changes, whether they are primitive or in contained changesets. |
isReadOnly : | Gets a value that indicates if the changeset is in a read-only state and can no longer be modified. |
owner : | Gets the container where the changes take place. |
ownerVersion : | Gets the version of the owner at the time when the changeset was created. |
transaction : | Gets the owning transaction. |
transactionVersion : | Gets the transaction version of this changeset. |
transactionVersionLocal : | Gets the local transaction version of this changeset. |
type : Abstract | Gets the type of change. |
Methods
| Name | Description |
|---|---|
| __onChildTxnVersionDirty() | Called by a child changeset when its version changes or becomes dirty. |
| _apply(target) Abstract Protected | Applies any local primitive changes. |
| _assertWritable() Protected | Throws an error if the changeset is read-only. |
| _clearChanges() Abstract Protected | Actually removes all changes from this changeset. |
| _clearChangesRecursive(parentChangeset) Protected | Called by a parent changeset on its child changeset, this, for it to clear its changes. |
| _resetNetOrder() Protected | Resets the topological order of this changeset, and of any child changesets, by calculating it based on its current parents. |
| _setTransactionVersion(txnVersion, noNotifyParentChangeset) Protected | Updates the transaction version to a given value, if it is greater than the current one. Notifies all parents, except the optionally specified one, that their version is dirty. |
| _setTransactionVersionLocal(txnVersionLocal, noNotifyParentChangeset) Protected | Updates the local transaction version to a given value due to a local, primitive change, if it is greater than the current one. Then, it calls |
| clearChanges() | Removes all changes from this changeset. |
| eachChildChangeset(fun, ctx) Abstract | Calls a function once per child changeset. |
extend(source, keyArgs) : Object | Extend an object with the properties of another. |
Constructor Details
| new Changeset(transaction, owner) Abstract | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Creates an empty Source: javascript/web/pentaho/type/changes/Changeset.js, line 48
|
Members Details
base: Protected |
|---|
| If a method has been overridden, then the base method provides access to the overridden method. Can also be called from within a constructor function. Source: javascript/web/pentaho/lang/Base.js, line 299 Inherited From: pentaho.lang.Base#base |
hasChanges: Abstract |
|---|
| Gets a value that indicates if this changeset contains any changes, whether they are primitive or in contained changesets. Source: javascript/web/pentaho/type/changes/Changeset.js, line 387 |
isReadOnly: |
|---|
| Gets a value that indicates if the changeset is in a read-only state and can no longer be modified. Source: javascript/web/pentaho/type/changes/Changeset.js, line 217 |
owner: |
|---|
| Gets the container where the changes take place. Source: javascript/web/pentaho/type/changes/Changeset.js, line 62 |
ownerVersion: |
|---|
| Gets the version of the owner at the time when the changeset was created. Source: javascript/web/pentaho/type/changes/Changeset.js, line 240 |
transaction: |
|---|
| Gets the owning transaction. Source: javascript/web/pentaho/type/changes/Changeset.js, line 52 |
transactionVersion: |
|---|
| Gets the transaction version of this changeset. This number is at least as high as the transaction version of any child changesets and primitive changes. Source: javascript/web/pentaho/type/changes/Changeset.js, line 264 |
transactionVersionLocal: |
|---|
| Gets the local transaction version of this changeset. This number is the maximum transaction version of the contained primitive changes. Source: javascript/web/pentaho/type/changes/Changeset.js, line 252 |
type: Abstract |
|---|
| Gets the type of change. Source: javascript/web/pentaho/type/changes/Change.js, line 42 Inherited From: pentaho.type.changes.Change#type |
Methods Details
| __onChildTxnVersionDirty() |
|---|
| Called by a child changeset when its version changes or becomes dirty. Source: javascript/web/pentaho/type/changes/Changeset.js, line 379 |
| _apply(target) Abstract Protected | ||||||
|---|---|---|---|---|---|---|
| Applies any local primitive changes. Source: javascript/web/pentaho/type/changes/Change.js, line 62 Inherited From: pentaho.type.changes.Change#_apply
|
| _assertWritable() Protected | ||||
|---|---|---|---|---|
| Throws an error if the changeset is read-only. Source: javascript/web/pentaho/type/changes/Changeset.js, line 206
|
| _clearChanges() Abstract Protected |
|---|
| Actually removes all changes from this changeset. Source: javascript/web/pentaho/type/changes/Changeset.js, line 447 |
| _clearChangesRecursive(parentChangeset) Protected | ||||||
|---|---|---|---|---|---|---|
| Called by a parent changeset on its child changeset, this, for it to clear its changes. This method updates the transaction version of this changeset to match the parent's version and then delegates to the Source: javascript/web/pentaho/type/changes/Changeset.js, line 435
See also: pentaho.type.changes.Changeset#transactionVersion , pentaho.type.changes.Changeset#clearChanges |
| _resetNetOrder() Protected |
|---|
| Resets the topological order of this changeset, and of any child changesets, by calculating it based on its current parents. Source: javascript/web/pentaho/type/changes/Changeset.js, line 111 See also: pentaho.type.changes.Changeset#__calculateNetOrder |
| _setTransactionVersion(txnVersion, noNotifyParentChangeset) Protected | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Updates the transaction version to a given value, if it is greater than the current one. Notifies all parents, except the optionally specified one, that their version is dirty. Source: javascript/web/pentaho/type/changes/Changeset.js, line 308
|
| _setTransactionVersionLocal(txnVersionLocal, noNotifyParentChangeset) Protected | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Updates the local transaction version to a given value due to a local, primitive change, if it is greater than the current one. Then, it calls Source: javascript/web/pentaho/type/changes/Changeset.js, line 335
|
| clearChanges() | ||||
|---|---|---|---|---|
| Removes all changes from this changeset. Primitive changes are removed, while contained changesets are cleared. This method validates that the changeset is in a valid state and then delegates actual work to the Source: javascript/web/pentaho/type/changes/Changeset.js, line 416
See also: pentaho.type.changes.Changeset#_clearChanges , pentaho.type.changes.Changeset#_clearChangesRecursive |
| eachChildChangeset(fun, ctx) Abstract | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Calls a function once per child changeset. Source: javascript/web/pentaho/type/changes/Changeset.js, line 186
|
extend(source, keyArgs) : Object | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Extend an object with the properties of another. Methods that are overridden are accessible through This object is extended, but its class doesn't change. Source: javascript/web/pentaho/lang/Base.js, line 1037 Inherited From: pentaho.lang.Base#extend
|