commit extjs-2.2.1
[extjs.git] / source / data / DataReader.js
1 /*\r
2  * Ext JS Library 2.2.1\r
3  * Copyright(c) 2006-2009, Ext JS, LLC.\r
4  * licensing@extjs.com\r
5  * \r
6  * http://extjs.com/license\r
7  */\r
8 \r
9 /**\r
10  * @class Ext.data.DataReader\r
11  * Abstract base class for reading structured data from a data source and converting\r
12  * it into an object containing {@link Ext.data.Record} objects and metadata for use\r
13  * by an {@link Ext.data.Store}.  This class is intended to be extended and should not\r
14  * be created directly. For existing implementations, see {@link Ext.data.ArrayReader},\r
15  * {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}.\r
16  * @constructor Create a new DataReader\r
17  * @param {Object} meta Metadata configuration options (implementation-specific)\r
18  * @param {Object} recordType Either an Array of field definition objects as specified\r
19  * in {@link Ext.data.Record#create}, or an {@link Ext.data.Record} object created\r
20  * using {@link Ext.data.Record#create}.\r
21  */\r
22 Ext.data.DataReader = function(meta, recordType){\r
23     /**\r
24      * This DataReader's configured metadata as passed to the constructor.\r
25      * @type Mixed\r
26      * @property meta\r
27      */\r
28     this.meta = meta;\r
29     this.recordType = Ext.isArray(recordType) ? \r
30         Ext.data.Record.create(recordType) : recordType;\r
31 };\r
32 \r
33 Ext.data.DataReader.prototype = {\r
34     \r
35 };