[patch][cla] AndOrReadStore, AndOrWriteStore: New stores supporting complex queries

[frankf]

The attached AndOrReadStore?.js and AndOrWriteStore?.js are identical to ItemFileReadStore? and ItemFileWriteStore?, except the read store's _fetchItems, filter function supports complex queries against the store.

Example queries supported:

  Programmatic:
    query[:|=]"NOT id:23* AND (type:'test*' OR dept:'bob') && !filed:true"

  Widget (where json object may be required for query):
    query[:|=]{complexQuery:"NOT id:23* AND (type:'test*' OR dept:'bob') && !filed:true"}

Available logical operators (case insensitive):

  , NOT AND OR ( ) ! && ||  Note: "," included for legacy queries (translated to AND).

Also, simple queries, as typically used with the other stores, are supported.

The stores are intended for dojox/data.

The attached AndOrXXXXStore.js unit test files are intended for dojox/data/tests/stores. The test file names are temporarily pre-fixed with "t" to prevent overwriting.

The attached patch file adds the two stores to the modules.js file in dojox/data/tests.

[frankf]

AndOrReadStore?.js, complex query capability

[frankf]

AndOrWriteStore?.js, complex query capability

[frankf]

to be renamed to AndOrReadStore?.js and placed in dojox/data/tests/stores

[frankf]

to be renamed to AndOrWriteStore?.js and placed in dojox/data/tests/stores

[frankf]

patch to dojox/data/tests/module.js to add the two stores

[wolfram]

Is the read store doing the filtering on the client side? So its first loading the data from the server and later filtering it in the browser?

[frankf]

Yes. The two stores are copies of ItemFileXXXXStore, with the only change being the query (_fetchItem) modified to accept a more complex query.

So, to do filtering for a Grid, you just do grid.model.query="...." and then grid.model.refresh(), and the Grid will reflect the results of the complexQuery.

[wolfram]

Aha, so you could also extend the ItemFileXXXXStore and add a method such as _filterResponse() just like it was added to QueryReadStore? and supply a mixin or alike that supplies the filtering stuff you are suggesting? see http://trac.dojotoolkit.org/browser/dojox/trunk/data/QueryReadStore.js?rev=11711#L363 What do you think?

[frankf]

I didn't study that closely, but it seems possible, maybe for any of the stores? Are you suggesting that approach (1) to replace what I submitted or (2) using the complex query part from it for other stores? Both sound interesting...

[wolfram]

I think it would also prove extensibility of the existing stores quite well if you could provide AndOrReadStore? as an extension, so I think it would be 1) of your options.

I have to possible ways in mind A) A new store extending ItemFileReadStore?

dojo.declare("dojox.data.AndOrReadStore", "dojo.data.ItemFileReadStore", {
    _filterResponse:function(data) {
    }
});

Which has the big disadvantage of working ONLY with ItemFileReadStore? ...

B) Write a mixin that can be used for any store

dojo.declare("dojox.data._AndOrReadMixin", null, {
    _filterResponse:function(data) {
    }
});

Which then can be used by the anyone to extend any store, i.e.

var s = new dojox.data.QueryReadStore(params);
dojo.mixin(s, dojox.data._AndOrReadMixin);

And now "s" would also have the capabilities you suggested! Disadvantage is that one would always have to mix-in the _AndOrReadMixin. or is there something like

<div dojoType="dojox.data.QueryReadStore" mixin="dojox.data._AndOrReadMixin" />

I hope others have opinions too to know which makes most sense. Actually I like the second one best. But it might also very much be possible that I make things too complicated again :-)

[frankf]

Thanks. I like your suggestion of having a bite-sized piece of code to maintain and just being able to mixin it, with possibly having a pre-mixedin store, also, for the newer dojo users who don't yet grasp it, just want to grab a store and go.

I'll look at it some at the end of the week, unless you get there first :).

[dante]

I vote generic mixin (b) so it can be reused in any store, in generic ways (if it's really that easy)

But this discussion should be continued on dojo-interest/contributors or more ideally the dojox dev forums.

[jaredj]

A mixin helper (much like the stuff in dojo.data.util), would be nice for those who want to extend their query support beyond the recommended basic queries that all stores should support.

I'm going to move this to 1.2 so we can settle on how to put it in.

[jaredj]

Zipped version of the patch. Otherwise too big.

[jaredj]

(In [13644]) Adding in the AndOr?*Store from Frank F. Had to do a lot of work to get JSLint to like the code. fixes #5873 \!strict