Properties Methods Events Config Options Direct Link
Observable
  Store
    XmlStore

Class CQ.Ext.data.XmlStore

Package:CQ.Ext.data
Class:XmlStore
Extends:CQ.Ext.data.Store
Clientlib:cq.widgets
xtype:xmlstore

Small helper class to make creating CQ.Ext.data.Stores from XML data easier. A XmlStore will be automatically configured with a CQ.Ext.data.XmlReader.

A store configuration would be something like:

var store = new CQ.Ext.data.XmlStore({
    // store configs
    autoDestroy: true,
    storeId: 'myStore',
    url: 'sheldon.xml', // automatically configures a HttpProxy
    // reader configs
    record: 'Item', // records will have an "Item" tag
    idPath: 'ASIN',
    totalRecords: '@TotalResults'
    fields: [
        // set up the fields mapping into the xml doc
        // The first needs mapping, the others are very basic
        {name: 'Author', mapping: 'ItemAttributes > Author'},
        'Title', 'Manufacturer', 'ProductGroup'
    ]
});

This store is configured to consume a returned object of the form:

<?xml version="1.0" encoding="UTF-8"?>
<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
    <Items>
        <Request>
            <IsValid>True</IsValid>
            <ItemSearchRequest>
                <Author>Sidney Sheldon</Author>
                <SearchIndex>Books</SearchIndex>
            </ItemSearchRequest>
        </Request>
        <TotalResults>203</TotalResults>
        <TotalPages>21</TotalPages>
        <Item>
            <ASIN>0446355453</ASIN>
            <DetailPageURL>
                http://www.amazon.com/
            </DetailPageURL>
            <ItemAttributes>
                <Author>Sidney Sheldon</Author>
                <Manufacturer>Warner Books</Manufacturer>
                <ProductGroup>Book</ProductGroup>
                <Title>Master of the Game</Title>
            </ItemAttributes>
        </Item>
    </Items>
</ItemSearchResponse>
An object literal of this form could also be used as the data config option.

Note: Although not listed here, this class accepts all of the configuration options of XmlReader.

Config Options

Config Options Defined By

Public Properties

Property Defined By
  baseParams : Object
See the corresponding configuration option for a description of this property. To modify this property see setBaseParam.
Store
  fields : CQ.Ext.util.MixedCollection
A MixedCollection containing the defined Fields for the Records stored in this Store. Read-only.
Store
  isDestroyed : Boolean True
Store
  multiSort : Boolean True
Store
  multiSortInfo : Object
Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields
Store

Public Methods

Method Defined By

Public Events

Event Defined By