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