summaryrefslogtreecommitdiff
path: root/includes/js/dojox/data/README
blob: 94565f96bdd9be83033280604a028749b9a3e1b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
-------------------------------------------------------------------------------
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.