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