dojox/data/OpmlStore.js

• Provides:

  • dojox.data.OpmlStore

• Requires:

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

• dojox.data.OpmlStore

  • type

    Function

  • chains:
    • dojo.data.util.simpleFetch: (prototype)
  • parameters:
    • keywordParameters: (typeof Object)

      url: String, label: String}  Where label is optional and configures what should be used as the return from getLabel()

  • summary

    *   The OpmlStore implements the dojo.data.api.Read API.

• dojox.data.OpmlStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • keywordParameters: (typeof Object)

      url: String, label: String}  Where label is optional and configures what should be used as the return from getLabel()

  • summary

    constructor

• dojox.data.OpmlStore.label

  • tags: public
  • type

    string

  • summary

    The attribute of the Opml item to act as a label.

• dojox.data.OpmlStore.url

  • tags: public
  • type

    string

  • summary

    The location from which to fetch the Opml document.

• dojox.data.OpmlStore.urlPreventCache

  • tags: public
  • type

    boolean

  • summary

    Flag to denote if the underlying xhrGet call should set preventCache.

• dojox.data.OpmlStore._assertIsItem

  • parameters:
    • item: (typeof item)
  • type

    Function

• dojox.data.OpmlStore._assertIsAttribute

  • parameters:
    • attribute: (typeof item)

      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.OpmlStore._removeChildNodesThatAreNotElementNodes

  • parameters:
    • node: (typeof node)
    • recursive: (typeof boolean)
  • type

    Function

• dojox.data.OpmlStore._processRawXmlTree

  • parameters:
    • rawXmlTree: (typeof xmlDoc)
  • type

    Function

• dojox.data.OpmlStore._loadFinished

  • type

    bool

• dojox.data.OpmlStore._xmlData

  • type

    Object

• dojox.data.OpmlStore._metadataNodes

  • type

    Object

• dojox.data.OpmlStore._checkChildNodes

  • parameters:
    • node: (typeof Node)

      The child node to walk.

  • summary

    Internal function to recurse over all child nodes from the store and add them
    As non-toplevel items

  • description

    Internal function to recurse over all child nodes from the store and add them
    As non-toplevel items

  • type

    Function

• dojox.data.OpmlStore._getItemsArray

  • parameters:
    • queryOptions: (typeof object)

      The query options parameter, if any.

  • summary

    Internal function to determine which list of items to search over.

  • type

    Function

• dojox.data.OpmlStore.getValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute)

      || attribute-name-string

    • defaultValue: (typeof value)
  • returns

    Object

  • summary

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

  • type

    Function

• dojox.data.OpmlStore.getValues

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute)

      || attribute-name-string

  • returns

    Array

  • summary

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

  • type

    Function

• dojox.data.OpmlStore.getAttributes

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

    Array

  • summary

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

  • type

    Function

• dojox.data.OpmlStore.hasAttribute

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute)

      || attribute-name-string

  • returns

    Boolean

  • summary

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

  • type

    Function

• dojox.data.OpmlStore.containsValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute)

      || attribute-name-string

    • value: (typeof anything)
  • returns

    boolean.

  • summary

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

  • type

    Function

• dojox.data.OpmlStore._containsValue

  • parameters:
    • item: (typeof item)

      The data item to examine for attribute values.

    • attribute: (typeof attribute)

      The attribute to inspect.

    • value: (typeof anything)

      The value to match.

    • regexp: (typeof RegExp)

      Optional regular expression generated off value if value was of string type to handle wildcarding.
      If present and attribute values are string, then it can be used for comparison instead of 'value'

  • returns

    Boolean

  • summary

    Internal function for looking at the values contained by the item.

  • description

    Internal function for looking at the values contained by the item.  This
    function allows for denoting if the comparison should be case sensitive for
    strings or not (for handling filtering cases where string case should not matter)

  • type

    Function

• dojox.data.OpmlStore.isItem

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

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

  • description

    Four things are verified to ensure that "something" is an item:
    something can not be null, the nodeType must be an XML Element,
    the tagName must be "outline", and the node must be a member of
    XML document for this datastore.

  • type

    Function

• dojox.data.OpmlStore.isItemLoaded

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

    Boolean

  • summary

    See dojo.data.api.Read.isItemLoaded()
    OpmlStore loads every item, so if it's an item, then it's loaded.

  • type

    Function

• dojox.data.OpmlStore.loadItem

  • parameters:
    • item: (typeof item)
  • summary

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

  • description

    The OpmlStore always loads all items, so if it's an item, then it's loaded.
    From the dojo.data.api.Read.loadItem docs:
    If a call to isItemLoaded() returns true before loadItem() is even called,
    then loadItem() need not do any work at all and will not even invoke the callback handlers.

  • type

    Function

• dojox.data.OpmlStore.getLabel

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

    String|undefined

  • summary

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

  • type

    Function

• dojox.data.OpmlStore.getLabelAttributes

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

    array

  • summary

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

  • type

    Function

• dojox.data.OpmlStore._fetchItems

  • parameters:
    • keywordArgs: (typeof Object)
    • findCallback: (typeof Function)
    • errorCallback: (typeof Function)
  • summary

    See dojo.data.util.simpleFetch.fetch()

  • type

    Function

• dojox.data.OpmlStore._loadInProgress

  • type

    bool

• dojox.data.OpmlStore._opmlData

  • type

    Object

• dojox.data.OpmlStore.getFeatures

  • returns

    Object

  • summary

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

  • type

    Function

• dojox.data.OpmlStore.getIdentity

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

    null

  • summary

    See dojo.data.api.Identity.getIdentity()

  • type

    Function

• dojox.data.OpmlStore.fetchItemByIdentity

  • parameters:
    • keywordArgs: (typeof Object)
  • summary

    See dojo.data.api.Identity.fetchItemByIdentity()

  • type

    Function

• dojox.data.OpmlStore.getIdentityAttributes

  • parameters:
    • item: (typeof item)
  • summary

    See dojo.data.api.Identity.getIdentifierAttributes()

  • type

    Function

• dojox.data.OpmlStore._handleQueuedFetches

  • summary

    Internal function to execute delayed request in the store.
    Execute any deferred fetches now.

  • type

    Function

• dojox.data.OpmlStore._queuedFetches

  • type

    Array

• dojox.data.OpmlStore.close

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

      || keywordArgs || null

  • summary

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

  • type

    Function

• dojox.data.OpmlStore._arrayOfTopLevelItems

  • type

    Array

• dojox.data.OpmlStore._arrayOfAllItems

  • type

    Array

• dojox.data.OpmlStore._identityMap

  • type

    Object

• dojox.data.OpmlStore._identCount

  • type

    Number

• dojox.data.OpmlStore._idProp

  • type

    String

• dojox.data

  • type

    Object

• dojox

  • type

    Object