Changes

   1 $Id: Changes,v 1.29 2002-12-13 17:46:52 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, currently at RC2)
   7         - Add an extra back-end method,
   8                 byte[] toType1BER(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         - Add srw.resultSet support to the toPFQ() method.
  13         - Add new resultSetName() method to CQLNode and its
  14           subclasses, returning the name of the referenced result-set
  15           for a node that is just a result-set reference, and null for
  16           anything else.
  17         - Change regression-test rules for Adam's compiler to use his
  18           new front-end cql2xcql instead of the old cqlparse3.
  19         - Change the names of the anchoring properties in
  20           etc/pqf.properties and the CQLTermNode code that examines
  21           them, in accordance with Adam's PQF-renderer's behaviour.
  22           This gives more flexibility in terms of generating
  23           attributes for end-of-field anchoring.  Various other minor
  24           tweaks to the pqf.properties file, mostly to the comments.
  25         - Change the capitalisation of the project name from
  26           "cql-java" to "CQL-Java".  That doesn't really make any
  27           difference to anything: in particular, file-names such as
  28           "cql-java.jar" remain the same.
  29
  30 0.4  Thu Nov 21 10:09:26 2002
  31         - Add support for the new "phonetic" relation modifier,
  32           including its mapping in "etc/pqf.properties".
  33         - Make prefix-maps bind loosely, so that ``>dc=x a and b''
  34           applies the dc=x binding to both the ``a'' and ``b''
  35           sub-queries.
  36         - Change the XCQL output to include the nasty (but official)
  37           <leftOperand> and <rightOperand> wrapper elements.
  38         - Change the XCQL output to use the nasty (but official)
  39           rendition of prefix-mapping: a <prefixes> element,
  40           containing one of more <prefix>es may appear at the top
  41           of either a <searchClause> or a <triple>.
  42         - Include test/regression/xmlpp.pl in the distribution: this
  43           may now be used for testing whether a CQL compiler produces
  44           _equivalent_ XCQL to what's in the regression test, rather
  45           than requiring byte-identical output.
  46         - Include the reference XCQL output in the distribution, for
  47           the regression test suite to run against.
  48         - Change build process so that javadoc documentation is built
  49           by "make" in the "docs" directory.  There's now a top-level
  50           makefile that builds the source, runs the test suite and
  51           creates the documentation.
  52         - Write javadoc comments for CQLRelation and ModifierSet.
  53         - Other improvements to javadoc comments (e.g. describe the
  54           `config' parameter to the toPQF() method.)
  55         - Sort out the licence: I've settled on the LGPL.
  56         - Remove the redundant and misleading etc/Grammar file.
  57         - Fix up various Maintenance Agency web addresses that have
  58           moved in the great ZING-release shake-up.
  59
  60 0.3  Fri Nov 15 12:04:04 2002
  61         - Allow keywords to be used unquoted as search terms.
  62         - Add support for serverChoiceRelation (scr).
  63         - Add support for prefix-mapping, as in
  64                 >dc="http://www.loc.gov/zing/cql/dc-indexes/" dc.title=fish
  65           and
  66                 >"http://www.loc.gov/zing/cql/dc-indexes/" dc.title=fish
  67           The XCQL generated corresponds to Adam's suggested format
  68           rather than Rob's, not so much because I prefer it (although
  69           I do) as because it's what fell out when I just Coded What
  70           Comes Natur'ly.  That may need to change, depending on the
  71           result of the ZNG list's deliberations.
  72         - Fix the parser to normalise relation modifiers to lower case.
  73         - Fix the CQLParser test harness not to emit an extraneous
  74           blank line at end of XCQL output.
  75         - Fix CQLNode documentation to contain a link to YAZ's
  76           documentation of Prefix Query Format (PQF) rather than
  77           containing a rather unhelpful chunk of BNF.
  78         - Change the test/regression Makefile so that "make clean" now
  79           does what "make distclean" used to do - the distinction
  80           between them is pointless.
  81         - Fix a few typos in the documentation.
  82         - Move the README file's old "THINGS TO DO" section to the end
  83           of this file, the new "Still to do" section.
  84
  85 0.2  Wed Nov  6 23:05:54 2002
  86         - Fix the order of proximity parameters in accordance with the
  87           updated official grammar, which now specifies proximity
  88           operators of the form
  89                 prox/<relation>/<distance>/<unit>/<ordering>
  90           as in ``foo prox/<=/3/sentence bar''.
  91         - Make the necessary parts of the CQLNode class and its
  92           subclasses public.  This means that client code can now walk
  93           through parse-trees and so implement its own back-end
  94           (e.g. to build BER-friendly data structures using whatever
  95           Z39.50 toolkit is preferred.)
  96         - Add the toPQF(Properties p) method to CQLNode and its
  97           subclasses.  This produces a query in YAZ-style Prefix Query
  98           Format, which can be trivially translated into a Z39.50
  99           Type-1 query (see, for example, JZKit's code to do so).
 100         - Add etc/pqf.properties to configure the toPQF() method.
 101         - Add "-p <props-file>" option to the CQLParser test-harness,
 102           indicating that the parsed tree is to be rendered to PQF.
 103         - Add PQFTranslationException and its subclasses
 104           UnknownQualifierException, UnknownRelationException,
 105           UnknownRelationModifierException and
 106           UnknownPositionException.
 107         - Rename ParameterMissingException to MissingParameterException.
 108         - Add javadoc comments for CQLNode and its subclasses.
 109
 110 0.1  Sun Nov  3 20:58:27 2002
 111         - First public release.
 112
 113 --
 114
 115 ### Still to do
 116         - Test-harness option to use Type1 BER back-end.
 117         - Case-insensitive matching for serverChoice and any other
 118           special-case qualifiers.  (Are the configured qualifiers
 119           matched case-insensitively?  They should be.)
 120         - Prefix-aware matching for serverChoice, so that
 121           >x="http://www.loc.gov/zing/srw/dc-indexes/v1.0/" x.resultSet=foo
 122           does the right thing.
 123         - Extend test-suite for PQF and BER renderers.
 124         - Additional test-suite entries for things like
 125           case-sensitivity.
 126         - Add a new configuration file that allows arbitrary new
 127           relations and relation modifiers to be defined.
 128         - Fix the bug where "9x" is parsed as two tokens, a TT_NUMBER
 129           followed by a TT_WORD.  The problem here is that I don't
 130           think it's actually possible to fix this without throwing
 131           out StreamTokenizer and rolling our own, which we absolutely
 132         - Fix term-to-PQF translation to omit empty properties
 133           (for the broken Korean server)
 134         - Write "package.html" file for the javadoc documentation.
 135         - Some niceties for the cql-decompiling back-end:
 136           * Don't emit redundant parentheses.
 137           * Don't put spaces around relations that don't need them.
 138         - Many refinements to the random query generator:
 139           * Generate relation modifiers
 140           * Proximity support
 141           * Don't always generate qualifier/relation for terms
 142           * Better selection of qualifier (configurable?)
 143           * Better selection of terms (from a dictionary file?)
 144           * Introduce wildcard characters into generated terms
 145           * Generate multi-word terms
 146           * Generate prefix-mappings
 147
 148