dojox/data/FileStore.js

• Provides:

  • dojox.data.FileStore

• dojox.data.FileStore

  • type

    Function

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

    A simple store that provides a datastore interface to a filesystem.

  • description

    A simple store that provides a datastore interface to a filesystem.  It takes a few parameters
    for initialization:

  • example

    options="expand,dirsOnly,showHiddenFiles"

• dojox.data.FileStore.constructor

  • constructor - constructor
  • type

    Function

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

    A simple store that provides a datastore interface to a filesystem.

  • description

    A simple store that provides a datastore interface to a filesystem.  It takes a few parameters
    for initialization:

  • example

    options="expand,dirsOnly,showHiddenFiles"

• dojox.data.FileStore.url

  • type

    The

  • summary

    string The URL to the file path service.

  • tags: public

• dojox.data.FileStore._storeRef

  • tags:
  • type

    string

  • summary

    Internal variable used to denote an item came from this store instance.

• dojox.data.FileStore.label

  • type

    The

  • summary

    string Default attribute to use to represent the item as a user-readable
    string.  Public, so users can change it.

  • tags: public

• dojox.data.FileStore._identifier

  • tags:
  • type

    string

  • summary

    Default attribute to use to represent the item's identifier.
    Path should always be unique in the store instance.

• dojox.data.FileStore._attributes

  • tags:
  • type

    string

  • summary

    Internal variable of attributes all file items should have.

• dojox.data.FileStore.pathSeparator

  • tags: public
  • type

    string

  • summary

    The path separator to use when chaining requests for children
    Can be overriden by the server on initial load

• dojox.data.FileStore.options

  • tags: public
  • type

    array

  • summary

    Array of options to always send when doing requests.
    Back end service controls this, like 'dirsOnly', 'showHiddenFiles', 'expandChildren', etc.

• dojox.data.FileStore.failOk

  • tags: public
  • type

    boolean

  • summary

    Flag to pass on to xhr functions to check if we are OK to fail the call silently

• dojox.data.FileStore.urlPreventCache

  • tags: public
  • type

    string

  • summary

    Flag to dennote if preventCache should be passed to xhrGet.
    
    
    Function to switch between REST style URL lookups and passing the path to specific items as a query param: 'path'.

• dojox.data.FileStore._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.FileStore._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.FileStore.pathAsQueryParam

  • type

    Object

• dojox.data.FileStore.getFeatures

  • summary

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

  • type

    Function

• dojox.data.FileStore.getValue

  • parameters:
    • item
    • attribute
    • defaultValue
  • summary

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

  • type

    Function

• dojox.data.FileStore.getAttributes

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.FileStore.hasAttribute

  • parameters:
    • item
    • attribute
  • summary

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

  • type

    Function

• dojox.data.FileStore.getIdentity

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

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

  • type

    Function

• dojox.data.FileStore.getIdentityAttributes

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.FileStore.isItemLoaded

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.FileStore.loadItem

  • parameters:
    • keywordArgs
  • summary

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

  • type

    Function

• dojox.data.FileStore.getLabel

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.FileStore.getLabelAttributes

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.FileStore.containsValue

  • parameters:
    • item
    • attribute
    • value
  • summary

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

  • type

    Function

• dojox.data.FileStore.getValues

  • parameters:
    • item
    • attribute
  • summary

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

  • type

    Function

• dojox.data.FileStore.isItem

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.FileStore.close

  • parameters:
    • request
  • summary

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

  • type

    Function

• dojox.data.FileStore.fetch

  • parameters:
    • request: (typeof A)

      request object

  • summary

    Fetch  items that match to a query

  • type

    Function

• dojox.data.FileStore.fetchItemByIdentity

  • parameters:
    • keywordArgs
  • summary

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

  • type

    Function

• dojox.data.FileStore._processResult

  • parameters:
    • data
    • request
  • type

    Function

• dojox.data.FileStore._processItemArray

  • parameters:
    • itemArray
  • summary

    Internal function for processing an array of items for return.

  • type

    Function

• dojox.data.FileStore._processItem

  • parameters:
    • item
  • summary

    Internal function for processing an item returned from the store.
    It sets up the store ref as well as sets up the attributes necessary
    to invoke a lazy load on a child, if there are any.

  • type

    Function

• dojox.data

  • type

    Object

• dojox

  • type

    Object