Changes

   1 $Id: Changes,v 1.46 2008-05-28 10:03:53 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 The work for releases 1.0, 1.2 and 1.2.1 was sponsored by the National
   7 Library of Australia, whose help we gratefully acknowledge.
   8
   9 1.5  Tue May 25 16:44:35 CEST 2010
  10         - Fix recognition of word-relations to correctly match what is
  11           specified in the CQL v1.1 and v1.2 documents.  In
  12           particular, "encloses" and "within" are recognised, so that
  13           Masterkey's use of "encloses" for IP range authentication
  14           works again.
  15         - Update regression tests accordingly.
  16         - Extend test/random/ to emit summary line of successful
  17           recompilations.
  18
  19 1.4  Thu May 20 00:38:40 BST 2010
  20         - Add support for interpreting sequences of non-keywords as a
  21           single multi-word term rather than a broken INDEX RELATION
  22           TERM triplet.  This means that "oxford street" is a valid
  23           query rather than a syntax error, and "tottenham court road"
  24           is what it looks like rather than a search for the word
  25           "court" related by the relation "court" to the index
  26           "tottenham".  Note that the word-formed relations "any",
  27           "all", "exact" and (for CQL v1.2) "scr" are still treated
  28           specially, as are profiled relations in context sets, of the
  29           form <set>.<name>.
  30
  31 1.3  Wed May 28 11:02:00 BST 2008
  32         - Add getSortIndexes() to CQLSortNode, as suggested by Marcel
  33           Versteeg <Marcel.Versteeg@KB.nl>
  34
  35 1.2.1  Mon Aug  6 16:54:54 BST 2007
  36         - Contructors for the CQLParser class are made public (as they
  37           should have been all along).
  38
  39 1.2  Tue Jul  3 17:53:28 BST 2007
  40         - Support for CQL version 1.2 as described at
  41                 http://www.loc.gov/standards/sru/next-version.html
  42           The most significant part of the v1.2 change is support for
  43           sorting, but as of this writing (29th June) the official SRU
  44           maintenance agency web site at
  45                 http://www.loc.gov/standards/sru/index.html
  46           does not include any specification for CQL sorting.
  47           Therefore the original proposal at
  48                 http://zing.z3950.org/cql/sorting.html
  49           is still considered canonical.
  50
  51 1.0 Fri Jun 29 14:10:28 BST 2007
  52         - Support for version 1.1 as described at
  53                 http://www.loc.gov/standards/sru/specs/cql.html
  54           Since this is a significant leap forward, the version
  55           numbering increases to the next major version.
  56         - "Qualifiers" renamed as "indexes" throughout, to match what
  57           is now universal CQL terminology.
  58
  59         PLEASE NOTE THE FOLLOWING INCOMPATIBLE API CHANGES
  60         - The class UnknownQualifierException is replaced by
  61           UnknownIndexException.
  62         - The CQLTermNode method getQualifier() is replaced by
  63           getIndex().
  64
  65 0.7  Thu Sep  4 22:51:11 2003
  66         - Support for profiled relations and relation modifiers:
  67           recognise any non-key word as a relation or modifier,
  68           rejecting those that are not of the form <prefix>.<name>
  69           since these must be explicitly tied to a "context" (what
  70           used to be called a qualifier-set or index-set).
  71
  72 0.6  Tue Jul 29 23:33:56 2003
  73         - Include Ralph's fix for CQLTermNode::toType1BER() to prevent
  74           it surrounding multi-word terms in quotes when encoded into
  75           BER packet.
  76
  77 0.5  Wed Feb  5 15:50:57 2003
  78         - Add an extra back-end method,
  79                 byte[] toType1BER(Properties config)
  80           which generates an opaque BER-encoded PDU suitable for
  81           forwarding to Z39.50 server as a pasrt of a searchRequest
  82           APDU.  This was contributed by Ralph Levan <levan@oclc.org>
  83         - Add srw.resultSet support to the toPFQ() method.
  84         - Add new resultSetName() method to CQLNode and its
  85           subclasses, returning the name of the referenced result-set
  86           for a node that is just a result-set reference, and null for
  87           anything else.
  88         - Change regression-test rules for Adam's compiler to use his
  89           new front-end cql2xcql instead of the old cqlparse3.
  90         - Change the names of the anchoring properties in
  91           etc/pqf.properties and the CQLTermNode code that examines
  92           them, in accordance with Adam's PQF-renderer's behaviour.
  93           This gives more flexibility in terms of generating
  94           attributes for end-of-field anchoring.  Various other minor
  95           tweaks to the pqf.properties file, mostly to the comments.
  96         - Change the capitalisation of the project name from
  97           "cql-java" to "CQL-Java".  That doesn't really make any
  98           difference to anything: in particular, file-names such as
  99           "cql-java.jar" remain the same.
 100
 101 0.4  Thu Nov 21 10:09:26 2002
 102         - Add support for the new "phonetic" relation modifier,
 103           including its mapping in "etc/pqf.properties".
 104         - Make prefix-maps bind loosely, so that ``>dc=x a and b''
 105           applies the dc=x binding to both the ``a'' and ``b''
 106           sub-queries.
 107         - Change the XCQL output to include the nasty (but official)
 108           <leftOperand> and <rightOperand> wrapper elements.
 109         - Change the XCQL output to use the nasty (but official)
 110           rendition of prefix-mapping: a <prefixes> element,
 111           containing one of more <prefix>es may appear at the top
 112           of either a <searchClause> or a <triple>.
 113         - Include test/regression/xmlpp.pl in the distribution: this
 114           may now be used for testing whether a CQL compiler produces
 115           _equivalent_ XCQL to what's in the regression test, rather
 116           than requiring byte-identical output.
 117         - Include the reference XCQL output in the distribution, for
 118           the regression test suite to run against.
 119         - Change build process so that javadoc documentation is built
 120           by "make" in the "docs" directory.  There's now a top-level
 121           makefile that builds the source, runs the test suite and
 122           creates the documentation.
 123         - Write javadoc comments for CQLRelation and ModifierSet.
 124         - Other improvements to javadoc comments (e.g. describe the
 125           `config' parameter to the toPQF() method.)
 126         - Sort out the licence: I've settled on the LGPL.
 127         - Remove the redundant and misleading etc/Grammar file.
 128         - Fix up various Maintenance Agency web addresses that have
 129           moved in the great ZING-release shake-up.
 130
 131 0.3  Fri Nov 15 12:04:04 2002
 132         - Allow keywords to be used unquoted as search terms.
 133         - Add support for serverChoiceRelation (scr).
 134         - Add support for prefix-mapping, as in
 135                 >dc="http://www.loc.gov/zing/cql/dc-indexes/" dc.title=fish
 136           and
 137                 >"http://www.loc.gov/zing/cql/dc-indexes/" dc.title=fish
 138           The XCQL generated corresponds to Adam's suggested format
 139           rather than Rob's, not so much because I prefer it (although
 140           I do) as because it's what fell out when I just Coded What
 141           Comes Natur'ly.  That may need to change, depending on the
 142           result of the ZNG list's deliberations.
 143         - Fix the parser to normalise relation modifiers to lower case.
 144         - Fix the CQLParser test harness not to emit an extraneous
 145           blank line at end of XCQL output.
 146         - Fix CQLNode documentation to contain a link to YAZ's
 147           documentation of Prefix Query Format (PQF) rather than
 148           containing a rather unhelpful chunk of BNF.
 149         - Change the test/regression Makefile so that "make clean" now
 150           does what "make distclean" used to do - the distinction
 151           between them is pointless.
 152         - Fix a few typos in the documentation.
 153         - Move the README file's old "THINGS TO DO" section to the end
 154           of this file, the new "Still to do" section.
 155
 156 0.2  Wed Nov  6 23:05:54 2002
 157         - Fix the order of proximity parameters in accordance with the
 158           updated official grammar, which now specifies proximity
 159           operators of the form
 160                 prox/<relation>/<distance>/<unit>/<ordering>
 161           as in ``foo prox/<=/3/sentence bar''.
 162         - Make the necessary parts of the CQLNode class and its
 163           subclasses public.  This means that client code can now walk
 164           through parse-trees and so implement its own back-end
 165           (e.g. to build BER-friendly data structures using whatever
 166           Z39.50 toolkit is preferred.)
 167         - Add the toPQF(Properties p) method to CQLNode and its
 168           subclasses.  This produces a query in YAZ-style Prefix Query
 169           Format, which can be trivially translated into a Z39.50
 170           Type-1 query (see, for example, JZKit's code to do so).
 171         - Add etc/pqf.properties to configure the toPQF() method.
 172         - Add "-p <props-file>" option to the CQLParser test-harness,
 173           indicating that the parsed tree is to be rendered to PQF.
 174         - Add PQFTranslationException and its subclasses
 175           UnknownQualifierException, UnknownRelationException,
 176           UnknownRelationModifierException and
 177           UnknownPositionException.
 178         - Rename ParameterMissingException to MissingParameterException.
 179         - Add javadoc comments for CQLNode and its subclasses.
 180
 181 0.1  Sun Nov  3 20:58:27 2002
 182         - First public release.
 183
 184 --
 185
 186 ### Still to do
 187         - Test-harness option to use Type1 BER back-end.
 188         - Case-insensitive matching for serverChoice and any other
 189           special-case qualifiers.  (Are the configured qualifiers
 190           matched case-insensitively?  They should be.)
 191         - Prefix-aware matching for serverChoice, so that
 192           >x="http://www.loc.gov/zing/srw/dc-indexes/v1.0/" x.resultSet=foo
 193           does the right thing.
 194         - Extend test-suite for PQF and BER renderers.
 195         - Additional test-suite entries for things like
 196           case-sensitivity.
 197         - Add a new configuration file that allows arbitrary new
 198           relations and relation modifiers to be defined.
 199         - Fix the bug where "9x" is parsed as two tokens, a TT_NUMBER
 200           followed by a TT_WORD.  The problem here is that I don't
 201           think it's actually possible to fix this without throwing
 202           out StreamTokenizer and rolling our own, which we absolutely
 203         - Fix term-to-PQF translation to omit empty properties
 204           (for the broken Korean server)
 205         - Write "package.html" file for the javadoc documentation.
 206         - Some niceties for the cql-decompiling back-end:
 207           * Don't emit redundant parentheses.
 208           * Don't put spaces around relations that don't need them.
 209         - Many refinements to the random query generator:
 210           * Generate relation modifiers
 211           * Proximity support
 212           * Don't always generate qualifier/relation for terms
 213           * Better selection of qualifier (configurable?)
 214           * Better selection of terms (from a dictionary file?)
 215           * Introduce wildcard characters into generated terms
 216           * Generate multi-word terms
 217           * Generate prefix-mappings
 218
 219