4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
15 * @class Roo.data.Store
16 * @extends Roo.util.Observable
17 * The Store class encapsulates a client side cache of {@link Roo.data.Record} objects which provide input data
18 * for widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.<br>
20 * A Store object uses an implementation of {@link Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object
21 * has no knowledge of the format of the data returned by the Proxy.<br>
23 * A Store object uses its configured implementation of {@link Roo.data.DataReader} to create {@link Roo.data.Record}
24 * instances from the data object. These records are cached and made available through accessor functions.
26 * Creates a new Store.
27 * @param {Object} config A config object containing the objects needed for the Store to access data,
28 * and read the data into Records.
30 Roo.data.Store = function(config){
31 this.data = new Roo.util.MixedCollection(false);
32 this.data.getKey = function(o){
42 "multisort" : "_multisort"
45 if(config && config.data){
46 this.inlineData = config.data;
50 Roo.apply(this, config);
52 if(this.reader){ // reader passed
53 this.reader = Roo.factory(this.reader, Roo.data);
54 this.reader.xmodule = this.xmodule || false;
56 this.recordType = this.reader.recordType;
58 if(this.reader.onMetaChange){
59 this.reader.onMetaChange = this.onMetaChange.createDelegate(this);
64 this.fields = this.recordType.prototype.fields;
71 * Fires when the data cache has changed, and a widget which is using this Store
72 * as a Record cache should refresh its view.
78 * Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.
80 * @param {Object} meta The JSON metadata
85 * Fires when Records have been added to the Store
87 * @param {Roo.data.Record[]} records The array of Records added
88 * @param {Number} index The index at which the record(s) were added
93 * Fires when a Record has been removed from the Store
95 * @param {Roo.data.Record} record The Record that was removed
96 * @param {Number} index The index at which the record was removed
101 * Fires when a Record has been updated
102 * @param {Store} this
103 * @param {Roo.data.Record} record The Record that was updated
104 * @param {String} operation The update operation being performed. Value may be one of:
107 Roo.data.Record.REJECT
108 Roo.data.Record.COMMIT
114 * Fires when the data cache has been cleared.
115 * @param {Store} this
120 * Fires before a request is made for a new data object. If the beforeload handler returns false
121 * the load action will be canceled.
122 * @param {Store} this
123 * @param {Object} options The loading options that were specified (see {@link #load} for details)
127 * @event beforeloadadd
128 * Fires after a new set of Records has been loaded.
129 * @param {Store} this
130 * @param {Roo.data.Record[]} records The Records that were loaded
131 * @param {Object} options The loading options that were specified (see {@link #load} for details)
133 beforeloadadd : true,
136 * Fires after a new set of Records has been loaded, before they are added to the store.
137 * @param {Store} this
138 * @param {Roo.data.Record[]} records The Records that were loaded
139 * @param {Object} options The loading options that were specified (see {@link #load} for details)
140 * @params {Object} return from reader
144 * @event loadexception
145 * Fires if an exception occurs in the Proxy during loading.
146 * Called with the signature of the Proxy's "loadexception" event.
147 * If you return Json { data: [] , success: false, .... } then this will be thrown with the following args
150 * @param {Object} return from JsonData.reader() - success, totalRecords, records
151 * @param {Object} load options
152 * @param {Object} jsonData from your request (normally this contains the Exception)
158 this.proxy = Roo.factory(this.proxy, Roo.data);
159 this.proxy.xmodule = this.xmodule || false;
160 this.relayEvents(this.proxy, ["loadexception"]);
162 this.sortToggle = {};
163 this.sortOrder = []; // array of order of sorting - updated by grid if multisort is enabled.
165 Roo.data.Store.superclass.constructor.call(this);
168 this.loadData(this.inlineData);
169 delete this.inlineData;
173 Roo.extend(Roo.data.Store, Roo.util.Observable, {
175 * @cfg {boolean} isLocal flag if data is locally available (and can be always looked up
176 * without a remote query - used by combo/forms at present.
180 * @cfg {Roo.data.DataProxy} proxy The Proxy object which provides access to a data object.
183 * @cfg {Array} data Inline data to be loaded when the store is initialized.
186 * @cfg {Roo.data.Reader} reader The Reader object which processes the data object and returns
187 * an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.
190 * @cfg {Object} baseParams An object containing properties which are to be sent as parameters
191 * on any HTTP request
194 * @cfg {Object} sortInfo A config object in the format: {field: "fieldName", direction: "ASC|DESC"}
197 * @cfg {Boolean} multiSort enable multi column sorting (sort is based on the order of columns, remote only at present)
201 * @cfg {boolean} remoteSort True if sorting is to be handled by requesting the Proxy to provide a refreshed
202 * version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).
207 * @cfg {boolean} pruneModifiedRecords True to clear all modified record information each time the store is
208 * loaded or when a record is removed. (defaults to false).
210 pruneModifiedRecords : false,
216 * Add Records to the Store and fires the add event.
217 * @param {Roo.data.Record[]} records An Array of Roo.data.Record objects to add to the cache.
219 add : function(records){
220 records = [].concat(records);
221 for(var i = 0, len = records.length; i < len; i++){
222 records[i].join(this);
224 var index = this.data.length;
225 this.data.addAll(records);
226 this.fireEvent("add", this, records, index);
230 * Remove a Record from the Store and fires the remove event.
231 * @param {Ext.data.Record} record The Roo.data.Record object to remove from the cache.
233 remove : function(record){
234 var index = this.data.indexOf(record);
235 this.data.removeAt(index);
236 if(this.pruneModifiedRecords){
237 this.modified.remove(record);
239 this.fireEvent("remove", this, record, index);
243 * Remove all Records from the Store and fires the clear event.
245 removeAll : function(){
247 if(this.pruneModifiedRecords){
250 this.fireEvent("clear", this);
254 * Inserts Records to the Store at the given index and fires the add event.
255 * @param {Number} index The start index at which to insert the passed Records.
256 * @param {Roo.data.Record[]} records An Array of Roo.data.Record objects to add to the cache.
258 insert : function(index, records){
259 records = [].concat(records);
260 for(var i = 0, len = records.length; i < len; i++){
261 this.data.insert(index, records[i]);
262 records[i].join(this);
264 this.fireEvent("add", this, records, index);
268 * Get the index within the cache of the passed Record.
269 * @param {Roo.data.Record} record The Roo.data.Record object to to find.
270 * @return {Number} The index of the passed Record. Returns -1 if not found.
272 indexOf : function(record){
273 return this.data.indexOf(record);
277 * Get the index within the cache of the Record with the passed id.
278 * @param {String} id The id of the Record to find.
279 * @return {Number} The index of the Record. Returns -1 if not found.
281 indexOfId : function(id){
282 return this.data.indexOfKey(id);
286 * Get the Record with the specified id.
287 * @param {String} id The id of the Record to find.
288 * @return {Roo.data.Record} The Record with the passed id. Returns undefined if not found.
290 getById : function(id){
291 return this.data.key(id);
295 * Get the Record at the specified index.
296 * @param {Number} index The index of the Record to find.
297 * @return {Roo.data.Record} The Record at the passed index. Returns undefined if not found.
299 getAt : function(index){
300 return this.data.itemAt(index);
304 * Returns a range of Records between specified indices.
305 * @param {Number} startIndex (optional) The starting index (defaults to 0)
306 * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store)
307 * @return {Roo.data.Record[]} An array of Records
309 getRange : function(start, end){
310 return this.data.getRange(start, end);
314 storeOptions : function(o){
315 o = Roo.apply({}, o);
318 this.lastOptions = o;
322 * Loads the Record cache from the configured Proxy using the configured Reader.
324 * If using remote paging, then the first load call must specify the <em>start</em>
325 * and <em>limit</em> properties in the options.params property to establish the initial
326 * position within the dataset, and the number of Records to cache on each read from the Proxy.
328 * <strong>It is important to note that for remote data sources, loading is asynchronous,
329 * and this call will return before the new data has been loaded. Perform any post-processing
330 * in a callback function, or in a "load" event handler.</strong>
332 * @param {Object} options An object containing properties which control loading options:<ul>
333 * <li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>
334 * <li>callback {Function} A function to be called after the Records have been loaded. The callback is
335 * passed the following arguments:<ul>
336 * <li>r : Roo.data.Record[]</li>
337 * <li>options: Options object from the load call</li>
338 * <li>success: Boolean success indicator</li></ul></li>
339 * <li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>
340 * <li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>
343 load : function(options){
344 options = options || {};
345 if(this.fireEvent("beforeload", this, options) !== false){
346 this.storeOptions(options);
347 var p = Roo.apply(options.params || {}, this.baseParams);
348 // if meta was not loaded from remote source.. try requesting it.
349 if (!this.reader.metaFromRemote) {
352 if(this.sortInfo && this.remoteSort){
353 var pn = this.paramNames;
354 p[pn["sort"]] = this.sortInfo.field;
355 p[pn["dir"]] = this.sortInfo.direction;
357 if (this.multiSort) {
358 var pn = this.paramNames;
359 Roo.log('sortToggle!!!!!!!!!!!!!!');
360 Roo.log(this.sortToggle);
361 p[pn["multisort"]] = Roo.encode( { sort : this.sortToggle, order: this.sortOrder });
364 this.proxy.load(p, this.reader, this.loadRecords, this, options);
369 * Reloads the Record cache from the configured Proxy using the configured Reader and
370 * the options from the last load operation performed.
371 * @param {Object} options (optional) An object containing properties which may override the options
372 * used in the last load operation. See {@link #load} for details (defaults to null, in which case
373 * the most recently used options are reused).
375 reload : function(options){
376 this.load(Roo.applyIf(options||{}, this.lastOptions));
380 // Called as a callback by the Reader during a load operation.
381 loadRecords : function(o, options, success){
382 if(!o || success === false){
383 if(success !== false){
384 this.fireEvent("load", this, [], options, o);
386 if(options.callback){
387 options.callback.call(options.scope || this, [], options, false);
391 // if data returned failure - throw an exception.
392 if (o.success === false) {
393 // show a message if no listener is registered.
394 if (!this.hasListener('loadexception') && typeof(o.raw.errorMsg) != 'undefined') {
395 Roo.MessageBox.alert("Error loading",o.raw.errorMsg);
397 // loadmask wil be hooked into this..
398 this.fireEvent("loadexception", this, o, options, o.raw.errorMsg);
401 var r = o.records, t = o.totalRecords || r.length;
403 this.fireEvent("beforeloadadd", this, r, options, o);
405 if(!options || options.add !== true){
406 if(this.pruneModifiedRecords){
409 for(var i = 0, len = r.length; i < len; i++){
413 this.data = this.snapshot;
414 delete this.snapshot;
418 this.totalLength = t;
420 this.fireEvent("datachanged", this);
422 this.totalLength = Math.max(t, this.data.length+r.length);
425 this.fireEvent("load", this, r, options, o);
426 if(options.callback){
427 options.callback.call(options.scope || this, r, options, true);
433 * Loads data from a passed data block. A Reader which understands the format of the data
434 * must have been configured in the constructor.
435 * @param {Object} data The data block from which to read the Records. The format of the data expected
436 * is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.
437 * @param {Boolean} append (Optional) True to append the new Records rather than replace the existing cache.
439 loadData : function(o, append){
440 var r = this.reader.readRecords(o);
441 this.loadRecords(r, {add: append}, true);
445 * Gets the number of cached records.
447 * <em>If using paging, this may not be the total size of the dataset. If the data object
448 * used by the Reader contains the dataset size, then the getTotalCount() function returns
449 * the data set size</em>
451 getCount : function(){
452 return this.data.length || 0;
456 * Gets the total number of records in the dataset as returned by the server.
458 * <em>If using paging, for this to be accurate, the data object used by the Reader must contain
459 * the dataset size</em>
461 getTotalCount : function(){
462 return this.totalLength || 0;
466 * Returns the sort state of the Store as an object with two properties:
468 field {String} The name of the field by which the Records are sorted
469 direction {String} The sort order, "ASC" or "DESC"
472 getSortState : function(){
473 return this.sortInfo;
477 applySort : function(){
478 if(this.sortInfo && !this.remoteSort){
479 var s = this.sortInfo, f = s.field;
480 var st = this.fields.get(f).sortType;
481 var fn = function(r1, r2){
482 var v1 = st(r1.data[f]), v2 = st(r2.data[f]);
483 return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0);
485 this.data.sort(s.direction, fn);
486 if(this.snapshot && this.snapshot != this.data){
487 this.snapshot.sort(s.direction, fn);
493 * Sets the default sort column and order to be used by the next load operation.
494 * @param {String} fieldName The name of the field to sort by.
495 * @param {String} dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC")
497 setDefaultSort : function(field, dir){
498 this.sortInfo = {field: field, direction: dir ? dir.toUpperCase() : "ASC"};
503 * If remote sorting is used, the sort is performed on the server, and the cache is
504 * reloaded. If local sorting is used, the cache is sorted internally.
505 * @param {String} fieldName The name of the field to sort by.
506 * @param {String} dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC")
508 sort : function(fieldName, dir){
509 var f = this.fields.get(fieldName);
511 this.sortToggle[f.name] = this.sortToggle[f.name] || f.sortDir;
513 if(this.multiSort || (this.sortInfo && this.sortInfo.field == f.name) ){ // toggle sort dir
514 dir = (this.sortToggle[f.name] || "ASC").toggle("ASC", "DESC");
519 this.sortToggle[f.name] = dir;
520 this.sortInfo = {field: f.name, direction: dir};
521 if(!this.remoteSort){
523 this.fireEvent("datachanged", this);
525 this.load(this.lastOptions);
530 * Calls the specified function for each of the Records in the cache.
531 * @param {Function} fn The function to call. The Record is passed as the first parameter.
532 * Returning <em>false</em> aborts and exits the iteration.
533 * @param {Object} scope (optional) The scope in which to call the function (defaults to the Record).
535 each : function(fn, scope){
536 this.data.each(fn, scope);
540 * Gets all records modified since the last commit. Modified records are persisted across load operations
541 * (e.g., during paging).
542 * @return {Roo.data.Record[]} An array of Records containing outstanding modifications.
544 getModifiedRecords : function(){
545 return this.modified;
549 createFilterFn : function(property, value, anyMatch){
550 if(!value.exec){ // not a regex
551 value = String(value);
552 if(value.length == 0){
555 value = new RegExp((anyMatch === true ? '' : '^') + Roo.escapeRe(value), "i");
558 return value.test(r.data[property]);
563 * Sums the value of <i>property</i> for each record between start and end and returns the result.
564 * @param {String} property A field on your records
565 * @param {Number} start The record index to start at (defaults to 0)
566 * @param {Number} end The last record index to include (defaults to length - 1)
567 * @return {Number} The sum
569 sum : function(property, start, end){
570 var rs = this.data.items, v = 0;
572 end = (end || end === 0) ? end : rs.length-1;
574 for(var i = start; i <= end; i++){
575 v += (rs[i].data[property] || 0);
581 * Filter the records by a specified property.
582 * @param {String} field A field on your records
583 * @param {String/RegExp} value Either a string that the field
584 * should start with or a RegExp to test against the field
585 * @param {Boolean} anyMatch True to match any part not just the beginning
587 filter : function(property, value, anyMatch){
588 var fn = this.createFilterFn(property, value, anyMatch);
589 return fn ? this.filterBy(fn) : this.clearFilter();
593 * Filter by a function. The specified function will be called with each
594 * record in this data source. If the function returns true the record is included,
595 * otherwise it is filtered.
596 * @param {Function} fn The function to be called, it will receive 2 args (record, id)
597 * @param {Object} scope (optional) The scope of the function (defaults to this)
599 filterBy : function(fn, scope){
600 this.snapshot = this.snapshot || this.data;
601 this.data = this.queryBy(fn, scope||this);
602 this.fireEvent("datachanged", this);
606 * Query the records by a specified property.
607 * @param {String} field A field on your records
608 * @param {String/RegExp} value Either a string that the field
609 * should start with or a RegExp to test against the field
610 * @param {Boolean} anyMatch True to match any part not just the beginning
611 * @return {MixedCollection} Returns an Roo.util.MixedCollection of the matched records
613 query : function(property, value, anyMatch){
614 var fn = this.createFilterFn(property, value, anyMatch);
615 return fn ? this.queryBy(fn) : this.data.clone();
619 * Query by a function. The specified function will be called with each
620 * record in this data source. If the function returns true the record is included
622 * @param {Function} fn The function to be called, it will receive 2 args (record, id)
623 * @param {Object} scope (optional) The scope of the function (defaults to this)
624 @return {MixedCollection} Returns an Roo.util.MixedCollection of the matched records
626 queryBy : function(fn, scope){
627 var data = this.snapshot || this.data;
628 return data.filterBy(fn, scope||this);
632 * Collects unique values for a particular dataIndex from this store.
633 * @param {String} dataIndex The property to collect
634 * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values
635 * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered
636 * @return {Array} An array of the unique values
638 collect : function(dataIndex, allowNull, bypassFilter){
639 var d = (bypassFilter === true && this.snapshot) ?
640 this.snapshot.items : this.data.items;
641 var v, sv, r = [], l = {};
642 for(var i = 0, len = d.length; i < len; i++){
643 v = d[i].data[dataIndex];
645 if((allowNull || !Roo.isEmpty(v)) && !l[sv]){
654 * Revert to a view of the Record cache with no filtering applied.
655 * @param {Boolean} suppressEvent If true the filter is cleared silently without notifying listeners
657 clearFilter : function(suppressEvent){
658 if(this.snapshot && this.snapshot != this.data){
659 this.data = this.snapshot;
660 delete this.snapshot;
661 if(suppressEvent !== true){
662 this.fireEvent("datachanged", this);
668 afterEdit : function(record){
669 if(this.modified.indexOf(record) == -1){
670 this.modified.push(record);
672 this.fireEvent("update", this, record, Roo.data.Record.EDIT);
676 afterReject : function(record){
677 this.modified.remove(record);
678 this.fireEvent("update", this, record, Roo.data.Record.REJECT);
682 afterCommit : function(record){
683 this.modified.remove(record);
684 this.fireEvent("update", this, record, Roo.data.Record.COMMIT);
688 * Commit all Records with outstanding changes. To handle updates for changes, subscribe to the
689 * Store's "update" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.
691 commitChanges : function(){
692 var m = this.modified.slice(0);
694 for(var i = 0, len = m.length; i < len; i++){
700 * Cancel outstanding changes on all changed records.
702 rejectChanges : function(){
703 var m = this.modified.slice(0);
705 for(var i = 0, len = m.length; i < len; i++){
710 onMetaChange : function(meta, rtype, o){
711 this.recordType = rtype;
712 this.fields = rtype.prototype.fields;
713 delete this.snapshot;
714 this.sortInfo = meta.sortInfo || this.sortInfo;
716 this.fireEvent('metachange', this, this.reader.meta);
719 moveIndex : function(data, type)
721 var index = this.indexOf(data);
723 var newIndex = index + type;
727 this.insert(newIndex, data);