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