X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=README;h=a508b3dcbc8a8507ede3c7dd8187e45858edb22b;hb=fc82b225d39cc66cb85c2557db0c0d4a4c5a6e27;hp=c3553a4d469f30c4cb4abef09db76599840bf9ee;hpb=08b7f3f08d97b9efdd5a3aef7992a359b71910d6;p=cql-java-moved-to-github.git diff --git a/README b/README index c3553a4..a508b3d 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -$Id: README,v 1.10 2002-11-03 16:49:37 mike Exp $ +$Id: README,v 1.15 2002-11-06 20:13:45 mike Exp $ cql-java - a free CQL compiler, and other CQL tools, for Java @@ -15,7 +15,7 @@ cql-java is a Free Software project that provides: * A selection of compiler back-ends to render out the parse tree as: * XCQL (the standard XML representation) * CQL (i.e. decompiling the parse-tree) - * PQF (Yaz-style Prefix Query Format) [### NOT YET] + * PQF (Yaz-style Prefix Query Format) * A random query generator, useful for testing. CQL is "Common Query Language", a new query language designed under @@ -34,6 +34,7 @@ But if you didn't know that, why are you even reading this? :-) What's what in this distribution? README This file + VERSION The version-number of this distribution src Source-code for the cql-java library lib The compiled library file, "cql-java.jar" bin Simple shell-scripts to invoke the test-harnesses @@ -72,15 +73,15 @@ Using the library in your own applications: CQLNode root = parser.parse("title=dinosaur"); System.out.print(root.toXCQL(0)); System.out.println(root.toCQL()); - System.out.println(root.toPQF(qualSet)); - // ... where `qualSet' specifies CQL-qualfier => Z-attr mapping + System.out.println(root.toPQF(config)); + // ... where `config' specifies CQL-qualfier => Z-attr mapping DESCRIPTION ----------- See the automatically generated class documentation in the "doc" -subdirectory. (It's not all there yet, but it's coming.) +subdirectory. AUTHOR @@ -118,16 +119,16 @@ THINGS TO DO possible to fix this without throwing out StreakTokenizer and rolling our own, which we absolutely _don't_ want to do. +* Write javadoc comments for CQLRelation and ModifierSet. + +* Write "overview" file for the javadoc documentation. + +* Allow keywords to be used unquoted as search terms. + * 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 the PQN-generating back-end. This 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. I think Ray has such a thing, though perhaps not yet in - a form sufficiently rigorous to be computer-readable. - * 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 @@ -143,4 +144,3 @@ THINGS TO DO * Introduce wildcard characters into generated terms * Generate multi-word terms -* Write fuller "javadoc" comments.