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