Changes

   1 $Id: Changes,v 1.15 2002-11-19 17:23:26 mike Exp $
   2
   3 Revision history for "cql-java"
   4 See the bottom of this file for a list of things still to do.
   5
   6 0.4  (IN PROGRESS)
   7         - Add support for the new "phonetic" relation modifier,
   8           including its mapping in "etc/pqf.properties".
   9         - Make prefix-maps bind loosely, so that ``>dc=x a and b''
  10           applies the dc=x binding to both the ``a'' and ``b''
  11           sub-queries.
  12         - Change build process so that javadoc documentation is built
  13           by "make" in the "docs" directory.
  14         - Write javadoc comments for CQLRelation and ModifierSet.
  15         - Other improvements to javadoc comments (e.g. describe the
  16           `config' parameter to the toPQF() method.)
  17         - Include test/regression/xmlpp.pl in the distribution: will
  18           be used for testing whether a CQL compiler produces
  19           _equivalent_ XCQL to the what's in the regression test,
  20           rather than requiring byte-identical output.
  21         - Sort out the licence: I've settled on the LGPL.
  22
  23 0.3  Fri Nov 15 12:04:04 2002
  24         - Allow keywords to be used unquoted as search terms.
  25         - Add support for serverChoiceRelation (scr).
  26         - Add support for prefix-mapping, as in
  27                 >dc="http://dublincore.org/ dc.title=fish
  28           and
  29                 >"http://dublincore.org/ title=fish
  30           The XCQL generated corresponds to Adam's suggested format
  31           rather than Rob's, not so much because I prefer it (although
  32           I do) as because it's what fell out when I just Coded What
  33           Comes Natur'ly.  That may need to change, depending on the
  34           result of the ZNG list's deliberations.
  35         - Fix the parser to normalise relation modifiers to lower case.
  36         - Fix the CQLParser test harness not to emit an extraneous
  37           blank line at end of XCQL output.
  38         - Fix CQLNode documentation to contain a link to YAZ's
  39           documentation of Prefix Query Format (PQF) rather than
  40           containing a rather unhelpful chunk of BNF.
  41         - Change the test/regression Makefile so that "make clean" now
  42           does what "make distclean" used to do - the distinction
  43           between them is pointless.
  44         - Fix a few typos in the documentation.
  45         - Move the README file's old "THINGS TO DO" section to the end
  46           of this file, the new "Still to do" section.
  47
  48 0.2  Wed Nov  6 23:05:54 2002
  49         - Fix the order of proximity parameters in accordance with the
  50           updated official grammar, which now specifies proximity
  51           operators of the form
  52                 prox/<relation>/<distance>/<unit>/<ordering>
  53           as in ``foo prox/<=/3/sentence bar''.
  54         - Make the necessary parts of the CQLNode class and its
  55           subclasses public.  This means that client code can now walk
  56           through parse-trees and so implement its own back-end
  57           (e.g. to build BER-friendly data structures using whatever
  58           Z39.50 toolkit is preferred.)
  59         - Add the toPQF(Properties p) method to CQLNode and its
  60           subclasses.  This produces a query in YAZ-style Prefix Query
  61           Format, which can be trivially translated into a Z39.50
  62           Type-1 query (see, for example, JZKit's code to do so).
  63         - Add etc/pqf.properties to configure the toPQF() method.
  64         - Add "-p <props-file>" option to the CQLParser test-harness,
  65           indicating that the parsed tree is to be rendered to PQF.
  66         - Add PQFTranslationException and its subclasses
  67           UnknownQualifierException, UnknownRelationException,
  68           UnknownRelationModifierException and
  69           UnknownPositionException.
  70         - Rename ParameterMissingException to MissingParameterException.
  71         - Add javadoc comments for CQLNode and its subclasses.
  72
  73 0.1  Sun Nov  3 20:58:27 2002
  74         - First public release.
  75
  76 --
  77
  78 ### Still to do
  79         - Fix the bug where "9x" is parsed as two tokens, a TT_NUMBER
  80           followed by a TT_WORD.  The problem here is that I don't
  81           think it's actually possible to fix this without throwing
  82           out StreamTokenizer and rolling our own, which we absolutely
  83           _don't_ want to do.
  84         - Find out what the ZNG group finally settled on as the
  85           correct XCQL representation of prefix-mapping, and tweak my
  86           toXCQL() output to match that.
  87         - Add srw.resultSet support to the toPFQ() method.
  88         - Write "overview" file for the javadoc documentation.
  89         - Some niceties for the cql-decompiling back-end:
  90           * Don't emit redundant parentheses.
  91           * Don't put spaces around relations that don't need them.
  92         - Consider the utility of yet another back-end that translates
  93           a CQLNode tree into JZKit's representation of a Type-1 query
  94           tree.  That would be nice so that CQL could become a JZKit
  95           query-type; but you could achieve the same effect by
  96           generating PQF, and running that through JZKit's existing
  97           PQN-to-Type-1 compiler.
  98         - Many refinements to the random query generator:
  99           * Generate relation modifiers
 100           * Proximity support
 101           * Don't always generate qualifier/relation for terms
 102           * Better selection of qualifier (configurable?)
 103           * Better selection of terms (from a dictionary file?)
 104           * Introduce wildcard characters into generated terms
 105           * Generate multi-word terms
 106