dojox/data/KeyValueStore.js

• Provides:

  • dojox.data.KeyValueStore

• Requires:

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

• dojox.data.KeyValueStore

  • type

    Function

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

      dataVar: jsonObject}

  • summary

    This is a dojo.data store implementation.  It can take in either a Javascript
    array, JSON string, or URL as the data source.  Data is expected to be in the
    following format:
    [
    { "key1": "value1" },
    { "key2": "value2" }
    ]
    This is to mimic the Java Properties file format.  Each 'item' from this store
    is a JS object representing a key-value pair.  If an item in the above array has
    more than one key/value pair, only the first will be used/accessed.

• dojox.data.KeyValueStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • keywordParameters: (typeof Object)

      dataVar: jsonObject}

  • summary

    constructor

• dojox.data.KeyValueStore.url

  • type

    String

• dojox.data.KeyValueStore.data

  • type

    String

• dojox.data.KeyValueStore.urlPreventCache

  • type

    boolean

  • summary

    Controls if urlPreventCache should be used with underlying xhrGet.

• dojox.data.KeyValueStore._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.KeyValueStore._assertIsAttribute

  • parameters:
    • item: (typeof item)
    • attribute: (typeof 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.KeyValueStore.getValue

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

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

  • type

    Function

• dojox.data.KeyValueStore.getValues

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

    Array

  • summary

    See dojo.data.api.Read.getValues()
    Key/Value syntax does not support multi-valued attributes, so this is just a
    wrapper function for getValue().

  • type

    Function

• dojox.data.KeyValueStore.getAttributes

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

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

  • type

    Function

• dojox.data.KeyValueStore.hasAttribute

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

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

  • type

    Function

• dojox.data.KeyValueStore.containsValue

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

    boolean.

  • summary

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

  • type

    Function

• dojox.data.KeyValueStore._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.KeyValueStore.isItem

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

    Boolean

  • summary

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

  • type

    Function

• dojox.data.KeyValueStore.isItemLoaded

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

    Boolean

  • summary

    See dojo.data.api.Read.isItemLoaded()
    The KeyValueStore always loads all items, so if it's an item, then it's loaded.

  • type

    Function

• dojox.data.KeyValueStore.loadItem

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

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

  • description

    The KeyValueStore 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.KeyValueStore.getFeatures

  • returns

    Object

  • summary

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

  • type

    Function

• dojox.data.KeyValueStore.close

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

      || keywordArgs || null

  • summary

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

  • type

    Function

• dojox.data.KeyValueStore.getLabel

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

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

  • type

    Function

• dojox.data.KeyValueStore.getLabelAttributes

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

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

  • type

    Function

• dojox.data.KeyValueStore._fetchItems

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

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

  • type

    Function

• dojox.data.KeyValueStore._loadInProgress

  • type

    bool

• dojox.data.KeyValueStore._keyValueString

  • type

    Object

• dojox.data.KeyValueStore._keyValueVar

  • type

    Object

• dojox.data.KeyValueStore._handleQueuedFetches

  • summary

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

  • type

    Function

• dojox.data.KeyValueStore._queuedFetches

  • type

    Array

• dojox.data.KeyValueStore._processData

  • parameters:
    • data: (typeof Array)
  • type

    Function

• dojox.data.KeyValueStore._arrayOfAllItems

  • type

    Array

• dojox.data.KeyValueStore._loadFinished

  • type

    Object

• dojox.data.KeyValueStore._createItem

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

    Object

  • type

    Function

• dojox.data.KeyValueStore.getIdentity

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

    String|null

  • summary

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

  • type

    Function

• dojox.data.KeyValueStore.getIdentityAttributes

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

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

  • type

    Function

• dojox.data.KeyValueStore.fetchItemByIdentity

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

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

  • type

    Function

• dojox.data.KeyValueStore._finishFetchItemByIdentity

  • parameters:
    • items: (typeof Array)
    • request: (typeof object)
  • type

    Function

• dojox.data.KeyValueStore._keyAttribute

  • type

    String

• dojox.data.KeyValueStore._valueAttribute

  • type

    String

• dojox.data.KeyValueStore._storeProp

  • type

    String

• dojox.data.KeyValueStore._features

  • type

    Object

• dojox.data

  • type

    Object

• dojox

  • type

    Object