-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
EntityCollection.js
429 lines (388 loc) · 14.9 KB
/
EntityCollection.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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
define([
'../Core/AssociativeArray',
'../Core/createGuid',
'../Core/defined',
'../Core/defineProperties',
'../Core/DeveloperError',
'../Core/Event',
'../Core/Iso8601',
'../Core/JulianDate',
'../Core/RuntimeError',
'../Core/TimeInterval',
'./Entity'
], function(
AssociativeArray,
createGuid,
defined,
defineProperties,
DeveloperError,
Event,
Iso8601,
JulianDate,
RuntimeError,
TimeInterval,
Entity) {
'use strict';
var entityOptionsScratch = {
id : undefined
};
function fireChangedEvent(collection) {
if (collection._firing) {
collection._refire = true;
return;
}
if (collection._suspendCount === 0) {
var added = collection._addedEntities;
var removed = collection._removedEntities;
var changed = collection._changedEntities;
if (changed.length !== 0 || added.length !== 0 || removed.length !== 0) {
collection._firing = true;
do {
collection._refire = false;
var addedArray = added.values.slice(0);
var removedArray = removed.values.slice(0);
var changedArray = changed.values.slice(0);
added.removeAll();
removed.removeAll();
changed.removeAll();
collection._collectionChanged.raiseEvent(collection, addedArray, removedArray, changedArray);
} while (collection._refire);
collection._firing = false;
}
}
}
/**
* An observable collection of {@link Entity} instances where each entity has a unique id.
* @alias EntityCollection
* @constructor
*
* @param {DataSource|CompositeEntityCollection} [owner] The data source (or composite entity collection) which created this collection.
*/
function EntityCollection(owner) {
this._owner = owner;
this._entities = new AssociativeArray();
this._addedEntities = new AssociativeArray();
this._removedEntities = new AssociativeArray();
this._changedEntities = new AssociativeArray();
this._suspendCount = 0;
this._collectionChanged = new Event();
this._id = createGuid();
this._show = true;
this._firing = false;
this._refire = false;
}
/**
* Prevents {@link EntityCollection#collectionChanged} events from being raised
* until a corresponding call is made to {@link EntityCollection#resumeEvents}, at which
* point a single event will be raised that covers all suspended operations.
* This allows for many items to be added and removed efficiently.
* This function can be safely called multiple times as long as there
* are corresponding calls to {@link EntityCollection#resumeEvents}.
*/
EntityCollection.prototype.suspendEvents = function() {
this._suspendCount++;
};
/**
* Resumes raising {@link EntityCollection#collectionChanged} events immediately
* when an item is added or removed. Any modifications made while while events were suspended
* will be triggered as a single event when this function is called.
* This function is reference counted and can safely be called multiple times as long as there
* are corresponding calls to {@link EntityCollection#resumeEvents}.
*
* @exception {DeveloperError} resumeEvents can not be called before suspendEvents.
*/
EntityCollection.prototype.resumeEvents = function() {
//>>includeStart('debug', pragmas.debug);
if (this._suspendCount === 0) {
throw new DeveloperError('resumeEvents can not be called before suspendEvents.');
}
//>>includeEnd('debug');
this._suspendCount--;
fireChangedEvent(this);
};
/**
* The signature of the event generated by {@link EntityCollection#collectionChanged}.
* @function
*
* @param {EntityCollection} collection The collection that triggered the event.
* @param {Entity[]} added The array of {@link Entity} instances that have been added to the collection.
* @param {Entity[]} removed The array of {@link Entity} instances that have been removed from the collection.
* @param {Entity[]} changed The array of {@link Entity} instances that have been modified.
*/
EntityCollection.collectionChangedEventCallback = undefined;
defineProperties(EntityCollection.prototype, {
/**
* Gets the event that is fired when entities are added or removed from the collection.
* The generated event is a {@link EntityCollection.collectionChangedEventCallback}.
* @memberof EntityCollection.prototype
* @readonly
* @type {Event}
*/
collectionChanged : {
get : function() {
return this._collectionChanged;
}
},
/**
* Gets a globally unique identifier for this collection.
* @memberof EntityCollection.prototype
* @readonly
* @type {String}
*/
id : {
get : function() {
return this._id;
}
},
/**
* Gets the array of Entity instances in the collection.
* This array should not be modified directly.
* @memberof EntityCollection.prototype
* @readonly
* @type {Entity[]}
*/
values : {
get : function() {
return this._entities.values;
}
},
/**
* Gets whether or not this entity collection should be
* displayed. When true, each entity is only displayed if
* its own show property is also true.
* @memberof EntityCollection.prototype
* @type {Boolean}
*/
show : {
get : function() {
return this._show;
},
set : function(value) {
//>>includeStart('debug', pragmas.debug);
if (!defined(value)) {
throw new DeveloperError('value is required.');
}
//>>includeEnd('debug');
if (value === this._show) {
return;
}
//Since entity.isShowing includes the EntityCollection.show state
//in its calculation, we need to loop over the entities array
//twice, once to get the old showing value and a second time
//to raise the changed event.
this.suspendEvents();
var i;
var oldShows = [];
var entities = this._entities.values;
var entitiesLength = entities.length;
for (i = 0; i < entitiesLength; i++) {
oldShows.push(entities[i].isShowing);
}
this._show = value;
for (i = 0; i < entitiesLength; i++) {
var oldShow = oldShows[i];
var entity = entities[i];
if (oldShow !== entity.isShowing) {
entity.definitionChanged.raiseEvent(entity, 'isShowing', entity.isShowing, oldShow);
}
}
this.resumeEvents();
}
},
/**
* Gets the owner of this entity collection, ie. the data source or composite entity collection which created it.
* @memberof EntityCollection.prototype
* @readonly
* @type {DataSource|CompositeEntityCollection}
*/
owner : {
get : function() {
return this._owner;
}
}
});
/**
* Computes the maximum availability of the entities in the collection.
* If the collection contains a mix of infinitely available data and non-infinite data,
* it will return the interval pertaining to the non-infinite data only. If all
* data is infinite, an infinite interval will be returned.
*
* @returns {TimeInterval} The availability of entities in the collection.
*/
EntityCollection.prototype.computeAvailability = function() {
var startTime = Iso8601.MAXIMUM_VALUE;
var stopTime = Iso8601.MINIMUM_VALUE;
var entities = this._entities.values;
for (var i = 0, len = entities.length; i < len; i++) {
var entity = entities[i];
var availability = entity.availability;
if (defined(availability)) {
var start = availability.start;
var stop = availability.stop;
if (JulianDate.lessThan(start, startTime) && !start.equals(Iso8601.MINIMUM_VALUE)) {
startTime = start;
}
if (JulianDate.greaterThan(stop, stopTime) && !stop.equals(Iso8601.MAXIMUM_VALUE)) {
stopTime = stop;
}
}
}
if (Iso8601.MAXIMUM_VALUE.equals(startTime)) {
startTime = Iso8601.MINIMUM_VALUE;
}
if (Iso8601.MINIMUM_VALUE.equals(stopTime)) {
stopTime = Iso8601.MAXIMUM_VALUE;
}
return new TimeInterval({
start : startTime,
stop : stopTime
});
};
/**
* Add an entity to the collection.
*
* @param {Entity} entity The entity to be added.
* @returns {Entity} The entity that was added.
* @exception {DeveloperError} An entity with <entity.id> already exists in this collection.
*/
EntityCollection.prototype.add = function(entity) {
//>>includeStart('debug', pragmas.debug);
if (!defined(entity)) {
throw new DeveloperError('entity is required.');
}
//>>includeEnd('debug');
if (!(entity instanceof Entity)) {
entity = new Entity(entity);
}
var id = entity.id;
var entities = this._entities;
if (entities.contains(id)) {
throw new RuntimeError('An entity with id ' + id + ' already exists in this collection.');
}
entity.entityCollection = this;
entities.set(id, entity);
if (!this._removedEntities.remove(id)) {
this._addedEntities.set(id, entity);
}
entity.definitionChanged.addEventListener(EntityCollection.prototype._onEntityDefinitionChanged, this);
fireChangedEvent(this);
return entity;
};
/**
* Removes an entity from the collection.
*
* @param {Entity} entity The entity to be removed.
* @returns {Boolean} true if the item was removed, false if it did not exist in the collection.
*/
EntityCollection.prototype.remove = function(entity) {
if (!defined(entity)) {
return false;
}
return this.removeById(entity.id);
};
/**
* Returns true if the provided entity is in this collection, false otherwise.
*
* @param {Entity} entity The entity.
* @returns {Boolean} true if the provided entity is in this collection, false otherwise.
*/
EntityCollection.prototype.contains = function(entity) {
//>>includeStart('debug', pragmas.debug);
if (!defined(entity)) {
throw new DeveloperError('entity is required');
}
//>>includeEnd('debug');
return this._entities.get(entity.id) === entity;
};
/**
* Removes an entity with the provided id from the collection.
*
* @param {String} id The id of the entity to remove.
* @returns {Boolean} true if the item was removed, false if no item with the provided id existed in the collection.
*/
EntityCollection.prototype.removeById = function(id) {
if (!defined(id)) {
return false;
}
var entities = this._entities;
var entity = entities.get(id);
if (!this._entities.remove(id)) {
return false;
}
if (!this._addedEntities.remove(id)) {
this._removedEntities.set(id, entity);
this._changedEntities.remove(id);
}
this._entities.remove(id);
entity.definitionChanged.removeEventListener(EntityCollection.prototype._onEntityDefinitionChanged, this);
fireChangedEvent(this);
return true;
};
/**
* Removes all Entities from the collection.
*/
EntityCollection.prototype.removeAll = function() {
//The event should only contain items added before events were suspended
//and the contents of the collection.
var entities = this._entities;
var entitiesLength = entities.length;
var array = entities.values;
var addedEntities = this._addedEntities;
var removed = this._removedEntities;
for (var i = 0; i < entitiesLength; i++) {
var existingItem = array[i];
var existingItemId = existingItem.id;
var addedItem = addedEntities.get(existingItemId);
if (!defined(addedItem)) {
existingItem.definitionChanged.removeEventListener(EntityCollection.prototype._onEntityDefinitionChanged, this);
removed.set(existingItemId, existingItem);
}
}
entities.removeAll();
addedEntities.removeAll();
this._changedEntities.removeAll();
fireChangedEvent(this);
};
/**
* Gets an entity with the specified id.
*
* @param {String} id The id of the entity to retrieve.
* @returns {Entity} The entity with the provided id or undefined if the id did not exist in the collection.
*/
EntityCollection.prototype.getById = function(id) {
//>>includeStart('debug', pragmas.debug);
if (!defined(id)) {
throw new DeveloperError('id is required.');
}
//>>includeEnd('debug');
return this._entities.get(id);
};
/**
* Gets an entity with the specified id or creates it and adds it to the collection if it does not exist.
*
* @param {String} id The id of the entity to retrieve or create.
* @returns {Entity} The new or existing object.
*/
EntityCollection.prototype.getOrCreateEntity = function(id) {
//>>includeStart('debug', pragmas.debug);
if (!defined(id)) {
throw new DeveloperError('id is required.');
}
//>>includeEnd('debug');
var entity = this._entities.get(id);
if (!defined(entity)) {
entityOptionsScratch.id = id;
entity = new Entity(entityOptionsScratch);
this.add(entity);
}
return entity;
};
EntityCollection.prototype._onEntityDefinitionChanged = function(entity) {
var id = entity.id;
if (!this._addedEntities.contains(id)) {
this._changedEntities.set(id, entity);
}
fireChangedEvent(this);
};
return EntityCollection;
});