Rolling
[cql-java-moved-to-github.git] / Changes
diff --git a/Changes b/Changes
index 74d7c6e..2c1a35d 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,21 +1,87 @@
-$Id: Changes,v 1.7 2002-11-12 22:37:48 mike Exp $
+$Id: Changes,v 1.25 2002-12-09 16:56:07 mike Exp $
 
-Revision history for "cql-java"
+Revision history for the CQL-Java package.
+See the bottom of this file for a list of things still to do.
 
-0.3  (IN PROGRESS)
+0.5  (IN PROGRESS, currently at RC1)
+       - Add an extra back-end method,
+               byte[] toType1(Properties config)
+         which generates an opaque BER-encoded PDU suitable for
+         forwarding to Z39.50 server as a pasrt of a searchRequest
+         APDU.  This was contributed by Ralph Levan <levan@oclc.org>
+       - Change regression-test rules for Adam's compiler to use his
+         new front-end cql2xcql instead of the old cqlparse3.
+       - Change the names of the anchoring properties in
+         etc/pqf.properties and the CQLTermNode code that examines
+         them, in accordance with Adam's PQF-renderer's behaviour.
+         This gives more flexibility in terms of generating
+         attributes for end-of-field anchoring.
+       - Fix comment in etc/pqf.properties (claimed that the Type-1
+         "string" attribute was "phrase").  Just a documentation
+         error.
+       - Change the capitalisation of the project name from
+         "cql-java" to "CQL-Java".  That doesn't really make any
+         difference to anything: in particular, file-names such as
+         "cql-java.jar" remain the same.
+       - Recreate last-in-field support
+       - ### Add srw.resultSet support to the toPFQ() method.
+       - ### Fix term-to-PQF translation to omit empty properties
+         (for the broken Korean server)
+
+0.4  Thu Nov 21 10:09:26 2002
+       - Add support for the new "phonetic" relation modifier,
+         including its mapping in "etc/pqf.properties".
+       - Make prefix-maps bind loosely, so that ``>dc=x a and b''
+         applies the dc=x binding to both the ``a'' and ``b''
+         sub-queries.
+       - Change the XCQL output to include the nasty (but official)
+         <leftOperand> and <rightOperand> wrapper elements.
+       - Change the XCQL output to use the nasty (but official)
+         rendition of prefix-mapping: a <prefixes> element,
+         containing one of more <prefix>es may appear at the top
+         of either a <searchClause> or a <triple>.
+       - Include test/regression/xmlpp.pl in the distribution: this
+         may now be used for testing whether a CQL compiler produces
+         _equivalent_ XCQL to what's in the regression test, rather
+         than requiring byte-identical output.
+       - Include the reference XCQL output in the distribution, for
+         the regression test suite to run against.
+       - Change build process so that javadoc documentation is built
+         by "make" in the "docs" directory.  There's now a top-level
+         makefile that builds the source, runs the test suite and
+         creates the documentation.
+       - Write javadoc comments for CQLRelation and ModifierSet.
+       - Other improvements to javadoc comments (e.g. describe the
+         `config' parameter to the toPQF() method.)
+       - Sort out the licence: I've settled on the LGPL.
+       - Remove the redundant and misleading etc/Grammar file.
+       - Fix up various Maintenance Agency web addresses that have
+         moved in the great ZING-release shake-up.
+
+0.3  Fri Nov 15 12:04:04 2002
+       - Allow keywords to be used unquoted as search terms.
+       - Add support for serverChoiceRelation (scr).
+       - Add support for prefix-mapping, as in
+               >dc="http://www.loc.gov/zing/cql/dc-indexes/" dc.title=fish
+         and
+               >"http://www.loc.gov/zing/cql/dc-indexes/" dc.title=fish
+         The XCQL generated corresponds to Adam's suggested format
+         rather than Rob's, not so much because I prefer it (although
+         I do) as because it's what fell out when I just Coded What
+         Comes Natur'ly.  That may need to change, depending on the
+         result of the ZNG list's deliberations.
+       - Fix the parser to normalise relation modifiers to lower case.
        - Fix the CQLParser test harness not to emit an extraneous
          blank line at end of XCQL output.
-       - Fix the parser to normalise relation modifiers to lower case.
        - Fix CQLNode documentation to contain a link to YAZ's
          documentation of Prefix Query Format (PQF) rather than
          containing a rather unhelpful chunk of BNF.
-       - Change the source directory's Makefile so that it specifies
-         the appropriate -classpath by default.
-         ### undo this change!
        - Change the test/regression Makefile so that "make clean" now
          does what "make distclean" used to do - the distinction
          between them is pointless.
        - Fix a few typos in the documentation.
+       - Move the README file's old "THINGS TO DO" section to the end
+         of this file, the new "Still to do" section.
 
 0.2  Wed Nov  6 23:05:54 2002
        - Fix the order of proximity parameters in accordance with the
@@ -45,3 +111,24 @@ Revision history for "cql-java"
 0.1  Sun Nov  3 20:58:27 2002
        - First public release.
 
+--
+
+### Still to do
+       - Fix the 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 StreamTokenizer and rolling our own, which we absolutely
+       - Write "package.html" 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.
+       - 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
+         * Generate prefix-mappings
+