Upgrade to ExtJS 3.1.1 - Released 02/08/2010
[extjs.git] / src / data / DataReader.js
index d9329d6..f9e01c5 100644 (file)
@@ -1,6 +1,6 @@
 /*!
- * Ext JS Library 3.0.0
- * Copyright(c) 2006-2009 Ext JS, LLC
+ * Ext JS Library 3.1.1
+ * Copyright(c) 2006-2010 Ext JS, LLC
  * licensing@extjs.com
  * http://www.extjs.com/license
  */
@@ -33,14 +33,49 @@ Ext.data.DataReader = function(meta, recordType){
      */\r
     this.recordType = Ext.isArray(recordType) ?\r
         Ext.data.Record.create(recordType) : recordType;\r
+
+    // if recordType defined make sure extraction functions are defined\r
+    if (this.recordType){\r
+        this.buildExtractors();\r
+    }
 };\r
 \r
 Ext.data.DataReader.prototype = {\r
-\r
     /**\r
-     * Abstract method, overridden in {@link Ext.data.JsonReader}\r
+     * @cfg {String} messageProperty [undefined] Optional name of a property within a server-response that represents a user-feedback message.\r
+     */\r
+    /**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getTotal: Ext.emptyFn,\r
+    /**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getRoot: Ext.emptyFn,\r
+    /**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getMessage: Ext.emptyFn,\r
+    /**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getSuccess: Ext.emptyFn,\r
+    /**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getId: Ext.emptyFn,\r
+    /**\r
+     * Abstract method, overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}\r
      */\r
     buildExtractors : Ext.emptyFn,\r
+    /**\r
+     * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}\r
+     */\r
+    extractData : Ext.emptyFn,\r
+    /**\r
+     * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}\r
+     */\r
+    extractValues : Ext.emptyFn,\r
 \r
     /**\r
      * Used for un-phantoming a record after a successful database insert.  Sets the records pk along with new data from server.\r
@@ -75,24 +110,24 @@ Ext.data.DataReader.prototype = {
                 //rs.commit();\r
                 throw new Ext.data.DataReader.Error('realize', rs);\r
             }\r
-            this.buildExtractors();\r
-            var values = this.extractValues(data, rs.fields.items, rs.fields.items.length);\r
             rs.phantom = false; // <-- That's what it's all about\r
             rs._phid = rs.id;  // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords\r
-            rs.id = data[this.meta.idProperty];\r
-            rs.data = values;\r
+            rs.id = this.getId(data);\r
+\r
+            rs.fields.each(function(f) {\r
+                if (data[f.name] !== f.defaultValue) {\r
+                    rs.data[f.name] = data[f.name];\r
+                }\r
+            });\r
             rs.commit();\r
         }\r
     },\r
 \r
     /**\r
      * Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.\r
-     * You <b>must</b> return a complete new record from the server.  If you don't, your local record's missing fields\r
-     * will be populated with the default values specified in your Ext.data.Record.create specification.  Without a defaultValue,\r
-     * local fields will be populated with empty string "".  So return your entire record's data after both remote create and update.\r
-     * In addition, you <b>must</b> return record-data from the server in the same order received.\r
-     * Will perform a commit as well, un-marking dirty-fields.  Store's "update" event will be suppressed as the record receives\r
-     * a fresh new data-hash.\r
+     * If returning data from multiple-records after a batch-update, you <b>must</b> return record-data from the server in\r
+     * the same order received.  Will perform a commit as well, un-marking dirty-fields.  Store's "update" event will be\r
+     * suppressed as the record receives fresh new data-hash\r
      * @param {Record/Record[]} rs\r
      * @param {Object/Object[]} data\r
      */\r
@@ -110,22 +145,61 @@ Ext.data.DataReader.prototype = {
             }\r
         }\r
         else {\r
-                     // If rs is NOT an array but data IS, see if data contains just 1 record.  If so extract it and carry on.\r
+            // If rs is NOT an array but data IS, see if data contains just 1 record.  If so extract it and carry on.\r
             if (Ext.isArray(data) && data.length == 1) {\r
                 data = data.shift();\r
             }\r
-            if (!this.isData(data)) {\r
-                // TODO: create custom Exception class to return record in thrown exception.  Allow exception-handler the choice\r
-                // to commit or not rather than blindly rs.commit() here.\r
-                rs.commit();\r
-                throw new Ext.data.DataReader.Error('update', rs);\r
+            if (this.isData(data)) {\r
+                rs.fields.each(function(f) {\r
+                    if (data[f.name] !== f.defaultValue) {\r
+                        rs.data[f.name] = data[f.name];\r
+                    }\r
+                });\r
             }\r
-            this.buildExtractors();\r
-            rs.data = this.extractValues(Ext.apply(rs.data, data), rs.fields.items, rs.fields.items.length);\r
             rs.commit();\r
         }\r
     },\r
 \r
+    /**\r
+     * returns extracted, type-cast rows of data.  Iterates to call #extractValues for each row\r
+     * @param {Object[]/Object} data-root from server response\r
+     * @param {Boolean} returnRecords [false] Set true to return instances of Ext.data.Record\r
+     * @private\r
+     */\r
+    extractData : function(root, returnRecords) {\r
+        // A bit ugly this, too bad the Record's raw data couldn't be saved in a common property named "raw" or something.\r
+        var rawName = (this instanceof Ext.data.JsonReader) ? 'json' : 'node';\r
+\r
+        var rs = [];\r
+\r
+        // Had to add Check for XmlReader, #isData returns true if root is an Xml-object.  Want to check in order to re-factor\r
+        // #extractData into DataReader base, since the implementations are almost identical for JsonReader, XmlReader\r
+        if (this.isData(root) && !(this instanceof Ext.data.XmlReader)) {\r
+            root = [root];\r
+        }\r
+        var f       = this.recordType.prototype.fields,\r
+            fi      = f.items,\r
+            fl      = f.length,\r
+            rs      = [];\r
+        if (returnRecords === true) {\r
+            var Record = this.recordType;\r
+            for (var i = 0; i < root.length; i++) {\r
+                var n = root[i];\r
+                var record = new Record(this.extractValues(n, fi, fl), this.getId(n));\r
+                record[rawName] = n;    // <-- There's implementation of ugly bit, setting the raw record-data.\r
+                rs.push(record);\r
+            }\r
+        }\r
+        else {\r
+            for (var i = 0; i < root.length; i++) {\r
+                var data = this.extractValues(root[i], fi, fl);\r
+                data[this.meta.idProperty] = this.getId(root[i]);\r
+                rs.push(data);\r
+            }\r
+        }\r
+        return rs;\r
+    },\r
+\r
     /**\r
      * Returns true if the supplied data-hash <b>looks</b> and quacks like data.  Checks to see if it has a key\r
      * corresponding to idProperty defined in your DataReader config containing non-empty pk.\r
@@ -133,7 +207,15 @@ Ext.data.DataReader.prototype = {
      * @return {Boolean}\r
      */\r
     isData : function(data) {\r
-        return (data && Ext.isObject(data) && !Ext.isEmpty(data[this.meta.idProperty])) ? true : false;\r
+        return (data && Ext.isObject(data) && !Ext.isEmpty(this.getId(data))) ? true : false;\r
+    },\r
+\r
+    // private function a store will createSequence upon\r
+    onMetaChange : function(meta){\r
+        delete this.ef;\r
+        this.meta = meta;\r
+        this.recordType = Ext.data.Record.create(meta.fields);\r
+        this.buildExtractors();\r
     }\r
 };\r
 \r
@@ -156,5 +238,3 @@ Ext.apply(Ext.data.DataReader.Error.prototype, {
         'invalid-response': "#readResponse received an invalid response from the server."\r
     }\r
 });\r
-\r
-\r