1.
Copyright © 2016 M/Gateway Developments Ltd
EWD 3 Training Course
Part 21
JavaScript Abstraction of Global Storage:
(b) Persistent JavaScript Objects
Rob Tweed
Director, M/Gateway Developments Ltd
Twitter: @rtweed

2.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

3.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
Can we then refer to: myDoc.d.e2.f3 ?
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

4.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
Is a DocumentNode Object
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

5.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
Would also have to be a DocumentNode Object
This would mean we'd have to know that the 'd' property was, or could be, a valid node

6.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
Would also have to be a DocumentNode Object

7.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
Would also have to be a DocumentNode Object

8.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
BUT: Impossible to predict or determine in advance all the
possible subscripts of a Global
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

9.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
BUT: Impossible to predict or determine in advance all the
possible subscripts of a Global
•No schema to tell us
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

10.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.d.e2.f3
BUT: Impossible to predict or determine in advance all the
possible subscripts of a Global
•No schema to tell us
•could be hundreds of thousands, or millions of subscript values
and any number of levels of hierarchy
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

11.
Copyright © 2016 M/Gateway Developments Ltd
var myDoc = new this.documentStore.DocumentNode( 'myDoc');
myDoc.x.value
Also: can't create properties automatically using subscript names
as these might clash with DocumentNode property or method names
as in the case above
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
myDoc("x","value")="hello world"

12.
Copyright © 2016 M/Gateway Developments Ltd
$() Function
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = myDoc.$('d');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

13.
Copyright © 2016 M/Gateway Developments Ltd
$() Function
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = myDoc.$('d');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

14.
Copyright © 2016 M/Gateway Developments Ltd
$() Function
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = myDoc.$('d');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
$():
- Returns a DocumentNode Object representing the specified sub-node
of the parent DocumentNode

15.
Copyright © 2016 M/Gateway Developments Ltd
$() Function
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = new this.documentStore.DocumentNode('myDoc', [ 'd']);
This does the same thing, but is much more verbose
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

16.
Copyright © 2016 M/Gateway Developments Ltd
Chaining $() Functions
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = myDoc.$('d');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

17.
Copyright © 2016 M/Gateway Developments Ltd
Chaining $() Functions
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = myDoc.$('d');
var e2Node = dNode.$('e2');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

18.
Copyright © 2016 M/Gateway Developments Ltd
Chaining $() Functions
var myDoc = new this.documentStore.DocumentNode('myDoc');
var dNode = myDoc.$('d');
var e2Node = myDoc.$('d').$('e2');
Does the same thing by chaining
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

19.
Copyright © 2016 M/Gateway Developments Ltd
Chaining $() Functions
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

20.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
A DocumentNode represented by $d was instantiated as a property of
the myDoc DocumentNode

21.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
A DocumentNode represented by $d was instantiated as a property of
the myDoc DocumentNode
Now accessible as myDoc.$d

22.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
A DocumentNode represented by $e2 was instantiated as a property of myDoc.$d

23.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
A DocumentNode represented by $e2 was instantiated as a property of myDoc.$d
Now accesible as myDoc.$d.$e2

24.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
Only need to use $() once for any specific subscript

25.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
var f2Node = myDoc.$('d').$('e2').$('f2');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
So we don’t need to do this

26.
Copyright © 2016 M/Gateway Developments Ltd
$() only needs invoking once
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
var f2Node = myDoc.$d.$e2.$('f2');
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"
We can do this instead, provided $() has been
used previously for the specified subscript

27.
Copyright © 2016 M/Gateway Developments Ltd
$ properties are DocumentNodes
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
var f3Value = f3Node.value; // bar3
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

28.
Copyright © 2016 M/Gateway Developments Ltd
$ properties are DocumentNodes
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
var f3Value = myDoc.$d.$e2.$f3.value; // bar3
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

29.
Copyright © 2016 M/Gateway Developments Ltd
$ properties are DocumentNodes
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc.$d.$e2.$f3.value = 'New value';
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")="bar3"

30.
Copyright © 2016 M/Gateway Developments Ltd
Persistent JavaScript Objects!
var myDoc = new this.documentStore.DocumentNode('myDoc');
var f3Node = myDoc.$('d').$('e2').$('f3');
myDoc.$d.$e2.$f3.value = 'New value';
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")=”New value"
Updates value on disk, not an in-memory copy
"Persistent JavaScript Objects"

31.
Copyright © 2016 M/Gateway Developments Ltd
Persistent JavaScript Objects
myDoc("a")=123
myDoc("b","c1")="foo"
myDoc("b","c2")="foo2"
myDoc("d","e1","f1")="bar1"
myDoc("d","e1","f2")="bar2"
myDoc("d","e2","f1")="bar1"
myDoc("d","e2","f2")="bar2"
myDoc("d","e2","f3")=”New value"
Not quite: myDoc.d.e2.f3
Instead: myDoc.$d.$e2.$f3
But no chance of subscript-based properties clashing with
DocumentNode property or method names by prefixing with $