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".
@@ -8,9 +9,10 @@ header in the HTTP response must be set to "text/xml" or "application/xml".
{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)
+ totalProperty:
"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)
+ idProperty:
"id" // The element within the row that provides an ID for the record (optional)
+ messageProperty:
"msg" // The element within the response that provides a user-feedback message (optional)
}, Employee);
This would consume an XML file like this:
@@ -27,20 +29,20 @@ This would consume an XML file like this:
<name>Ben</name>
<occupation>Horticulturalist</occupation>
</row>
-</dataset>
Config Options
|
| fields : Array/ObjectEither an Array of Field definition objects (which
-will be passed to Ext.data.Record.create, or a Record
-constructo... Config Options|
| fields : Array/ObjectEither an Array of Field definition objects (which
+will be passed to Ext.data.Record.create, or a Record
+constructor ... | DataReader | | 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 | | totalRecords : StringThe DomQuery path from which to retrieve the total number of records
+a record identifier value. | XmlReader | | messageProperty : String [undefined] Optional name of a property within a server-response that represents a user-feedback message. | DataReader | | record : String The DomQuery path to the repeated element which contains record information. | XmlReader | | record : String The DomQuery path to the repeated element which contains record information. | XmlReader | | successProperty : String The DomQuery path to the success attribute used by forms. | XmlReader | | totalProperty : StringThe DomQuery path from which to retrieve the total number of records
in the dataset. This is only needed if the whole... The DomQuery path from which to retrieve the total number of records
in the dataset. This is only needed if the whole dataset is not passed in one go, but is being
-paged from the remote server. | XmlReader |
Public Properties|
| buildExtractors : Object | 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|
| XmlReader( Object meta , Object recordType )
+paged from the remote server. | XmlReader |
Public PropertiesPublic Methods|
| XmlReader( Object meta , Object recordType )
| XmlReader | | isData( Object data )
:
- BooleanReturns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key
-corresponding to i... Returns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key
+ Boolean Returns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key
+corresponding to id... Returns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key
corresponding to idProperty defined in your DataReader config containing non-empty pk. | DataReader | | read( Object response )
:
ObjectThis method is only used by a DataProxy which has retrieved data from a remote server. This method is only used by a DataProxy which has retrieved data from a remote server. Parameters:response : ObjectThe XHR object which contains the parsed XML document. The response is expected
@@ -48,16 +50,18 @@ to contain a property called responseXML which refers to an XML documen
a cache of Ext.data.Records.
| XmlReader | | readRecords( Object doc )
:
ObjectCreate a data block containing Ext.data.Records from an XML document. Create a data block containing Ext.data.Records from an XML document. Parameters:doc : ObjectA parsed XML document. Returns: | XmlReader | | realize( Record/Record[] record , Object/Object[] data )
+a cache of Ext.data.Records. | XmlReader | | readResponse( String action , Object response )
:
- voidUsed for un-phantoming a record after a successful database insert. Sets the records pk along with new data from ser... Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server.
-You must return at least the database pk using the idProperty defined in your DataReader configuration. The incoming
-data from server will be merged with the data in the local record.
-In addition, you must return record-data from the server in the same order received.
+ Ext.data.Response Decode an XML response from server. Decode an XML response from server. | XmlReader | | realize( Record/Record[] record , Object/Object[] data )
+ :
+ voidUsed for un-phantoming a record after a successful database insert. Sets the records pk along with new data from ser... Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server.
+You must return at least the database pk using the idProperty defined in your DataReader configuration. The incoming
+data from server will be merged with the data in the local record.
+In addition, you must return record-data from the server in the same order received.
Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed. | DataReader | | update( Record/Record[] rs , Object/Object[] data )
:
- voidUsed for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
-If returning ... Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
-If returning data from multiple-records after a batch-update, you must return record-data from the server in
-the same order received. Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be
+ void Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
+If returning d... Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
+If returning data from multiple-records after a batch-update, you must return record-data from the server in
+the same order received. Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be
suppressed as the record receives fresh new data-hash Parameters:rs : Record/Record[]data : Object/Object[] Returns: | DataReader |
Public EventsThis class has no public events.
\ No newline at end of file
|