Properties Methods Events Config Options Direct Link
DataReader
  XmlReader

Class Ext.data.XmlReader

Package:Ext.data
Defined In:XmlReader.js
Class:XmlReader
Extends:DataReader

Data reader class to create an Array of Ext.data.Record objects from an XML document based on mappings in a provided Ext.data.Record constructor.

Note: that in order for the browser to parse a returned XML document, the Content-Type header in the HTTP response must be set to "text/xml" or "application/xml".

Example code:

var Employee = Ext.data.Record.create([
   {name: 'name', mapping: 'name'},     // "mapping" property not needed if it is the same as "name"
   {name: 'occupation'}                 // This field will use "occupation" as the mapping.
]);
var myReader = new Ext.data.XmlReader({
   totalRecords: "results", // The element which contains the total dataset size (optional)
   record: "row",           // The repeated element which contains row information
   id: "id"                 // The element within the row that provides an ID for the record (optional)
}, Employee);

This would consume an XML file like this:

<?xml version="1.0" encoding="UTF-8"?>
<dataset>
 <results>2</results>
 <row>
   <id>1</id>
   <name>Bill</name>
   <occupation>Gardener</occupation>
 </row>
 <row>
   <id>2</id>
   <name>Ben</name>
   <occupation>Horticulturalist</occupation>
 </row>
</dataset>

Config Options

Config OptionsDefined By
 idPath : String
The DomQuery path relative from the record element to the element that contains a record identifier value.
XmlReader
 record : String
The DomQuery path to the repeated element which contains record information.
XmlReader
 success : String
The DomQuery path to the success attribute used by forms.
XmlReader

Public Properties

PropertyDefined By
 buildExtractors : Object
Abstract method, overridden in Ext.data.JsonReader
DataReader
 meta : Mixed
This DataReader's configured metadata as passed to the constructor.
DataReader
 xmlData : XMLDocument
After any data loads/reads, the raw XML Document is available for further custom processing.
XmlReader

Public Methods

MethodDefined By

Public Events

This class has no public events.