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