Changes

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