-$Id: README,v 1.16 2002-11-08 09:50:58 mike Exp $
+$Id: README,v 1.19 2002-11-18 14:41:02 mike Exp $
cql-java - a free CQL compiler, and other CQL tools, for Java
XCQL is "XML CQL", a representation of CQL-equivalent queries in XML
which is supposed to be easier to parse. More information at
- http://www.loc.gov/z3950/agency/zing/srwu/xcql.html
-(not much more, though)
+ http://www.loc.gov/z3950/agency/zing/cql/xcql.html
+include an XML Schema.
But if you didn't know that, why are you even reading this? :-)
etc Other files: CQL Grammar, generator properties, etc.
"Installation" of this package would consist of putting the bin
-directory on your PATH and the lib directory on your CLASSPATH.
+directory on your PATH and lib/cql-java.jar on your CLASSPATH.
SYNOPSIS
Using the test-harnesses:
$ CQLParser 'title=foo and author=(bar or baz)'
+ $ CQLParser -c 'title=foo and author=(bar or baz)'
+ $ CQLParser -p /etc/pqf.properties 'title=foo and author=(bar or baz)'
$ CQLLexer 'title=foo and author=(bar or baz)'
(not very interesting unless you're debugging)
$ CQLGenerator etc/generate.properties seed 18
LICENCE
-------
-This software is Open Source, but I've not yet decided exactly what
-licence to use. Be good. Assume I'm going with the GPL (most
-restrictive) until I say otherwise. For what it's worth, I think the
-most likely licence is the LGPL (GNU's Lesser General Public Licence)
-which lets you deploy cql-java as a part of a non-free larger work.
+The cql-java suite is Free Software, which is legally -- though not
+morally -- equivalent to Open Source. See
+ http://www.gnu.org/philosophy/free-software-for-freedom.html
+for a detailed if somewhat one-sided discussion of the differences,
+and particularly of why Free Software is an important idea.
+
+cql-java is distributed under version 2.1 of the LGPL (GNU LESSER
+GENERAL PUBLIC LICENSE). A copy of the licence is included in this
+distribution, as the file LGPL-2.1. This licence does not allow you
+to restrict the freedom of others to use derived versions of cql-java
+(i.e. you must share your enhancements), but does let you deploy
+cql-java as a part of a non-free larger work.
SEE ALSO
Adam Dickmeiss's CQL compiler, written in C.
Rob Sanderson's CQL compiler, written in Python.
All the other free CQL compilers everyone's going to write :-)
-
-
-THINGS TO DO
-------------
-
-* ### Fix bug where "9x" is parsed as two tokens, a TT_NUMBER followed
- by a TT_WORD. The problem here is that I don't think it's actually
- possible to fix this without throwing out StreakTokenizer and
- rolling our own, which we absolutely _don't_ want to do.
-
-* Allow keywords to be used unquoted as search terms.
-
-* Add support for serverChoiceRelation (scr).
-
-* Write javadoc comments for CQLRelation and ModifierSet.
-
-* Write "overview" file for the javadoc documentation.
-
-* Some niceties for the cql-decompiling back-end:
- * don't emit redundant parentheses.
- * don't put spaces around relations that don't need them.
-
-* Consider the utility of yet another back-end that translates a
- CQLNode tree into a Type-1 query tree using the JZKit data
- structures. That would be nice so that CQL could become a JZKit
- query-type; but you could achieve the same effect by generating PQN,
- and running that through JZKit's existing PQN-to-Type-1 compiler.
-
-* Many refinements to the random query generator:
- * Generate relation modifiers
- * Proximity support
- * Don't always generate qualifier/relation for terms
- * Better selection of qualifier (configurable?)
- * Better selection of terms (from a dictionary file?)
- * Introduce wildcard characters into generated terms
- * Generate multi-word terms
-
+The "Changes" file, including the "Still to do" section.