summaryrefslogtreecommitdiff
path: root/lib/dojo/store/Observable.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/dojo/store/Observable.js')
-rw-r--r--lib/dojo/store/Observable.js169
1 files changed, 2 insertions, 167 deletions
diff --git a/lib/dojo/store/Observable.js b/lib/dojo/store/Observable.js
index f231e0321..a1d47cc57 100644
--- a/lib/dojo/store/Observable.js
+++ b/lib/dojo/store/Observable.js
@@ -4,170 +4,5 @@
see: http://dojotoolkit.org/license for details
*/
-
-if(!dojo._hasResource["dojo.store.Observable"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
-dojo._hasResource["dojo.store.Observable"] = true;
-dojo.provide("dojo.store.Observable");
-
-dojo.getObject("store", true, dojo);
-
-dojo.store.Observable = function(store){
- // summary:
- // The Observable store wrapper takes a store and sets an observe method on query()
- // results that can be used to monitor results for changes.
- //
- // description:
- // Observable wraps an existing store so that notifications can be made when a query
- // is performed.
- //
- // example:
- // Create a Memory store that returns an observable query, and then log some
- // information about that query.
- //
- // | var store = dojo.store.Observable(new dojo.store.Memory({
- // | data: [
- // | {id: 1, name: "one", prime: false},
- // | {id: 2, name: "two", even: true, prime: true},
- // | {id: 3, name: "three", prime: true},
- // | {id: 4, name: "four", even: true, prime: false},
- // | {id: 5, name: "five", prime: true}
- // | ]
- // | }));
- // | var changes = [], results = store.query({ prime: true });
- // | var observer = results.observe(function(object, previousIndex, newIndex){
- // | changes.push({previousIndex:previousIndex, newIndex:newIndex, object:object});
- // | });
- //
- // See the Observable tests for more information.
-
- var queryUpdaters = [], revision = 0;
- // a Comet driven store could directly call notify to notify observers when data has
- // changed on the backend
- store.notify = function(object, existingId){
- revision++;
- var updaters = queryUpdaters.slice();
- for(var i = 0, l = updaters.length; i < l; i++){
- updaters[i](object, existingId);
- }
- };
- var originalQuery = store.query;
- store.query = function(query, options){
- options = options || {};
- var results = originalQuery.apply(this, arguments);
- if(results && results.forEach){
- var nonPagedOptions = dojo.mixin({}, options);
- delete nonPagedOptions.start;
- delete nonPagedOptions.count;
-
- var queryExecutor = store.queryEngine && store.queryEngine(query, nonPagedOptions);
- var queryRevision = revision;
- var listeners = [], queryUpdater;
- results.observe = function(listener, includeObjectUpdates){
- if(listeners.push(listener) == 1){
- // first listener was added, create the query checker and updater
- queryUpdaters.push(queryUpdater = function(changed, existingId){
- dojo.when(results, function(resultsArray){
- var atEnd = resultsArray.length != options.count;
- var i;
- if(++queryRevision != revision){
- throw new Error("Query is out of date, you must observe() the query prior to any data modifications");
- }
- var removedObject, removedFrom = -1, insertedInto = -1;
- if(existingId){
- // remove the old one
- for(i = 0, l = resultsArray.length; i < l; i++){
- var object = resultsArray[i];
- if(store.getIdentity(object) == existingId){
- removedObject = object;
- removedFrom = i;
- if(queryExecutor || !changed){// if it was changed and we don't have a queryExecutor, we shouldn't remove it because updated objects would be eliminated
- resultsArray.splice(i, 1);
- }
- break;
- }
- }
- }
- if(queryExecutor){
- // add the new one
- if(changed &&
- // if a matches function exists, use that (probably more efficient)
- (queryExecutor.matches ? queryExecutor.matches(changed) : queryExecutor([changed]).length)){
-
- if(removedFrom > -1){
- // put back in the original slot so it doesn't move unless it needs to (relying on a stable sort below)
- resultsArray.splice(removedFrom, 0, changed);
- }else{
- resultsArray.push(changed);
- }
- insertedInto = dojo.indexOf(queryExecutor(resultsArray), changed);
- if((options.start && insertedInto == 0) ||
- (!atEnd && insertedInto == resultsArray.length -1)){
- // if it is at the end of the page, assume it goes into the prev or next page
- insertedInto = -1;
- }
- }
- }else if(changed){
- // we don't have a queryEngine, so we can't provide any information
- // about where it was inserted, but we can at least indicate a new object
- insertedInto = removedFrom >= 0 ? removedFrom : (store.defaultIndex || 0);
- }
- if((removedFrom > -1 || insertedInto > -1) &&
- (includeObjectUpdates || !queryExecutor || (removedFrom != insertedInto))){
- var copyListeners = listeners.slice();
- for(i = 0;listener = copyListeners[i]; i++){
- listener(changed || removedObject, removedFrom, insertedInto);
- }
- }
- });
- });
- }
- return {
- cancel: function(){
- // remove this listener
- listeners.splice(dojo.indexOf(listeners, listener), 1);
- if(!listeners.length){
- // no more listeners, remove the query updater too
- queryUpdaters.splice(dojo.indexOf(queryUpdaters, queryUpdater), 1);
- }
- }
- };
- };
- }
- return results;
- };
- var inMethod;
- function whenFinished(method, action){
- var original = store[method];
- if(original){
- store[method] = function(value){
- if(inMethod){
- // if one method calls another (like add() calling put()) we don't want two events
- return original.apply(this, arguments);
- }
- inMethod = true;
- try{
- return dojo.when(original.apply(this, arguments), function(results){
- action((typeof results == "object" && results) || value);
- return results;
- });
- }finally{
- inMethod = false;
- }
- };
- }
- }
- // monitor for updates by listening to these methods
- whenFinished("put", function(object){
- store.notify(object, store.getIdentity(object));
- });
- whenFinished("add", function(object){
- store.notify(object);
- });
- whenFinished("remove", function(id){
- store.notify(undefined, id);
- });
-
- return store;
-};
-
-}
+//>>built
+define("dojo/store/Observable",["../_base/kernel","../_base/lang","../_base/Deferred","../_base/array"],function(_1,_2,_3,_4){var ds=_2.getObject("dojo.store",true);return ds.Observable=function(_5){var _6,_7=[],_8=0;_5.notify=function(_9,_a){_8++;var _b=_7.slice();for(var i=0,l=_b.length;i<l;i++){_b[i](_9,_a);}};var _c=_5.query;_5.query=function(_d,_e){_e=_e||{};var _f=_c.apply(this,arguments);if(_f&&_f.forEach){var _10=_2.mixin({},_e);delete _10.start;delete _10.count;var _11=_5.queryEngine&&_5.queryEngine(_d,_10);var _12=_8;var _13=[],_14;_f.observe=function(_15,_16){if(_13.push(_15)==1){_7.push(_14=function(_17,_18){_3.when(_f,function(_19){var _1a=_19.length!=_e.count;var i,l,_15;if(++_12!=_8){throw new Error("Query is out of date, you must observe() the query prior to any data modifications");}var _1b,_1c=-1,_1d=-1;if(_18!==_6){for(i=0,l=_19.length;i<l;i++){var _1e=_19[i];if(_5.getIdentity(_1e)==_18){_1b=_1e;_1c=i;if(_11||!_17){_19.splice(i,1);}break;}}}if(_11){if(_17&&(_11.matches?_11.matches(_17):_11([_17]).length)){var _1f=_1c>-1?_1c:_19.length;_19.splice(_1f,0,_17);_1d=_4.indexOf(_11(_19),_17);_19.splice(_1f,1);if((_e.start&&_1d==0)||(!_1a&&_1d==_19.length)){_1d=-1;}else{_19.splice(_1d,0,_17);}}}else{if(_17&&!_e.start){_1d=_1c>=0?_1c:(_5.defaultIndex||0);}}if((_1c>-1||_1d>-1)&&(_16||!_11||(_1c!=_1d))){var _20=_13.slice();for(i=0;_15=_20[i];i++){_15(_17||_1b,_1c,_1d);}}});});}return {cancel:function(){var _21=_4.indexOf(_13,_15);if(_21>-1){_13.splice(_21,1);if(!_13.length){_7.splice(_4.indexOf(_7,_14),1);}}}};};}return _f;};var _22;function _23(_24,_25){var _26=_5[_24];if(_26){_5[_24]=function(_27){if(_22){return _26.apply(this,arguments);}_22=true;try{var _28=_26.apply(this,arguments);_3.when(_28,function(_29){_25((typeof _29=="object"&&_29)||_27);});return _28;}finally{_22=false;}};}};_23("put",function(_2a){_5.notify(_2a,_5.getIdentity(_2a));});_23("add",function(_2b){_5.notify(_2b);});_23("remove",function(id){_5.notify(undefined,id);});return _5;};}); \ No newline at end of file