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