dojo/data/ItemFileReadStore.js

• Provides:

  • dojo.data.ItemFileReadStore

• Requires:

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

• dojo.data.ItemFileReadStore

  • type

    Function

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

      typeMap: object)
      The structure of the typeMap object is as follows:
      {
      type0: function || object,
      type1: function || object,
      ...
      typeN: function || object
      }
      Where if it is a function, it is assumed to be an object constructor that takes the
      value of _value as the initialization parameters.  If it is an object, then it is assumed
      to be an object of general form:
      {
      type: function, //constructor.
      deserialize:	function(value) //The function that parses the value and constructs the object defined by type appropriately.
      }

  • summary

    The ItemFileReadStore implements the dojo.data.api.Read API and reads
    data from JSON files that have contents in this format --
    { items: [
    { name:'Kermit', color:'green', age:12, friends:['Gonzo', {_reference:{name:'Fozzie Bear'}}]},
    { name:'Fozzie Bear', wears:['hat', 'tie']},
    { name:'Miss Piggy', pets:'Foo-Foo'}
    ]}
    Note that it can also contain an 'identifer' property that specified which attribute on the items
    in the array of items that acts as the unique identifier for that item.
    
    
    
    use "" rather than undefined for the benefit of the parser (#3539)

• dojo.data.ItemFileReadStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • keywordParameters: (typeof Object)

      typeMap: object)
      The structure of the typeMap object is as follows:
      {
      type0: function || object,
      type1: function || object,
      ...
      typeN: function || object
      }
      Where if it is a function, it is assumed to be an object constructor that takes the
      value of _value as the initialization parameters.  If it is an object, then it is assumed
      to be an object of general form:
      {
      type: function, //constructor.
      deserialize:	function(value) //The function that parses the value and constructs the object defined by type appropriately.
      }

  • summary

    constructor

• dojo.data.ItemFileReadStore.url

  • type

    String

• dojo.data.ItemFileReadStore._ccUrl

  • type

    String

• dojo.data.ItemFileReadStore.data

  • type

    Object

• dojo.data.ItemFileReadStore.typeMap

  • type

    Object

• dojo.data.ItemFileReadStore.clearOnClose

  • type

    Object

• dojo.data.ItemFileReadStore.urlPreventCache

  • type

    bool

• dojo.data.ItemFileReadStore.failOk

  • type

    bool

• dojo.data.ItemFileReadStore.hierarchical

  • type

    Object

• dojo.data.ItemFileReadStore._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

• dojo.data.ItemFileReadStore._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

• dojo.data.ItemFileReadStore.getValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • defaultValue: (typeof value)
  • returns

    mixed

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.getValues

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

    Array

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.getAttributes

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

    Array

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.hasAttribute

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

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

  • type

    Function

• dojo.data.ItemFileReadStore.containsValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • value: (typeof anything)
  • returns

    boolean.

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore._containsValue

  • parameters:
    • item: (typeof item)

      The data item to examine for attribute values.

    • attribute: (typeof attribute-name-string)

      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

• dojo.data.ItemFileReadStore.isItem

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

    Boolean

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.isItemLoaded

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

    boolean

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.loadItem

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

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

  • type

    Function

• dojo.data.ItemFileReadStore.getFeatures

  • returns

    Object

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.getLabel

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

    String|undefined

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.getLabelAttributes

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

    array|null

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore._fetchItems

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

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

  • type

    Function

• dojo.data.ItemFileReadStore._jsonFileUrl

• dojo.data.ItemFileReadStore._jsonData

  • type

    Object

• dojo.data.ItemFileReadStore._loadInProgress

  • type

    bool

• dojo.data.ItemFileReadStore._loadFinished

  • type

    bool

• dojo.data.ItemFileReadStore._handleQueuedFetches

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore._queuedFetches

  • type

    Array

• dojo.data.ItemFileReadStore._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

• dojo.data.ItemFileReadStore.close

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

      || keywordArgs || null

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore._arrayOfAllItems

  • type

    Array

• dojo.data.ItemFileReadStore._arrayOfTopLevelItems

  • type

    Array

• dojo.data.ItemFileReadStore._itemsByIdentity

  • type

    Object

• dojo.data.ItemFileReadStore._getItemsFromLoadedData

  • parameters:
    • dataObject: (typeof Object)

      The JS data object containing the raw data to convery into item format.

  • summary

    Function to parse the loaded data into item format and build the internal items array.

  • description

    Function to parse the loaded data into item format and build the internal items array.

  • return_summary

    array
    Array of items in store item format.

  • type

    Function

• dojo.data.ItemFileReadStore._labelAttr

• dojo.data.ItemFileReadStore._features.dojo.data.api.Identity

• dojo.data.ItemFileReadStore._addReferenceToMap

  • parameters:
    • refItem: (typeof item)

      The item that is referenced.

    • parentItem: (typeof item)

      The item that holds the new reference to refItem.

    • attribute: (typeof string)

      The attribute on parentItem that contains the new reference.

  • summary

    Method to add an reference map entry for an item and attribute.

  • description

    Method to add an reference map entry for an item and attribute. 		 //

  • type

    Function

• dojo.data.ItemFileReadStore.getIdentity

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

    Number|Object||String|null

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore.fetchItemByIdentity

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

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

  • type

    Function

• dojo.data.ItemFileReadStore._getItemByIdentity

  • parameters:
    • identity: (typeof Object)
  • returns

    Object

  • summary

    Internal function to look an item up by its identity map.

  • type

    Function

• dojo.data.ItemFileReadStore.getIdentityAttributes

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

    null|Array

  • summary

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

  • type

    Function

• dojo.data.ItemFileReadStore._forceLoad

  • summary

    Internal function to force a load of the store if it hasn't occurred yet.  This is required
    for specific functions to work properly.

  • type

    Function

• dojo.data.ItemFileReadStore._datatypeMap

  • type

    Object

• dojo.data.ItemFileReadStore._datatypeMap.Date

  • type

    Object

• dojo.data.ItemFileReadStore._features

  • type

    Object

• dojo.data.ItemFileReadStore._storeRefPropName

  • type

    String

• dojo.data.ItemFileReadStore._itemNumPropName

  • type

    String

• dojo.data.ItemFileReadStore._rootItemPropName

  • type

    String

• dojo.data.ItemFileReadStore._reverseRefMap

  • type

    String

• dojo.data

  • type

    Object

• dojo

  • type

    Object