Changes

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