Changes

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