git.roojs.org Git - roojs1/blob - Roo/data/ArrayReader.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12 /**
  13  * @class Roo.data.ArrayReader
  14  * @extends Roo.data.DataReader
  15  * Data reader class to create an Array of Roo.data.Record objects from an Array.
  16  * Each element of that Array represents a row of data fields. The
  17  * fields are pulled into a Record object using as a subscript, the <em>mapping</em> property
  18  * of the field definition if it exists, or the field's ordinal position in the definition.<br>
  19  * <p>
  20  * Example code:.
  21  * <pre><code>
  22 var RecordDef = Roo.data.Record.create([
  23     {name: 'name', mapping: 1},         // "mapping" only needed if an "id" field is present which
  24     {name: 'occupation', mapping: 2}    // precludes using the ordinal position as the index.
  25 ]);
  26 var myReader = new Roo.data.ArrayReader({
  27     id: 0                     // The subscript within row Array that provides an ID for the Record (optional)
  28 }, RecordDef);
  29 </code></pre>
  30  * <p>
  31  * This would consume an Array like this:
  32  * <pre><code>
  33 [ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]
  34   </code></pre>
  35  * @cfg {String} id (optional) The subscript within row Array that provides an ID for the Record
  36  * @constructor
  37  * Create a new JsonReader
  38  * @param {Object} meta Metadata configuration options.
  39  * @param {Object} recordType Either an Array of field definition objects
  40  * @cfg {Array} fields Array of field definition objects
  41  * @cfg {String} id Name of the property within a row object that contains a record identifier value.
  42  * as specified to {@link Roo.data.Record#create},
  43  * or an {@link Roo.data.Record} object
  44  * created using {@link Roo.data.Record#create}.
  45  */
  46 Roo.data.ArrayReader = function(meta, recordType){
  47
  48
  49     Roo.data.ArrayReader.superclass.constructor.call(this, meta, recordType||meta.fields);
  50 };
  51
  52 Roo.extend(Roo.data.ArrayReader, Roo.data.JsonReader, {
  53     /**
  54      * Create a data block containing Roo.data.Records from an XML document.
  55      * @param {Object} o An Array of row objects which represents the dataset.
  56      * @return {Object} data A data block which is used by an Roo.data.Store object as
  57      * a cache of Roo.data.Records.
  58      */
  59     readRecords : function(o){
  60         var sid = this.meta ? this.meta.id : null;
  61         var recordType = this.recordType, fields = recordType.prototype.fields;
  62         var records = [];
  63         var root = o;
  64             for(var i = 0; i < root.length; i++){
  65                     var n = root[i];
  66                 var values = {};
  67                 var id = ((sid || sid === 0) && n[sid] !== undefined && n[sid] !== "" ? n[sid] : null);
  68                 for(var j = 0, jlen = fields.length; j < jlen; j++){
  69                 var f = fields.items[j];
  70                 var k = f.mapping !== undefined && f.mapping !== null ? f.mapping : j;
  71                 var v = n[k] !== undefined ? n[k] : f.defaultValue;
  72                 v = f.convert(v);
  73                 values[f.name] = v;
  74             }
  75                 var record = new recordType(values, id);
  76                 record.json = n;
  77                 records[records.length] = record;
  78             }
  79             return {
  80                 records : records,
  81                 totalRecords : records.length
  82             };
  83     }
  84 });