LOTS of changes. Biggies include proper support for relations, including

[cql-java-moved-to-github.git] / README

diff --git a/README b/README
index d0b3d9f..e4e2320 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,15 @@
-$Id: README,v 1.2 2002-10-24 16:06:34 mike Exp $
+$Id: README,v 1.5 2002-10-30 09:19:26 mike Exp $
 
 cql-java -- a free CQL compiler for Java
 
 
 This project provides a set of classes for representing a CQL parse
-tree (CQLBooleanNode, CQLTermNode, etc.) and a Compiler class which
+tree (CQLBooleanNode, CQLTermNode, etc.) and a CQLCompiler class which
 builds a parse tree given a CQL query as input.  It also provides
-compiler back-ends to render out the parse tree either as XCQL or
-Yaz-style Prefix Query Format (PQF).
+compiler back-ends to render out the parse tree as XCQL (the XML
+representation), as PQF (Yaz-style Prefix Query Format) and as CQL
+(i.e. decompiling the parse-tree).  Oh, and there's a random query
+generator, too.
 
 CQL is "Common Query Language", a new query language designed under
 the umbrella of the ZING initiative (Z39.59-International Next
@@ -33,10 +35,18 @@ Library:
 
        import org.z3950.zing.cql.*
 
+       // Building a parse-tree by hand
+       CQLNode n1 = new CQLTermNode("dc.author", "=", "kernighan");
+       CQLNode n2 = new CQLTermNode("dc.title", "all", "elements style");
+       CQLNode root = new CQLAndNode(n1, n2);
+       System.out.println(root.toXCQL(3));
+
+       // Parsing a CQL query
        CQLParser parser = new CQLParser();
        CQLNode root = parser.parse("title=dinosaur");
-       print root.toXCQL();
-       print root.toPQF(qualSet);
+       System.out.println(root.toXCQL(0));
+       System.out.println(root.toCQL());
+       System.out.println(root.toPQF(qualSet));
        // ... where `qualSet' specifies CQL-qualfier => Z-attr mapping
 
 
@@ -67,4 +77,42 @@ 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.
+All the other free CQL compilers everyone's going to write  :-)
+
+
+TO DO
+-----
+
+* Add proximity support to parser
+
+* Some niceties for the CQL-decompiling back-end:
+       * Don't emit redundant parentheses.
+       * Don't put spaces around relations that don't need them.
+
+* Write PQN-generating back-end (will need to be driven from a
+  configuation file specifying how to represent the qualifiers,
+  relations, relation modifiers and wildcard characters as Z39.50
+  attributes.)
+
+* 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.
+
+* Refinements to random query generator:
+       * Fix to handle new, structured, relation representation
+       * Generate relation modifiers
+       * Proximity support
+       * Better selection of qualifier (configurable?)
+       * Better selection of terms (from a dictionary file?)
+       * Introduce wildcard characters into generated terms
+       * Generate multi-word terms
+
+* Write fuller "javadoc" comments.
+
+* Write generic test suite.
+
+* Fix CQLParser test harness to read query from command-line
+  arguments, if any, falling back to stdin if there are none.
+