DataReader.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:7k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.0.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.data.DataReader
  3.  * Abstract base class for reading structured data from a data source and converting
  4.  * it into an object containing {@link Ext.data.Record} objects and metadata for use
  5.  * by an {@link Ext.data.Store}.  This class is intended to be extended and should not
  6.  * be created directly. For existing implementations, see {@link Ext.data.ArrayReader},
  7.  * {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}.
  8.  * @constructor Create a new DataReader
  9.  * @param {Object} meta Metadata configuration options (implementation-specific).
  10.  * @param {Array/Object} recordType
  11.  * <p>Either an Array of {@link Ext.data.Field Field} definition objects (which
  12.  * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
  13.  * constructor created using {@link Ext.data.Record#create}.</p>
  14.  */
  15. Ext.data.DataReader = function(meta, recordType){
  16.     /**
  17.      * This DataReader's configured metadata as passed to the constructor.
  18.      * @type Mixed
  19.      * @property meta
  20.      */
  21.     this.meta = meta;
  22.     /**
  23.      * @cfg {Array/Object} fields
  24.      * <p>Either an Array of {@link Ext.data.Field Field} definition objects (which
  25.      * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
  26.      * constructor created from {@link Ext.data.Record#create}.</p>
  27.      */
  28.     this.recordType = Ext.isArray(recordType) ?
  29.         Ext.data.Record.create(recordType) : recordType;
  30. };
  31. Ext.data.DataReader.prototype = {
  32.     /**
  33.      * Abstract method, overridden in {@link Ext.data.JsonReader}
  34.      */
  35.     buildExtractors : Ext.emptyFn,
  36.     /**
  37.      * Used for un-phantoming a record after a successful database insert.  Sets the records pk along with new data from server.
  38.      * You <b>must</b> return at least the database pk using the idProperty defined in your DataReader configuration.  The incoming
  39.      * data from server will be merged with the data in the local record.
  40.      * In addition, you <b>must</b> return record-data from the server in the same order received.
  41.      * Will perform a commit as well, un-marking dirty-fields.  Store's "update" event will be suppressed.
  42.      * @param {Record/Record[]} record The phantom record to be realized.
  43.      * @param {Object/Object[]} data The new record data to apply.  Must include the primary-key from database defined in idProperty field.
  44.      */
  45.     realize: function(rs, data){
  46.         if (Ext.isArray(rs)) {
  47.             for (var i = rs.length - 1; i >= 0; i--) {
  48.                 // recurse
  49.                 if (Ext.isArray(data)) {
  50.                     this.realize(rs.splice(i,1).shift(), data.splice(i,1).shift());
  51.                 }
  52.                 else {
  53.                     // weird...rs is an array but data isn't??  recurse but just send in the whole invalid data object.
  54.                     // the else clause below will detect !this.isData and throw exception.
  55.                     this.realize(rs.splice(i,1).shift(), data);
  56.                 }
  57.             }
  58.         }
  59.         else {
  60.             // If rs is NOT an array but data IS, see if data contains just 1 record.  If so extract it and carry on.
  61.             if (Ext.isArray(data) && data.length == 1) {
  62.                 data = data.shift();
  63.             }
  64.             if (!this.isData(data)) {
  65.                 // TODO: Let exception-handler choose to commit or not rather than blindly rs.commit() here.
  66.                 //rs.commit();
  67.                 throw new Ext.data.DataReader.Error('realize', rs);
  68.             }
  69.             this.buildExtractors();
  70.             var values = this.extractValues(data, rs.fields.items, rs.fields.items.length);
  71.             rs.phantom = false; // <-- That's what it's all about
  72.             rs._phid = rs.id;  // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords
  73.             rs.id = data[this.meta.idProperty];
  74.             rs.data = values;
  75.             rs.commit();
  76.         }
  77.     },
  78.     /**
  79.      * Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
  80.      * You <b>must</b> return a complete new record from the server.  If you don't, your local record's missing fields
  81.      * will be populated with the default values specified in your Ext.data.Record.create specification.  Without a defaultValue,
  82.      * local fields will be populated with empty string "".  So return your entire record's data after both remote create and update.
  83.      * In addition, you <b>must</b> return record-data from the server in the same order received.
  84.      * Will perform a commit as well, un-marking dirty-fields.  Store's "update" event will be suppressed as the record receives
  85.      * a fresh new data-hash.
  86.      * @param {Record/Record[]} rs
  87.      * @param {Object/Object[]} data
  88.      */
  89.     update : function(rs, data) {
  90.         if (Ext.isArray(rs)) {
  91.             for (var i=rs.length-1; i >= 0; i--) {
  92.                 if (Ext.isArray(data)) {
  93.                     this.update(rs.splice(i,1).shift(), data.splice(i,1).shift());
  94.                 }
  95.                 else {
  96.                     // weird...rs is an array but data isn't??  recurse but just send in the whole data object.
  97.                     // the else clause below will detect !this.isData and throw exception.
  98.                     this.update(rs.splice(i,1).shift(), data);
  99.                 }
  100.             }
  101.         }
  102.         else {
  103.                      // If rs is NOT an array but data IS, see if data contains just 1 record.  If so extract it and carry on.
  104.             if (Ext.isArray(data) && data.length == 1) {
  105.                 data = data.shift();
  106.             }
  107.             if (!this.isData(data)) {
  108.                 // TODO: create custom Exception class to return record in thrown exception.  Allow exception-handler the choice
  109.                 // to commit or not rather than blindly rs.commit() here.
  110.                 rs.commit();
  111.                 throw new Ext.data.DataReader.Error('update', rs);
  112.             }
  113.             this.buildExtractors();
  114.             rs.data = this.extractValues(Ext.apply(rs.data, data), rs.fields.items, rs.fields.items.length);
  115.             rs.commit();
  116.         }
  117.     },
  118.     /**
  119.      * Returns true if the supplied data-hash <b>looks</b> and quacks like data.  Checks to see if it has a key
  120.      * corresponding to idProperty defined in your DataReader config containing non-empty pk.
  121.      * @param {Object} data
  122.      * @return {Boolean}
  123.      */
  124.     isData : function(data) {
  125.         return (data && Ext.isObject(data) && !Ext.isEmpty(data[this.meta.idProperty])) ? true : false;
  126.     }
  127. };
  128. /**
  129.  * @class Ext.data.DataReader.Error
  130.  * @extends Ext.Error
  131.  * General error class for Ext.data.DataReader
  132.  */
  133. Ext.data.DataReader.Error = Ext.extend(Ext.Error, {
  134.     constructor : function(message, arg) {
  135.         this.arg = arg;
  136.         Ext.Error.call(this, message);
  137.     },
  138.     name: 'Ext.data.DataReader'
  139. });
  140. Ext.apply(Ext.data.DataReader.Error.prototype, {
  141.     lang : {
  142.         'update': "#update received invalid data from server.  Please see docs for DataReader#update and review your DataReader configuration.",
  143.         'realize': "#realize was called with invalid remote-data.  Please see the docs for DataReader#realize and review your DataReader configuration.",
  144.         'invalid-response': "#readResponse received an invalid response from the server."
  145.     }
  146. });