PropertiesClass CQ.Ext.data.DataReader
| Package: | CQ.Ext.data |
| Class: | DataReader |
| Subclasses: | JsonReader, XmlReader |
| Extends: | Object |
| Clientlib: | cq.widgets |
Abstract base class for reading structured data from a data source and converting
it into an object containing CQ.Ext.data.Record objects and metadata for use
by an CQ.Ext.data.Store. This class is intended to be extended and should not
be created directly. For existing implementations, see CQ.Ext.data.ArrayReader,
CQ.Ext.data.JsonReader and CQ.Ext.data.XmlReader.
Config Options
| Config Options | Defined By | |
|---|---|---|
|
fields : Array/Object Either an Array of Field definition objects (which will be passed to CQ.Ext.data.Record.create, or a Record construct...
Either an Array of Field definition objects (which will be passed to CQ.Ext.data.Record.create, or a Record constructor created from CQ.Ext.data.Record.create. |
DataReader | |
|
messageProperty : String
[undefined] Optional name of a property within a server-response that represents a user-feedback message.
|
DataReader | |
Public Properties
| Property | Defined By | |
|---|---|---|
|
buildExtractors : Object
Abstract method, overridden in DataReader extensions such as CQ.Ext.data.JsonReader and CQ.Ext.data.XmlReader
|
DataReader | |
|
extractValues : Object
Abstract method overridden in DataReader extensions such as CQ.Ext.data.JsonReader and CQ.Ext.data.XmlReader
|
DataReader | |
|
getId : Object
Abstract method created in extension's buildExtractors impl.
|
DataReader | |
|
getMessage : Object
Abstract method created in extension's buildExtractors impl.
|
DataReader | |
|
getRoot : Object
Abstract method created in extension's buildExtractors impl.
|
DataReader | |
|
getSuccess : Object
Abstract method created in extension's buildExtractors impl.
|
DataReader | |
|
getTotal : Object
Abstract method created in extension's buildExtractors impl.
|
DataReader | |
|
meta : Mixed
This DataReader's configured metadata as passed to the constructor.
|
DataReader | |
Public Methods
| Method | Defined By | |
|---|---|---|
DataReader( Object meta, Array/Object recordType
) Create a new DataReader
Create a new DataReader
Parameters:
|
DataReader | |
isData( Object data ) : 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.
Parameters:
|
DataReader | |
realize( Record/Record[] record, Object/Object[] data ) : void Used 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.
Parameters:
|
DataReader | |
update( Record/Record[] rs, Object/Object[] data ) : 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:
|
DataReader | |
Public Events
This class has no public events.