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