X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=README;h=913a781e5aff5db7805bbfcab726fce8d9ea85ab;hb=b4c87f12830bb1525aebb00e98dce5e6153bea71;hp=e06bf2bb99411b8d561c8883aa1f553c811c8c7d;hpb=0e0dab87fb1e5b77346d845861a88269ffcc0434;p=cql-java-moved-to-github.git diff --git a/README b/README index e06bf2b..913a781 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -$Id: README,v 1.13 2002-11-05 17:20:30 mike Exp $ +$Id: README,v 1.17 2002-11-08 13:49:48 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 @@ -43,7 +43,7 @@ What's what in this distribution? 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 @@ -73,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 @@ -114,8 +114,6 @@ All the other free CQL compilers everyone's going to write :-) THINGS TO DO ------------ -* ### Make necessary parts of CQLNode etc. public. - * ### 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 @@ -123,16 +121,16 @@ THINGS 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. -* 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 @@ -148,4 +146,3 @@ THINGS TO DO * Introduce wildcard characters into generated terms * Generate multi-word terms -* Write fuller "javadoc" comments.