dojox/data/AtomReadStore.js

• Provides:

  • dojox.data.AtomReadStore

• Requires:

  • dojo.data.util.filter in common
  • dojo.data.util.simpleFetch in common
  • dojo.date.stamp in common

• dojox.data.AtomReadStore

  • type

    Function

  • chains:
    • dojo.data.util.simpleFetch: (prototype)
  • parameters:
    • args: (typeof object)

      An anonymous object to initialize properties.	It expects the following values:

  • summary

    A read only data store for Atom XML based services or documents

  • description

    A data store for Atom XML based services or documents.	This store is still under development
    and doesn't support wildcard filtering yet.	Attribute filtering is limited to category or id.

• dojox.data.AtomReadStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof object)

      An anonymous object to initialize properties.	It expects the following values:

  • summary

    Constructor for the AtomRead store.

• dojox.data.AtomReadStore.url

  • type

    The

  • summary

    url to a service or an XML document that represents the store

• dojox.data.AtomReadStore.label

  • type

    Object

• dojox.data.AtomReadStore.sendQuery

  • type

    A

  • summary

    boolean indicate to add a query string to the service URL

• dojox.data.AtomReadStore.unescapeHTML

  • type

    A

  • summary

    boolean to specify whether or not to unescape HTML text

• dojox.data.AtomReadStore.urlPreventCache

  • type

    bool

• dojox.data.AtomReadStore.getValue

  • parameters:
    • item: (typeof item)

      An item returned by a call to the 'fetch' method.

    • attribute: (typeof attribute)

      A attribute of the Atom Entry

    • defaultValue: (typeof value)

      A default value

  • summary

    Return an attribute value

  • description

    'item' must be an instance of an object created by the AtomReadStore instance.
    Accepted attributes are id, subtitle, title, summary, content, author, updated,
    published, category, link and alternate

  • return_summary

    An attribute value found, otherwise 'defaultValue'

  • type

    Function

• dojox.data.AtomReadStore.getValues

  • parameters:
    • item: (typeof item)

      An item returned by a call to the 'fetch' method.

    • attribute: (typeof attribute)

      A attribute of the Atom Entry

  • summary

    Return an attribute value

  • description

    'item' must be an instance of an object created by the AtomReadStore instance.
    Accepted attributes are id, subtitle, title, summary, content, author, updated,
    published, category, link and alternate

  • return_summary

    An array of values for the attribute value found, otherwise 'defaultValue'

  • type

    Function

• dojox.data.AtomReadStore.getAttributes

  • parameters:
    • item: (typeof item)

      An XML element

  • returns

    array

  • summary

    Return an array of attribute names

  • description

    'item' must be have been created by the AtomReadStore instance.
    tag names of child elements and XML attribute names of attributes
    specified to the element are returned along with special attribute
    names applicable to the element including "tagName", "childNodes"
    if the element has child elements, "text()" if the element has
    child text nodes, and attribute names in '_attributeMap' that match
    the tag name of the element.

  • return_summary

    An array of attributes found

  • type

    Function

• dojox.data.AtomReadStore.hasAttribute

  • parameters:
    • item: (typeof item)

      'item' must be created by the AtomReadStore instance.

    • attribute: (typeof attribute)

      An attribute of an Atom Entry item.

  • returns

    boolean

  • summary

    Check whether an element has the attribute

  • return_summary

    True if the element has the attribute, otherwise false

  • type

    Function

• dojox.data.AtomReadStore.containsValue

  • parameters:
    • item: (typeof item)

      'item' must be an instance of a dojox.data.XmlItem from the store instance.

    • attribute: (typeof attribute)

      A tag name of a child element, An XML attribute name or one of
      special names

    • value: (typeof anything)
  • returns

    boolean

  • summary

    Check whether the attribute values contain the value

  • return_summary

    True if the attribute values contain the value, otherwise false

  • type

    Function

• dojox.data.AtomReadStore.isItem

  • parameters:
    • something: (typeof anything)
  • returns

    boolean|boolran

  • summary

    Check whether the object is an item (XML element)
    item:
    An object to check

  • return_summary

    True if the object is an XML element, otherwise false

  • type

    Function

• dojox.data.AtomReadStore.isItemLoaded

  • parameters:
    • something: (typeof anything)
  • returns

    boolean

  • summary

    Check whether the object is an item (XML element) and loaded
    item:
    An object to check

  • return_summary

    True if the object is an XML element, otherwise false

  • type

    Function

• dojox.data.AtomReadStore.loadItem

  • parameters:
    • keywordArgs: (typeof object)

      containing the args for loadItem.	See dojo.data.api.Read.loadItem()

  • summary

    Load an item (XML element)

  • type

    Function

• dojox.data.AtomReadStore.getFeatures

  • returns

    array

  • summary

    Return supported data APIs

  • return_summary

    "dojo.data.api.Read" and "dojo.data.api.Write"

  • type

    Function

• dojox.data.AtomReadStore.getLabel

  • parameters:
    • item: (typeof item)
  • returns

    undefined

  • summary

    See dojo.data.api.Read.getLabel()

  • type

    Function

• dojox.data.AtomReadStore.getLabelAttributes

  • parameters:
    • item: (typeof item)
  • returns

    array|null

  • summary

    See dojo.data.api.Read.getLabelAttributes()

  • type

    Function

• dojox.data.AtomReadStore.getFeedValue

  • parameters:
    • attribute
    • defaultValue
  • summary

    Non-API method for retrieving values regarding the Atom feed,
    rather than the Atom entries.

  • type

    Function

• dojox.data.AtomReadStore.getFeedValues

  • parameters:
    • attribute
    • defaultValue
  • summary

    Non-API method for retrieving values regarding the Atom feed,
    rather than the Atom entries.

  • type

    Function

• dojox.data.AtomReadStore._feedMetaData

  • type

    Object

• dojox.data.AtomReadStore._initItem

  • parameters:
    • item
  • summary

    Initializes an item before it can be parsed.

  • type

    Function

• dojox.data.AtomReadStore._fetchItems

  • parameters:
    • request
    • fetchHandler
    • errorHandler
  • summary

    Retrieves the items from the Atom XML document.

  • type

    Function

• dojox.data.AtomReadStore._getFetchUrl

  • parameters:
    • request
  • type

    Function

• dojox.data.AtomReadStore._getItems

  • parameters:
    • document
    • request
  • summary

    Parses the document in a first pass

  • type

    Function

• dojox.data.AtomReadStore._items

• dojox.data.AtomReadStore.close

  • parameters:
    • request: (typeof dojo.data.api.Request)

      || keywordArgs || null

  • summary

    See dojo.data.api.Read.close()

  • type

    Function

• dojox.data.AtomReadStore._getItem

  • parameters:
    • element
  • type

    Function

• dojox.data.AtomReadStore._parseItem

  • parameters:
    • item
  • type

    Function

• dojox.data.AtomReadStore._unescapeHTML

  • parameters:
    • text
  • type

    Function

• dojox.data.AtomReadStore._assertIsItem

  • parameters:
    • item: (typeof item)

      The item to test for being contained by the store.

  • summary

    This function tests whether the item passed in is indeed an item in the store.

  • type

    Function

• dojox.data.AtomReadStore._assertIsAttribute

  • parameters:
    • attribute: (typeof attribute-name-string)

      The attribute to test for being contained by the store.

  • summary

    This function tests whether the item passed in is indeed a valid 'attribute' like type for the store.

  • type

    Function

• dojox.data.AtomReadStore.rewriteUrl

• dojox.data

  • type

    Object

• dojox

  • type

    Object