Project

General

Profile

Statistics
| Revision:

root / trunk / web / dojo / dojox / data / README @ 11

History | View | Annotate | Download (5.43 KB)

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

    
21
-------------------------------------------------------------------------------
22
Project description
23

    
24
The DojoX Data project is a container for extensions and extra example stores
25
that implement the dojo.data APIs.  It may also contain utility functions for
26
working with specific types of data.
27

    
28
-------------------------------------------------------------------------------
29
Dependencies:
30

    
31
DojoX Data has dependencies on core dojo (dojo.data), dojox.xml for XmlStore 
32
and dojox.data.dom(deprecated) and the D.O.H. unit test framework
33
-------------------------------------------------------------------------------
34
Documentation:
35

    
36
See the Dojo API tool (http://dojotoolkit.org/api)
37
-------------------------------------------------------------------------------
38
Contributions:
39

    
40
For contributions to be committed into the dojox repository, the datastore 
41
should have basic unit tests that exercise the API's that the store declares it
42
implements.  Documentation and demos are a plus, but unit tests are required
43
to be committed into this sub-package.  This is necessary to help keep the 
44
provided datastores as stable as possible.
45

    
46
-------------------------------------------------------------------------------
47
Installation instructions
48

    
49
Grab the following from the Dojo SVN Repository:
50
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/data/*
51

    
52
Install into the following directory structure:
53
/dojox/data/
54

    
55
...which should be at the same level as your Dojo checkout.
56

    
57
/dojox/data/*
58

    
59
Require in the dojox.data stores you wish to use.
60
-------------------------------------------------------------------------------
61
Additional Notes: 
62
	dojox.data.AtomReadStore - Reads Atom XML documents.
63

    
64
	dojox.data.CvsStore - comma-separated (spreadsheet output)
65
	datastore implementation 
66
	
67
	dojox.data.FlickrRestStore - advanced version of: dojox.data.FlickrStore 
68
	(Caching + user key support) 
69
	
70
	dojox.data.FlickrStore - data store driven by Flickr.com public API. 
71
	
72
	dojox.data.HtmlTableStore - Implementation of an HTML Table reading 
73
	datastore
74
	
75
	dojox.data.HtmlStore - Implementation of an HTML reading datastore.  Can 
76
	handle tables, ordered and un-ordered lists, and lists of divs.
77
	
78
	dojox.data.OpmlStore - Store for reading OMPL formatted data
79
	
80
	dojox.data.XmlStore - datastore for XML based services or  
81
	documents.
82

    
83
	dojox.data.QueryReadStore - datastore to provide serverside URL query
84
	matching.  Similar to the 0.4.X ComboBox dataUrl parameter.	         
85

    
86
	dojox.data.jsonPathStore - datastore that takes an arbitrary js object
87
	and uses it as the store. Pre-Alpha at the moment.
88

    
89
	dojox.data.KeyValueStore - datastore that mimics a key/value property
90
	file format.
91

    
92
	dojox.data.SnapLogicStore - Store to interface to SnapLogic data services.
93

    
94
	dojox.data.JsonRestStore - Store to interface with RESTful HTTP/JSON web services.
95
	dojox.data.PersevereStore - Extension of JsonRestStore for Persevere
96
	dojox.data.CouchDBRestStore - Extension of JsonRestStore for CouchDB
97
	dojox.data.S3JsonRestStore - Extension of JsonRestStore for Amazon S3
98
	dojox.data.GoogleSearchStore - Store to interface Google's AJAX search services.  
99
		There are many subclasses of this store for particular types of searches:
100
		dojox.data.GoogleWebSearchStore
101
		dojox.data.GoogleBlogSearchStore
102
		dojox.data.GoogleLocalSearchStore
103
		dojox.data.GoogleVideoSearchStore
104
		dojox.data.GoogleNewsSearchStore
105
		dojox.data.GoogleBookSearchStore
106
		dojox.data.GoogleImageSearchStore
107

    
108
	dojox.data.AndOrReadStore - Demonstrating a more complex query format allowing AND/OR.  
109
	Based directly on dojo.data.ItemFileReadStore.
110

    
111
	dojox.data.AndOrWriteStore - Demonstrating a more complex query format allowing AND/OR.  
112
	Based directly on dojo.data.ItemFileWriteStore.
113

    
114
	dojox.data.FileStore - A lazy-loading store designed for searching filesystems with a provided
115
	PHP back end.  Implements dojo.data.api.Read and dojo.data.api.Identity
116

    
117
	dojox.data.CssRuleStore - A store that allows searching/querying over Css rules loaded in the page in
118
	the browser.
119

    
120
	dojox.data.CssClassStore - A store that allows searching/querying over what classes are defined in the page in
121
	the browser.
122

    
123
	dojox.data.AppStore - A store that implements full read, write, and identity APIs for working with ATOM documents.
124
	The store uses the full APP protocol.
125
        
126
	dojox.data.OpenSearchStore - A store that implements OpenSearch provider search capability.
127