git.pond.sub.org Git - eow/blob - static/dojo-release-1.1.1/dojox/data/README

   1 -------------------------------------------------------------------------------
   2 DojoX Data
   3 -------------------------------------------------------------------------------
   4 Version 1.1
   5 Release date: 03/18/2008
   6 -------------------------------------------------------------------------------
   7 Project state: stable
   8 -------------------------------------------------------------------------------
   9 Project authors
  10         Jared Jurkiewicz (jared.jurkiewicz@gmail.com)
  11         Shane O'Sullivan (shaneosullivan1@gmail.com) (FlickrRestStore, AtomReadStore)
  12         Wolfram Kriesing (wolfram@kriesing.de) (QueryReadStore)
  13         Dustin Machi (dmachi@dojotolkit.org) (jsonPathStore);
  14         Russell Jones (KeyValueStore) (CLA)
  15         Benjamin Schell (KeyValueStore) (Corporate CLA)
  16         Kurt Stutsman (kurt@snaplogic.org) (SnapLogicStore)
  17
  18 -------------------------------------------------------------------------------
  19 Project description
  20
  21 The DojoX Data project is a container for extensions and extra example stores
  22 that implement the dojo.data APIs.  It may also contain utility functions for
  23 working with specific types of data.
  24
  25 -------------------------------------------------------------------------------
  26 Dependencies:
  27
  28 DojoX Data has dependencies on core dojo (dojo.data) and the D.O.H. unit test
  29 framework.
  30 -------------------------------------------------------------------------------
  31 Documentation:
  32
  33 See the Dojo API tool (http://dojotoolkit.org/api)
  34 -------------------------------------------------------------------------------
  35 Contributions:
  36
  37 For contributions to be committed into the dojox repository, the datastore
  38 should have basic unit tests that exercise the API's that the store declares it
  39 implements.  Documentation and demos are a plus, but unit tests are required
  40 to be committed into this sub-package.  This is necessary to help keep the
  41 provided datastores as stable as possible.
  42
  43 -------------------------------------------------------------------------------
  44 Installation instructions
  45
  46 Grab the following from the Dojo SVN Repository:
  47 http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/data/*
  48
  49 Install into the following directory structure:
  50 /dojox/data/
  51
  52 ...which should be at the same level as your Dojo checkout.
  53
  54 /dojox/data/*
  55
  56 Require in the dojox.data stores you wish to use.
  57 -------------------------------------------------------------------------------
  58 Additional Notes:
  59         dojox.data.AtomReadStore - Reads Atom XML documents.
  60
  61         dojox.data.CvsStore - comma-separated (spreadsheet output)
  62         datastore implementation
  63
  64         dojox.data.FlickrRestStore - advanced version of: dojox.data.FlickrStore
  65         (Caching + user key support)
  66
  67         dojox.data.FlickrStore - data store driven by Flickr.com public API.
  68
  69         dojox.data.HtmlTableStore - Implementation of an HTML Table reading
  70         datastore
  71
  72         dojox.data.HtmlStore - Implementation of an HTML reading datastore.  Can
  73         handle tables, ordered and un-ordered lists, and lists of divs.
  74
  75         dojox.data.OpmlStore - Store for reading OMPL formatted data
  76
  77         dojox.data.XmlStore - datastore for XML based services or
  78         documents.
  79
  80         dojox.data.QueryReadStore - datastore to provide serverside URL query
  81         matching.  Similar to the 0.4.X ComboBox dataUrl parameter.
  82
  83         dojox.data.jsonPathStore - datastore that takes an arbitrary js object
  84         and uses it as the store. Pre-Alpha at the moment.
  85
  86         dojox.data.KeyValueStore - datastore that mimics a key/value property
  87         file format.
  88
  89         dojox.data.SnapLogicStore - Store to interface to SnapLogic data services.