-
Notifications
You must be signed in to change notification settings - Fork 4
/
Dictionary.js
341 lines (315 loc) · 8.93 KB
/
Dictionary.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
(function(){
var Item = function(key, value){
this.key = key;
this.value = value;
};
Item.prototype.key = null;
Item.prototype.value = null;
Item.prototype.is = function(key){
return (this.key === key);
};
Item.prototype.toString = function(){
return this.key.toString() + ":" + this.value.toString();
};
/**
* Dictionary instance - manage key:value pairs using string equality (===) for key comparison, rather than the return of a key's toString method
* @constructor
* @function
* @param {object} hash A Dictionary object or Object object to initialize the new Dictionary to.
* @class The Dictionary class is used to manage key:value pairs, but uses strict equality for key comparison, and does not allow for direct array access (use getItem/addItem/etc methods instead) or for..in interation. Additional sugar methods are included to help with iteration and common tasks.
*/
function Dictionary(hash){
this._map = [];
this.adopt(hash);
};
Dictionary.prototype._map = null;
/**
* Adopts all members from another Dictionary or Object instance
* @function
* @param {object} hash A Dictionary object or Object object to initialize the new Dictionary to.
* @returns this
*/
Dictionary.prototype.adopt = function(hash){
if(hash){
if(hash instanceof Dictionary){
hash.each(this.addItem, this);
} else if (typeof hash == 'object'){
for(var key in hash){
this.addItem(key, hash[key]);
};
};
};
return this;
};
/**
* Adds a key:value pair to the Dictionary
* @function
* @param {mixed} key The key to register with the Dictionary.
* @param {mixed} value The value object registered with the Dictionary.
* @returns mixed (value)
*/
Dictionary.prototype.addItem = function(key, value){
var item;
for(var i = 0, l = this._map.length; i < l; i++){
item = this._map[i];
if(item.is(key)){
return item.value = value;
};
};
this._map.push(new Item(key, value));
return value;
};
/**
* Determines if a key is registered with the Dictionary.
* @function
* @param {mixed} key The key to test for.
* @returns boolean
*/
Dictionary.prototype.contains = function(key){
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
if(item.is(key)){
return true;
};
};
return false;
};
/**
* Retrieves a value from the Dictionary by key.
* @function
* @param {mixed} key The key of the value to be retrieved.
* @returns mixed
*/
Dictionary.prototype.getItem = function(key){
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
if(item.is(key)){
return item.value;
};
};
return null;
};
/**
* Removes (un-registers) a value from the Dictionary
* @function
* @param {mixed} key The key of the value to be removed.
* @returns
*/
Dictionary.prototype.removeItem = function(key){
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
if(item.is(key)){
this._map.splice(i, 1);
break;
};
};
};
/**
* Removes (un-reigsters) all items from the Dictionary.
* @function
*/
Dictionary.prototype.removeAll = function(){
this._map.length = 0;
};
/**
* Returns the number of items registered with the Dictionary.
* @function
* @returns number
*/
Dictionary.prototype.count = Dictionary.prototype.length = function(){
return this._map.length;
};
/**
* Creates a (separate) duplicate of the Dictionary.
* @function
* @returns Dictionary
*/
Dictionary.prototype.clone = function(){
return new Dictionary().copy(this);
};
/**
* Copies the registration from another Dictionary. Note that this is different from .adopt in that items not registered with the source Dictionary will be removed from this.
* @function
* @param {Dictionary} source The Dictionary instance to copy registration from.
* @returns this
*/
Dictionary.prototype.copy = function(source){
if(!(source instanceof Dictionary)){
throw new Error('Source must be a Dictionary object');
};
this._map = source._map.slice();
return this;
};
// sugar
/**
* Iterates through all registered objects in the Dictionary, calling the iterator function with the following paramters: value, key, index, Dictionary
* @function
* @param {function} iterator The function to be called on each registered item.
* @param {mixed} scope The context (scope) to be used by the iterator function (optional)
*/
Dictionary.prototype.each = function(iterator, scope){
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
iterator.call(scope, item.value, item.key, i, this);
};
};
/**
* Sorts a Dictionary's registration by keys.
* @function
* @param {function} iterator The comparison function used to sort the registered items.
* @returns this
*/
Dictionary.prototype.sort = Dictionary.prototype.sortOnKeys = function(iterator){
if(typeof iterator != 'function'){
iterator = function(a, b){
return a > b ? 1 : b > a ? -1 : 0;
};
};
this._map.sort(function(a, b){
return iterator(a.key, b.key);
});
return this;
};
/**
* Sorts a Dictionary's registration by values.
* @function
* @param {function} iterator The comparison function used to sort the registered items.
* @returns this
*/
Dictionary.prototype.sortOnValues = function(iterator){
if(typeof iterator != 'function'){
iterator = function(a, b){
return a > b ? 1 : b > a ? -1 : 0;
};
};
this._map.sort(function(a, b){
return iterator(a.value, b.value);
});
return this;
};
/**
*
* @function
* @param {function} iterator The function to be called on each registered item.
* @param {mixed} scope The context (scope) to be used by the iterator function (optional)
* @returns
*/
Dictionary.prototype.map = function(iterator, scope){
var r = new Dictionary();
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
r.addItem(item.key, iterator.call(scope, item.value, item.key, i, this));
};
return r;
};
/**
*
* @function
* @param {function} iterator The function to be called on each registered item.
* @param {mixed} scope The context (scope) to be used by the iterator function (optional)
* @returns
*/
Dictionary.prototype.filter = function(iterator, scope){
var r = new Dictionary();
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
var ok = iterator.call(scope, item.value, item.key, i, this);
if(ok){
r.addItem(item.key, item.value);
};
};
return r;
};
/**
* Returns an array of all registered keys.
* @function
* @returns array
*/
Dictionary.prototype.keys = function(){
var k = [];
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
k[i] = item.key;
};
return k;
};
/**
* Returns an array of all registered values.
* @function
* @returns array
*/
Dictionary.prototype.values = function(){
var v = [];
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
v[i] = item.value;
};
return v;
};
/**
* Tests each registered item against the iterator function - returns true if all iterator invocations return true, false otherwise.
* @function
* @param {function} iterator The function to be called on each registered item.
* @param {mixed} scope The context (scope) to be used by the iterator function (optional)
* @returns boolean
*/
Dictionary.prototype.all = function(iterator, scope){
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
if(!iterator.call(scope, item.value, item.key, this)){
return false;
};
};
return true;
};
/**
* Tests registered items against the iterator function - returns true (and stops) if any iterator invocations return true, false if none do.
* @function
* @param {function} iterator The function to be called on each registered item.
* @param {mixed} scope The context (scope) to be used by the iterator function (optional)
* @returns
*/
Dictionary.prototype.any = function(iterator, scope){
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
if(iterator.call(scope, item.value, item.key, this)){
return true;
};
};
return false;
};
/**
* Returns a new Dictionary object with just the keys passed as arguments
* @function
* @param {arguments} Each argument is considered a key to retrieve from this.
* @returns Dictionary
*/
Dictionary.prototype.subset = function(){
var r = new Dictionary();
var keys = Array.apply(null, arguments);
for(var i = 0, l = keys.length; i < l; i++){
var key = keys[i];
if(this.contains(key)){
var value = this.getItem(key);
if(value){
r.addItem(key, value);
};
};
};
return r;
};
/**
* Returns the Dictionary expressed as a String value.
* @function
* @returns string
*/
Dictionary.prototype.toString = function(){
var o = [];
for(var i = 0, l = this._map.length; i < l; i++){
var item = this._map[i];
o.push(item.toString());
};
return "{" + o.join(",") + "}";
};
return this.Dictionary = window.Dictionary = Dictionary;
})();