Changes

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