- Add support for the new "phonetic" relation modifier,
[cql-java-moved-to-github.git] / Changes
1 $Id: Changes,v 1.13 2002-11-17 23:29:02 mike Exp $
2
3 Revision history for "cql-java"
4 See the bottom of this file for a list of things still to do.
5
6 0.4  (IN PROGRESS)
7         - Add support for the new "phonetic" relation modifier,
8           including its mapping in "etc/pqf.properties".
9         - Make prefix-maps bind loosely, so that ``>dc=x a and b''
10           applies the dc=x binding to both the ``a'' and ``b''
11           sub-queries.
12         - Change build process so that javadoc documentation is built
13           by "make" in the "docs" directory.
14         - Write javadoc comments for CQLRelation and ModifierSet.
15         - Other improvements to javadoc comments (e.g. describe the
16           `config' parameter to the toPQF() method.)
17
18 0.3  Fri Nov 15 12:04:04 2002
19         - Allow keywords to be used unquoted as search terms.
20         - Add support for serverChoiceRelation (scr).
21         - Add support for prefix-mapping, as in
22                 >dc="http://dublincore.org/ dc.title=fish
23           and
24                 >"http://dublincore.org/ title=fish
25           The XCQL generated corresponds to Adam's suggested format
26           rather than Rob's, not so much because I prefer it (although
27           I do) as because it's what fell out when I just Coded What
28           Comes Natur'ly.  That may need to change, depending on the
29           result of the ZNG list's deliberations.
30         - Fix the parser to normalise relation modifiers to lower case.
31         - Fix the CQLParser test harness not to emit an extraneous
32           blank line at end of XCQL output.
33         - Fix CQLNode documentation to contain a link to YAZ's
34           documentation of Prefix Query Format (PQF) rather than
35           containing a rather unhelpful chunk of BNF.
36         - Change the test/regression Makefile so that "make clean" now
37           does what "make distclean" used to do - the distinction
38           between them is pointless.
39         - Fix a few typos in the documentation.
40         - Move the README file's old "THINGS TO DO" section to the end
41           of this file, the new "Still to do" section.
42
43 0.2  Wed Nov  6 23:05:54 2002
44         - Fix the order of proximity parameters in accordance with the
45           updated official grammar, which now specifies proximity
46           operators of the form
47                 prox/<relation>/<distance>/<unit>/<ordering>
48           as in ``foo prox/<=/3/sentence bar''.
49         - Make the necessary parts of the CQLNode class and its
50           subclasses public.  This means that client code can now walk
51           through parse-trees and so implement its own back-end
52           (e.g. to build BER-friendly data structures using whatever
53           Z39.50 toolkit is preferred.)
54         - Add the toPQF(Properties p) method to CQLNode and its
55           subclasses.  This produces a query in YAZ-style Prefix Query
56           Format, which can be trivially translated into a Z39.50
57           Type-1 query (see, for example, JZKit's code to do so).
58         - Add etc/pqf.properties to configure the toPQF() method.
59         - Add "-p <props-file>" option to the CQLParser test-harness,
60           indicating that the parsed tree is to be rendered to PQF.
61         - Add PQFTranslationException and its subclasses
62           UnknownQualifierException, UnknownRelationException,
63           UnknownRelationModifierException and
64           UnknownPositionException.
65         - Rename ParameterMissingException to MissingParameterException.
66         - Add javadoc comments for CQLNode and its subclasses.
67
68 0.1  Sun Nov  3 20:58:27 2002
69         - First public release.
70
71 --
72
73 ### Still to do
74         - Fix the bug where "9x" is parsed as two tokens, a TT_NUMBER
75           followed by a TT_WORD.  The problem here is that I don't
76           think it's actually possible to fix this without throwing
77           out StreamTokenizer and rolling our own, which we absolutely
78           _don't_ want to do.
79         - Find out what the ZNG group finally settled on as the
80           correct XCQL representation of prefix-mapping, and tweak my
81           toXCQL() output to match that.
82         - Add srw.resultSet support to the toPFQ() method.
83         - Write "overview" file for the javadoc documentation.
84         - Some niceties for the cql-decompiling back-end:
85           * Don't emit redundant parentheses.
86           * Don't put spaces around relations that don't need them.
87         - Consider the utility of yet another back-end that translates
88           a CQLNode tree into JZKit's representation of a Type-1 query
89           tree.  That would be nice so that CQL could become a JZKit
90           query-type; but you could achieve the same effect by
91           generating PQF, and running that through JZKit's existing
92           PQN-to-Type-1 compiler.
93         - Many refinements to the random query generator:
94           * Generate relation modifiers
95           * Proximity support
96           * Don't always generate qualifier/relation for terms
97           * Better selection of qualifier (configurable?)
98           * Better selection of terms (from a dictionary file?)
99           * Introduce wildcard characters into generated terms
100           * Generate multi-word terms
101