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