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