Changes

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