Changes

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