Changes

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