Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / DataReader.html
index 9eba66c..9d2ada3 100644 (file)
@@ -1,11 +1,17 @@
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.data.DataReader"></div>/**\r
+<html>
+<head>
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.data.DataReader"></div>/**\r
  * @class Ext.data.DataReader\r
  * Abstract base class for reading structured data from a data source and converting\r
  * it into an object containing {@link Ext.data.Record} objects and metadata for use\r
@@ -34,17 +40,49 @@ Ext.data.DataReader = function(meta, recordType){
      */\r
     this.recordType = Ext.isArray(recordType) ?\r
         Ext.data.Record.create(recordType) : recordType;\r
-\r
-    // make sure extraction functions are defined.\r
-    this.buildExtractors();\r
+
+    // if recordType defined make sure extraction functions are defined\r
+    if (this.recordType){\r
+        this.buildExtractors();\r
+    }
 };\r
 \r
 Ext.data.DataReader.prototype = {\r
-\r
+    <div id="cfg-Ext.data.DataReader-messageProperty"></div>/**\r
+     * @cfg {String} messageProperty [undefined] Optional name of a property within a server-response that represents a user-feedback message.\r
+     */\r
+    <div id="prop-Ext.data.DataReader-getTotal"></div>/**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getTotal: Ext.emptyFn,\r
+    <div id="prop-Ext.data.DataReader-getRoot"></div>/**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getRoot: Ext.emptyFn,\r
+    <div id="prop-Ext.data.DataReader-getMessage"></div>/**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getMessage: Ext.emptyFn,\r
+    <div id="prop-Ext.data.DataReader-getSuccess"></div>/**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getSuccess: Ext.emptyFn,\r
+    <div id="prop-Ext.data.DataReader-getId"></div>/**\r
+     * Abstract method created in extension's buildExtractors impl.\r
+     */\r
+    getId: Ext.emptyFn,\r
     <div id="prop-Ext.data.DataReader-buildExtractors"></div>/**\r
-     * Abstract method, overridden in {@link Ext.data.JsonReader}\r
+     * Abstract method, overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}\r
      */\r
     buildExtractors : Ext.emptyFn,\r
+    <div id="prop-Ext.data.DataReader-extractData"></div>/**\r
+     * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}\r
+     */\r
+    extractData : Ext.emptyFn,\r
+    <div id="prop-Ext.data.DataReader-extractValues"></div>/**\r
+     * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}\r
+     */\r
+    extractValues : Ext.emptyFn,\r
 \r
     <div id="method-Ext.data.DataReader-realize"></div>/**\r
      * Used for un-phantoming a record after a successful database insert.  Sets the records pk along with new data from server.\r
@@ -79,11 +117,10 @@ Ext.data.DataReader.prototype = {
                 //rs.commit();\r
                 throw new Ext.data.DataReader.Error('realize', rs);\r
             }\r
-            var values = this.extractValues(data, rs.fields.items, rs.fields.items.length);\r
             rs.phantom = false; // <-- That's what it's all about\r
             rs._phid = rs.id;  // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords\r
-            rs.id = data[this.meta.idProperty];\r
-            rs.data = values;\r
+            rs.id = this.getId(data);\r
+            rs.data = data;\r
             rs.commit();\r
         }\r
     },\r
@@ -115,7 +152,7 @@ Ext.data.DataReader.prototype = {
                 data = data.shift();\r
             }\r
             if (this.isData(data)) {\r
-                rs.data = this.extractValues(Ext.apply(rs.data, data), rs.fields.items, rs.fields.items.length);\r
+                rs.data = Ext.apply(rs.data, data);\r
             }\r
             rs.commit();\r
         }\r
@@ -128,7 +165,15 @@ Ext.data.DataReader.prototype = {
      * @return {Boolean}\r
      */\r
     isData : function(data) {\r
-        return (data && Ext.isObject(data) && !Ext.isEmpty(data[this.meta.idProperty])) ? true : false;\r
+        return (data && Ext.isObject(data) && !Ext.isEmpty(this.getId(data))) ? true : false;\r
+    },\r
+\r
+    // private function a store will createSequence upon\r
+    onMetaChange : function(meta){\r
+        delete this.ef;\r
+        this.meta = meta;\r
+        this.recordType = Ext.data.Record.create(meta.fields);\r
+        this.buildExtractors();\r
     }\r
 };\r
 \r
@@ -153,6 +198,40 @@ Ext.apply(Ext.data.DataReader.Error.prototype, {
 });\r
 \r
 \r
-</pre>    \r
-</body>\r
+<div id="method-Ext.data.DataReader.Error-Response"></div>/**\r
+ * Ext.data.Response\r
+ * A generic response class to normalize response-handling internally to the framework.\r
+ * TODO move to own file, add to jsb.\r
+ */\r
+Ext.data.Response = function(params) {\r
+    Ext.apply(this, params);\r
+};\r
+Ext.data.Response.prototype = {\r
+    <div id="prop-Ext.data.DataReader.Error-{String}"></div>/**\r
+     * @property {String} action {@link Ext.data.Api#actions}\r
+     */\r
+    action: undefined,\r
+    <div id="prop-Ext.data.DataReader.Error-{Boolean}"></div>/**\r
+     * @property {Boolean} success\r
+     */\r
+    success : undefined,\r
+    <div id="prop-Ext.data.DataReader.Error-{String}"></div>/**\r
+     * @property {String} message\r
+     */\r
+    message : undefined,\r
+    <div id="prop-Ext.data.DataReader.Error-{Array/Object}"></div>/**\r
+     * @property {Array/Object} data\r
+     */\r
+    data: undefined,\r
+    <div id="prop-Ext.data.DataReader.Error-{Object}"></div>/**\r
+     * @property {Object} raw The raw response returned from server-code\r
+     */\r
+    raw: undefined,\r
+    <div id="prop-Ext.data.DataReader.Error-{Ext.data.Record/Ext.data.Record[]}"></div>/**\r
+     * @property {Ext.data.Record/Ext.data.Record[]} record(s) related to the Request action\r
+     */\r
+    records: undefined\r
+}\r
+</pre>
+</body>
 </html>
\ No newline at end of file