dojo/data/ItemFileWriteStore.js

• Provides:

  • dojo.data.ItemFileWriteStore

• Requires:

  • dojo.data.ItemFileReadStore in common

• dojo.data.ItemFileWriteStore

  • type

    Function

  • chains:
    • dojo.data.ItemFileReadStore: (prototype)
    • dojo.data.ItemFileReadStore: (call)
  • 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.  It is serialized assuming object.toString()
      serialization.  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.
      serialize:	function(object) //The function that converts the object back into the proper file format form.
      }

• dojo.data.ItemFileWriteStore.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.  It is serialized assuming object.toString()
      serialization.  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.
      serialize:	function(object) //The function that converts the object back into the proper file format form.
      }

• dojo.data.ItemFileWriteStore.referenceIntegrity

  • type

    bool

• dojo.data.ItemFileWriteStore._assert

  • parameters:
    • condition: (typeof boolean)
  • type

    Function

• dojo.data.ItemFileWriteStore._getIdentifierAttribute

  • type

    Function

• dojo.data.ItemFileWriteStore.newItem

  • parameters:
    • keywordArgs: (typeof Object)
    • parentInfo: (typeof Object)
  • returns

    item

  • summary

    See dojo.data.api.Write.newItem()

  • type

    Function

• dojo.data.ItemFileWriteStore._removeArrayElement

  • parameters:
    • array: (typeof Array)
    • element: (typeof anything)
  • type

    Function

• dojo.data.ItemFileWriteStore.deleteItem

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

    See dojo.data.api.Write.deleteItem()

  • type

    Function

• dojo.data.ItemFileWriteStore.setValue

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

      anything

  • returns

    boolean

  • summary

    See dojo.data.api.Write.set()

  • type

    Function

• dojo.data.ItemFileWriteStore.setValues

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

    boolean

  • summary

    See dojo.data.api.Write.setValues()

  • type

    Function

• dojo.data.ItemFileWriteStore.unsetAttribute

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

    See dojo.data.api.Write.unsetAttribute()

  • type

    Function

• dojo.data.ItemFileWriteStore._setValueOrValues

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • newValueOrValues: (typeof anything)
    • callOnSet: (typeof boolean)
  • returns

    boolean

  • type

    Function

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

  • parameters:
    • refItem: (typeof item)

      The item that is referenced.

    • parentItem: (typeof item)

      The item holding a reference to refItem.

    • attribute: (typeof strin)

      The attribute on parentItem that contains the reference.

  • summary

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

  • description

    Method to remove an reference map entry for an item and attribute.  This will
    also perform cleanup on the map such that if there are no more references at all to
    the item, its reference object and entry are removed.

  • type

    Function

• dojo.data.ItemFileWriteStore._dumpReferenceMap

  • summary

    Function to dump the reverse reference map of all items in the store for debug purposes.

  • description

    Function to dump the reverse reference map of all items in the store for debug purposes.

  • type

    Function

• dojo.data.ItemFileWriteStore._getValueOrValues

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

    Function

• dojo.data.ItemFileWriteStore._flatten

  • parameters:
    • value: (typeof anything)
  • type

    Function

• dojo.data.ItemFileWriteStore._getNewFileContentString

  • summary

    Generate a string that can be saved to a file.
    The result should look similar to:
    http://trac.dojotoolkit.org/browser/dojo/trunk/tests/data/countries.json

  • type

    Function

• dojo.data.ItemFileWriteStore._isEmpty

  • parameters:
    • something: (typeof The)

      array or object to examine.

  • returns

    boolean

  • summary

    Function to determine if an array or object has no properties or values.

  • type

    Function

• dojo.data.ItemFileWriteStore.save

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

    See dojo.data.api.Write.save()

  • type

    Function

• dojo.data.ItemFileWriteStore._saveInProgress

  • type

    bool

• dojo.data.ItemFileWriteStore.revert

  • returns

    boolean

  • summary

    See dojo.data.api.Write.revert()

  • type

    Function

• dojo.data.ItemFileWriteStore._pending

  • type

    Object

• dojo.data.ItemFileWriteStore.isDirty

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

    boolean

  • summary

    See dojo.data.api.Write.isDirty()

  • type

    Function

• dojo.data.ItemFileWriteStore.onSet

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • oldValue: (typeof object)

      | array

    • newValue: (typeof object)

      | array

  • summary

    See dojo.data.api.Notification.onSet()

  • type

    Function

• dojo.data.ItemFileWriteStore.onNew

  • parameters:
    • newItem: (typeof item)
    • parentInfo: (typeof object)
  • summary

    See dojo.data.api.Notification.onNew()

  • type

    Function

• dojo.data.ItemFileWriteStore.onDelete

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

    See dojo.data.api.Notification.onDelete()

  • type

    Function

• dojo.data.ItemFileWriteStore.close

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

    Over-ride of base close function of ItemFileReadStore to add in check for store state.

  • description

    Over-ride of base close function of ItemFileReadStore to add in check for store state.
    If the store is still dirty (unsaved changes), then an error will be thrown instead of
    clearing the internal state for reload from the url.

  • type

    Function

• dojo.data.ItemFileWriteStore._features.dojo.data.api.Write

  • type

    Object

• dojo.data.ItemFileWriteStore._features.dojo.data.api.Notification

  • type

    Object

• dojo.data.ItemFileWriteStore._datatypeMap.Date.serialize

  • parameters:
    • obj
  • type

    Function

• dojo.data

  • type

    Object

• dojo

  • type

    Object