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