3 * Copyright(c) 2006-2010 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.data.DataReader
\r
9 * Abstract base class for reading structured data from a data source and converting
\r
10 * it into an object containing {@link Ext.data.Record} objects and metadata for use
\r
11 * by an {@link Ext.data.Store}. This class is intended to be extended and should not
\r
12 * be created directly. For existing implementations, see {@link Ext.data.ArrayReader},
\r
13 * {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}.
\r
14 * @constructor Create a new DataReader
\r
15 * @param {Object} meta Metadata configuration options (implementation-specific).
\r
16 * @param {Array/Object} recordType
\r
17 * <p>Either an Array of {@link Ext.data.Field Field} definition objects (which
\r
18 * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
\r
19 * constructor created using {@link Ext.data.Record#create}.</p>
\r
21 Ext.data.DataReader = function(meta, recordType){
\r
23 * This DataReader's configured metadata as passed to the constructor.
\r
29 * @cfg {Array/Object} fields
\r
30 * <p>Either an Array of {@link Ext.data.Field Field} definition objects (which
\r
31 * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
\r
32 * constructor created from {@link Ext.data.Record#create}.</p>
\r
34 this.recordType = Ext.isArray(recordType) ?
\r
35 Ext.data.Record.create(recordType) : recordType;
\r
37 // if recordType defined make sure extraction functions are defined
\r
38 if (this.recordType){
\r
39 this.buildExtractors();
\r
43 Ext.data.DataReader.prototype = {
\r
45 * @cfg {String} messageProperty [undefined] Optional name of a property within a server-response that represents a user-feedback message.
\r
48 * Abstract method created in extension's buildExtractors impl.
\r
50 getTotal: Ext.emptyFn,
\r
52 * Abstract method created in extension's buildExtractors impl.
\r
54 getRoot: Ext.emptyFn,
\r
56 * Abstract method created in extension's buildExtractors impl.
\r
58 getMessage: Ext.emptyFn,
\r
60 * Abstract method created in extension's buildExtractors impl.
\r
62 getSuccess: Ext.emptyFn,
\r
64 * Abstract method created in extension's buildExtractors impl.
\r
68 * Abstract method, overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}
\r
70 buildExtractors : Ext.emptyFn,
\r
72 * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}
\r
74 extractData : Ext.emptyFn,
\r
76 * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}
\r
78 extractValues : Ext.emptyFn,
\r
81 * Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server.
\r
82 * You <b>must</b> return at least the database pk using the idProperty defined in your DataReader configuration. The incoming
\r
83 * data from server will be merged with the data in the local record.
\r
84 * In addition, you <b>must</b> return record-data from the server in the same order received.
\r
85 * Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed.
\r
86 * @param {Record/Record[]} record The phantom record to be realized.
\r
87 * @param {Object/Object[]} data The new record data to apply. Must include the primary-key from database defined in idProperty field.
\r
89 realize: function(rs, data){
\r
90 if (Ext.isArray(rs)) {
\r
91 for (var i = rs.length - 1; i >= 0; i--) {
\r
93 if (Ext.isArray(data)) {
\r
94 this.realize(rs.splice(i,1).shift(), data.splice(i,1).shift());
\r
97 // weird...rs is an array but data isn't?? recurse but just send in the whole invalid data object.
\r
98 // the else clause below will detect !this.isData and throw exception.
\r
99 this.realize(rs.splice(i,1).shift(), data);
\r
104 // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on.
\r
105 if (Ext.isArray(data) && data.length == 1) {
\r
106 data = data.shift();
\r
108 if (!this.isData(data)) {
\r
109 // TODO: Let exception-handler choose to commit or not rather than blindly rs.commit() here.
\r
111 throw new Ext.data.DataReader.Error('realize', rs);
\r
113 rs.phantom = false; // <-- That's what it's all about
\r
114 rs._phid = rs.id; // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords
\r
115 rs.id = this.getId(data);
\r
117 rs.fields.each(function(f) {
\r
118 if (data[f.name] !== f.defaultValue) {
\r
119 rs.data[f.name] = data[f.name];
\r
127 * Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
\r
128 * If returning data from multiple-records after a batch-update, you <b>must</b> return record-data from the server in
\r
129 * the same order received. Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be
\r
130 * suppressed as the record receives fresh new data-hash
\r
131 * @param {Record/Record[]} rs
\r
132 * @param {Object/Object[]} data
\r
134 update : function(rs, data) {
\r
135 if (Ext.isArray(rs)) {
\r
136 for (var i=rs.length-1; i >= 0; i--) {
\r
137 if (Ext.isArray(data)) {
\r
138 this.update(rs.splice(i,1).shift(), data.splice(i,1).shift());
\r
141 // weird...rs is an array but data isn't?? recurse but just send in the whole data object.
\r
142 // the else clause below will detect !this.isData and throw exception.
\r
143 this.update(rs.splice(i,1).shift(), data);
\r
148 // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on.
\r
149 if (Ext.isArray(data) && data.length == 1) {
\r
150 data = data.shift();
\r
152 if (this.isData(data)) {
\r
153 rs.fields.each(function(f) {
\r
154 if (data[f.name] !== f.defaultValue) {
\r
155 rs.data[f.name] = data[f.name];
\r
164 * returns extracted, type-cast rows of data. Iterates to call #extractValues for each row
\r
165 * @param {Object[]/Object} data-root from server response
\r
166 * @param {Boolean} returnRecords [false] Set true to return instances of Ext.data.Record
\r
169 extractData : function(root, returnRecords) {
\r
170 // A bit ugly this, too bad the Record's raw data couldn't be saved in a common property named "raw" or something.
\r
171 var rawName = (this instanceof Ext.data.JsonReader) ? 'json' : 'node';
\r
175 // Had to add Check for XmlReader, #isData returns true if root is an Xml-object. Want to check in order to re-factor
\r
176 // #extractData into DataReader base, since the implementations are almost identical for JsonReader, XmlReader
\r
177 if (this.isData(root) && !(this instanceof Ext.data.XmlReader)) {
\r
180 var f = this.recordType.prototype.fields,
\r
184 if (returnRecords === true) {
\r
185 var Record = this.recordType;
\r
186 for (var i = 0; i < root.length; i++) {
\r
188 var record = new Record(this.extractValues(n, fi, fl), this.getId(n));
\r
189 record[rawName] = n; // <-- There's implementation of ugly bit, setting the raw record-data.
\r
194 for (var i = 0; i < root.length; i++) {
\r
195 var data = this.extractValues(root[i], fi, fl);
\r
196 data[this.meta.idProperty] = this.getId(root[i]);
\r
204 * Returns true if the supplied data-hash <b>looks</b> and quacks like data. Checks to see if it has a key
\r
205 * corresponding to idProperty defined in your DataReader config containing non-empty pk.
\r
206 * @param {Object} data
\r
207 * @return {Boolean}
\r
209 isData : function(data) {
\r
210 return (data && Ext.isObject(data) && !Ext.isEmpty(this.getId(data))) ? true : false;
\r
213 // private function a store will createSequence upon
\r
214 onMetaChange : function(meta){
\r
217 this.recordType = Ext.data.Record.create(meta.fields);
\r
218 this.buildExtractors();
\r
223 * @class Ext.data.DataReader.Error
\r
224 * @extends Ext.Error
\r
225 * General error class for Ext.data.DataReader
\r
227 Ext.data.DataReader.Error = Ext.extend(Ext.Error, {
\r
228 constructor : function(message, arg) {
\r
230 Ext.Error.call(this, message);
\r
232 name: 'Ext.data.DataReader'
\r
234 Ext.apply(Ext.data.DataReader.Error.prototype, {
\r
236 'update': "#update received invalid data from server. Please see docs for DataReader#update and review your DataReader configuration.",
\r
237 'realize': "#realize was called with invalid remote-data. Please see the docs for DataReader#realize and review your DataReader configuration.",
\r
238 'invalid-response': "#readResponse received an invalid response from the server."
\r