README 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. -------------------------------------------------------------------------------
  2. DojoX Data
  3. -------------------------------------------------------------------------------
  4. Version 1.1
  5. Release date: 03/18/2008
  6. -------------------------------------------------------------------------------
  7. Project state: production
  8. -------------------------------------------------------------------------------
  9. Project authors
  10. Jared Jurkiewicz (jared.jurkiewicz@gmail.com) (FileStore, HtmlStore, XmlStore, FlickrStore, CssRuleStore, CssClassStore, AppStore, others).
  11. Shane O'Sullivan (shaneosullivan1@gmail.com) (FlickrRestStore, AtomReadStore, GoogleSeachStore, GoogleFeedStore)
  12. Wolfram Kriesing (wolfram@kriesing.de) (QueryReadStore)
  13. Dustin Machi (dmachi@dojotolkit.org) (jsonPathStore);
  14. Russell Jones (KeyValueStore) (CLA)
  15. Benjamin Schell (KeyValueStore, CssRuleStore, CssClassStore, AppStore, OpenSearchStore) (Corporate CLA)
  16. Kurt Stutsman (kurt@snaplogic.org) (SnapLogicStore)
  17. Kris Zyp (kzyp@dojotoolkit.org) (JsonRestStore, PersevereStore, S3JsonRestStore, CouchDBRestStore)
  18. Frank Fortson (frank.fortson@equorum.com) (AndOrReadStore, AndOrWriteStore)
  19. -------------------------------------------------------------------------------
  20. Project description
  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. Dependencies:
  26. DojoX Data has dependencies on core dojo (dojo.data), dojox.xml for XmlStore
  27. and dojox.data.dom(deprecated) and the D.O.H. unit test framework
  28. -------------------------------------------------------------------------------
  29. Documentation:
  30. See the Dojo API tool (http://dojotoolkit.org/api)
  31. -------------------------------------------------------------------------------
  32. Contributions:
  33. For contributions to be committed into the dojox repository, the datastore
  34. should have basic unit tests that exercise the API's that the store declares it
  35. implements. Documentation and demos are a plus, but unit tests are required
  36. to be committed into this sub-package. This is necessary to help keep the
  37. provided datastores as stable as possible.
  38. -------------------------------------------------------------------------------
  39. Installation instructions
  40. Grab the following from the Dojo SVN Repository:
  41. http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/data/*
  42. Install into the following directory structure:
  43. /dojox/data/
  44. ...which should be at the same level as your Dojo checkout.
  45. /dojox/data/*
  46. Require in the dojox.data stores you wish to use.
  47. -------------------------------------------------------------------------------
  48. Additional Notes:
  49. dojox.data.AtomReadStore - Reads Atom XML documents.
  50. dojox.data.CvsStore - comma-separated (spreadsheet output)
  51. datastore implementation
  52. dojox.data.FlickrRestStore - advanced version of: dojox.data.FlickrStore
  53. (Caching + user key support)
  54. dojox.data.FlickrStore - data store driven by Flickr.com public API.
  55. dojox.data.HtmlTableStore - Implementation of an HTML Table reading
  56. datastore
  57. dojox.data.HtmlStore - Implementation of an HTML reading datastore. Can
  58. handle tables, ordered and un-ordered lists, and lists of divs.
  59. dojox.data.OpmlStore - Store for reading OMPL formatted data
  60. dojox.data.XmlStore - datastore for XML based services or
  61. documents.
  62. dojox.data.QueryReadStore - datastore to provide serverside URL query
  63. matching. Similar to the 0.4.X ComboBox dataUrl parameter.
  64. dojox.data.jsonPathStore - datastore that takes an arbitrary js object
  65. and uses it as the store. Pre-Alpha at the moment.
  66. dojox.data.KeyValueStore - datastore that mimics a key/value property
  67. file format.
  68. dojox.data.SnapLogicStore - Store to interface to SnapLogic data services.
  69. dojox.data.JsonRestStore - Store to interface with RESTful HTTP/JSON web services.
  70. dojox.data.PersevereStore - Extension of JsonRestStore for Persevere
  71. dojox.data.CouchDBRestStore - Extension of JsonRestStore for CouchDB
  72. dojox.data.S3JsonRestStore - Extension of JsonRestStore for Amazon S3
  73. dojox.data.GoogleSearchStore - Store to interface Google's AJAX search services.
  74. There are many subclasses of this store for particular types of searches:
  75. dojox.data.GoogleWebSearchStore
  76. dojox.data.GoogleBlogSearchStore
  77. dojox.data.GoogleLocalSearchStore
  78. dojox.data.GoogleVideoSearchStore
  79. dojox.data.GoogleNewsSearchStore
  80. dojox.data.GoogleBookSearchStore
  81. dojox.data.GoogleImageSearchStore
  82. dojox.data.AndOrReadStore - Demonstrating a more complex query format allowing AND/OR.
  83. Based directly on dojo.data.ItemFileReadStore.
  84. dojox.data.AndOrWriteStore - Demonstrating a more complex query format allowing AND/OR.
  85. Based directly on dojo.data.ItemFileWriteStore.
  86. dojox.data.FileStore - A lazy-loading store designed for searching filesystems with a provided
  87. PHP back end. Implements dojo.data.api.Read and dojo.data.api.Identity
  88. dojox.data.CssRuleStore - A store that allows searching/querying over Css rules loaded in the page in
  89. the browser.
  90. dojox.data.CssClassStore - A store that allows searching/querying over what classes are defined in the page in
  91. the browser.
  92. dojox.data.AppStore - A store that implements full read, write, and identity APIs for working with ATOM documents.
  93. The store uses the full APP protocol.
  94. dojox.data.OpenSearchStore - A store that implements OpenSearch provider search capability.