3 <title>The source code</title>
4 <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
5 <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 <body onload="prettyPrint();">
8 <pre class="prettyprint lang-js">/*!
10 * Copyright(c) 2006-2009 Ext JS, LLC
12 * http://www.extjs.com/license
14 <div id="cls-Ext.data.DataReader"></div>/**
\r
15 * @class Ext.data.DataReader
\r
16 * Abstract base class for reading structured data from a data source and converting
\r
17 * it into an object containing {@link Ext.data.Record} objects and metadata for use
\r
18 * by an {@link Ext.data.Store}. This class is intended to be extended and should not
\r
19 * be created directly. For existing implementations, see {@link Ext.data.ArrayReader},
\r
20 * {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}.
\r
21 * @constructor Create a new DataReader
\r
22 * @param {Object} meta Metadata configuration options (implementation-specific).
\r
23 * @param {Array/Object} recordType
\r
24 * <p>Either an Array of {@link Ext.data.Field Field} definition objects (which
\r
25 * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
\r
26 * constructor created using {@link Ext.data.Record#create}.</p>
\r
28 Ext.data.DataReader = function(meta, recordType){
\r
29 <div id="prop-Ext.data.DataReader-meta"></div>/**
\r
30 * This DataReader's configured metadata as passed to the constructor.
\r
35 <div id="cfg-Ext.data.DataReader-fields"></div>/**
\r
36 * @cfg {Array/Object} fields
\r
37 * <p>Either an Array of {@link Ext.data.Field Field} definition objects (which
\r
38 * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
\r
39 * constructor created from {@link Ext.data.Record#create}.</p>
\r
41 this.recordType = Ext.isArray(recordType) ?
\r
42 Ext.data.Record.create(recordType) : recordType;
\r
44 // if recordType defined make sure extraction functions are defined
\r
45 if (this.recordType){
\r
46 this.buildExtractors();
\r
50 Ext.data.DataReader.prototype = {
\r
51 <div id="cfg-Ext.data.DataReader-messageProperty"></div>/**
\r
52 * @cfg {String} messageProperty [undefined] Optional name of a property within a server-response that represents a user-feedback message.
\r
54 <div id="prop-Ext.data.DataReader-getTotal"></div>/**
\r
55 * Abstract method created in extension's buildExtractors impl.
\r
57 getTotal: Ext.emptyFn,
\r
58 <div id="prop-Ext.data.DataReader-getRoot"></div>/**
\r
59 * Abstract method created in extension's buildExtractors impl.
\r
61 getRoot: Ext.emptyFn,
\r
62 <div id="prop-Ext.data.DataReader-getMessage"></div>/**
\r
63 * Abstract method created in extension's buildExtractors impl.
\r
65 getMessage: Ext.emptyFn,
\r
66 <div id="prop-Ext.data.DataReader-getSuccess"></div>/**
\r
67 * Abstract method created in extension's buildExtractors impl.
\r
69 getSuccess: Ext.emptyFn,
\r
70 <div id="prop-Ext.data.DataReader-getId"></div>/**
\r
71 * Abstract method created in extension's buildExtractors impl.
\r
74 <div id="prop-Ext.data.DataReader-buildExtractors"></div>/**
\r
75 * Abstract method, overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}
\r
77 buildExtractors : Ext.emptyFn,
\r
78 <div id="prop-Ext.data.DataReader-extractData"></div>/**
\r
79 * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}
\r
81 extractData : Ext.emptyFn,
\r
82 <div id="prop-Ext.data.DataReader-extractValues"></div>/**
\r
83 * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}
\r
85 extractValues : Ext.emptyFn,
\r
87 <div id="method-Ext.data.DataReader-realize"></div>/**
\r
88 * Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server.
\r
89 * You <b>must</b> return at least the database pk using the idProperty defined in your DataReader configuration. The incoming
\r
90 * data from server will be merged with the data in the local record.
\r
91 * In addition, you <b>must</b> return record-data from the server in the same order received.
\r
92 * Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed.
\r
93 * @param {Record/Record[]} record The phantom record to be realized.
\r
94 * @param {Object/Object[]} data The new record data to apply. Must include the primary-key from database defined in idProperty field.
\r
96 realize: function(rs, data){
\r
97 if (Ext.isArray(rs)) {
\r
98 for (var i = rs.length - 1; i >= 0; i--) {
\r
100 if (Ext.isArray(data)) {
\r
101 this.realize(rs.splice(i,1).shift(), data.splice(i,1).shift());
\r
104 // weird...rs is an array but data isn't?? recurse but just send in the whole invalid data object.
\r
105 // the else clause below will detect !this.isData and throw exception.
\r
106 this.realize(rs.splice(i,1).shift(), data);
\r
111 // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on.
\r
112 if (Ext.isArray(data) && data.length == 1) {
\r
113 data = data.shift();
\r
115 if (!this.isData(data)) {
\r
116 // TODO: Let exception-handler choose to commit or not rather than blindly rs.commit() here.
\r
118 throw new Ext.data.DataReader.Error('realize', rs);
\r
120 rs.phantom = false; // <-- That's what it's all about
\r
121 rs._phid = rs.id; // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords
\r
122 rs.id = this.getId(data);
\r
128 <div id="method-Ext.data.DataReader-update"></div>/**
\r
129 * Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
\r
130 * If returning data from multiple-records after a batch-update, you <b>must</b> return record-data from the server in
\r
131 * the same order received. Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be
\r
132 * suppressed as the record receives fresh new data-hash
\r
133 * @param {Record/Record[]} rs
\r
134 * @param {Object/Object[]} data
\r
136 update : function(rs, data) {
\r
137 if (Ext.isArray(rs)) {
\r
138 for (var i=rs.length-1; i >= 0; i--) {
\r
139 if (Ext.isArray(data)) {
\r
140 this.update(rs.splice(i,1).shift(), data.splice(i,1).shift());
\r
143 // weird...rs is an array but data isn't?? recurse but just send in the whole data object.
\r
144 // the else clause below will detect !this.isData and throw exception.
\r
145 this.update(rs.splice(i,1).shift(), data);
\r
150 // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on.
\r
151 if (Ext.isArray(data) && data.length == 1) {
\r
152 data = data.shift();
\r
154 if (this.isData(data)) {
\r
155 rs.data = Ext.apply(rs.data, data);
\r
161 <div id="method-Ext.data.DataReader-isData"></div>/**
\r
162 * Returns true if the supplied data-hash <b>looks</b> and quacks like data. Checks to see if it has a key
\r
163 * corresponding to idProperty defined in your DataReader config containing non-empty pk.
\r
164 * @param {Object} data
\r
165 * @return {Boolean}
\r
167 isData : function(data) {
\r
168 return (data && Ext.isObject(data) && !Ext.isEmpty(this.getId(data))) ? true : false;
\r
171 // private function a store will createSequence upon
\r
172 onMetaChange : function(meta){
\r
175 this.recordType = Ext.data.Record.create(meta.fields);
\r
176 this.buildExtractors();
\r
180 <div id="cls-Ext.data.DataReader.Error"></div>/**
\r
181 * @class Ext.data.DataReader.Error
\r
182 * @extends Ext.Error
\r
183 * General error class for Ext.data.DataReader
\r
185 Ext.data.DataReader.Error = Ext.extend(Ext.Error, {
\r
186 constructor : function(message, arg) {
\r
188 Ext.Error.call(this, message);
\r
190 name: 'Ext.data.DataReader'
\r
192 Ext.apply(Ext.data.DataReader.Error.prototype, {
\r
194 'update': "#update received invalid data from server. Please see docs for DataReader#update and review your DataReader configuration.",
\r
195 'realize': "#realize was called with invalid remote-data. Please see the docs for DataReader#realize and review your DataReader configuration.",
\r
196 'invalid-response': "#readResponse received an invalid response from the server."
\r
201 <div id="method-Ext.data.DataReader.Error-Response"></div>/**
\r
202 * Ext.data.Response
\r
203 * A generic response class to normalize response-handling internally to the framework.
\r
204 * TODO move to own file, add to jsb.
\r
206 Ext.data.Response = function(params) {
\r
207 Ext.apply(this, params);
\r
209 Ext.data.Response.prototype = {
\r
210 <div id="prop-Ext.data.DataReader.Error-{String}"></div>/**
\r
211 * @property {String} action {@link Ext.data.Api#actions}
\r
214 <div id="prop-Ext.data.DataReader.Error-{Boolean}"></div>/**
\r
215 * @property {Boolean} success
\r
217 success : undefined,
\r
218 <div id="prop-Ext.data.DataReader.Error-{String}"></div>/**
\r
219 * @property {String} message
\r
221 message : undefined,
\r
222 <div id="prop-Ext.data.DataReader.Error-{Array/Object}"></div>/**
\r
223 * @property {Array/Object} data
\r
226 <div id="prop-Ext.data.DataReader.Error-{Object}"></div>/**
\r
227 * @property {Object} raw The raw response returned from server-code
\r
230 <div id="prop-Ext.data.DataReader.Error-{Ext.data.Record/Ext.data.Record[]}"></div>/**
\r
231 * @property {Ext.data.Record/Ext.data.Record[]} record(s) related to the Request action
\r