Changes

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