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