SemanticScuttle/includes/js/dojox/data/README

89 lines
3.4 KiB
Text

-------------------------------------------------------------------------------
DojoX Data
-------------------------------------------------------------------------------
Version 1.1
Release date: 03/18/2008
-------------------------------------------------------------------------------
Project state: stable
-------------------------------------------------------------------------------
Project authors
Jared Jurkiewicz (jared.jurkiewicz@gmail.com)
Shane O'Sullivan (shaneosullivan1@gmail.com) (FlickrRestStore, AtomReadStore)
Wolfram Kriesing (wolfram@kriesing.de) (QueryReadStore)
Dustin Machi (dmachi@dojotolkit.org) (jsonPathStore);
Russell Jones (KeyValueStore) (CLA)
Benjamin Schell (KeyValueStore) (Corporate CLA)
Kurt Stutsman (kurt@snaplogic.org) (SnapLogicStore)
-------------------------------------------------------------------------------
Project description
The DojoX Data project is a container for extensions and extra example stores
that implement the dojo.data APIs. It may also contain utility functions for
working with specific types of data.
-------------------------------------------------------------------------------
Dependencies:
DojoX Data has dependencies on core dojo (dojo.data) and the D.O.H. unit test
framework.
-------------------------------------------------------------------------------
Documentation:
See the Dojo API tool (http://dojotoolkit.org/api)
-------------------------------------------------------------------------------
Contributions:
For contributions to be committed into the dojox repository, the datastore
should have basic unit tests that exercise the API's that the store declares it
implements. Documentation and demos are a plus, but unit tests are required
to be committed into this sub-package. This is necessary to help keep the
provided datastores as stable as possible.
-------------------------------------------------------------------------------
Installation instructions
Grab the following from the Dojo SVN Repository:
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/data/*
Install into the following directory structure:
/dojox/data/
...which should be at the same level as your Dojo checkout.
/dojox/data/*
Require in the dojox.data stores you wish to use.
-------------------------------------------------------------------------------
Additional Notes:
dojox.data.AtomReadStore - Reads Atom XML documents.
dojox.data.CvsStore - comma-separated (spreadsheet output)
datastore implementation
dojox.data.FlickrRestStore - advanced version of: dojox.data.FlickrStore
(Caching + user key support)
dojox.data.FlickrStore - data store driven by Flickr.com public API.
dojox.data.HtmlTableStore - Implementation of an HTML Table reading
datastore
dojox.data.HtmlStore - Implementation of an HTML reading datastore. Can
handle tables, ordered and un-ordered lists, and lists of divs.
dojox.data.OpmlStore - Store for reading OMPL formatted data
dojox.data.XmlStore - datastore for XML based services or
documents.
dojox.data.QueryReadStore - datastore to provide serverside URL query
matching. Similar to the 0.4.X ComboBox dataUrl parameter.
dojox.data.jsonPathStore - datastore that takes an arbitrary js object
and uses it as the store. Pre-Alpha at the moment.
dojox.data.KeyValueStore - datastore that mimics a key/value property
file format.
dojox.data.SnapLogicStore - Store to interface to SnapLogic data services.