X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=src%2Forg%2Fz3950%2Fzing%2Fcql%2FCQLParser.java;h=a365030cde740d62751779c82f31bc644e866ccf;hb=fc82b225d39cc66cb85c2557db0c0d4a4c5a6e27;hp=e463576d702e9f515eb3d760b290f1a515cc0a31;hpb=70be8275aabe87c909bf11148bb279c3e1380bb2;p=cql-java-moved-to-github.git diff --git a/src/org/z3950/zing/cql/CQLParser.java b/src/org/z3950/zing/cql/CQLParser.java index e463576..a365030 100644 --- a/src/org/z3950/zing/cql/CQLParser.java +++ b/src/org/z3950/zing/cql/CQLParser.java @@ -1,14 +1,18 @@ -// $Id: CQLParser.java,v 1.10 2002-10-30 09:19:26 mike Exp $ +// $Id: CQLParser.java,v 1.16 2002-11-06 20:13:45 mike Exp $ package org.z3950.zing.cql; import java.io.IOException; +import java.util.Vector; +import java.util.Properties; +import java.io.InputStream; +import java.io.FileInputStream; +import java.io.FileNotFoundException; /** - * Compiles a CQL string into a parse tree. - * ### + * Compiles CQL strings into parse trees of CQLNode subtypes. * - * @version $Id: CQLParser.java,v 1.10 2002-10-30 09:19:26 mike Exp $ + * @version $Id: CQLParser.java,v 1.16 2002-11-06 20:13:45 mike Exp $ * @see http://zing.z3950.org/cql/index.html */ @@ -22,6 +26,20 @@ public class CQLParser { System.err.println("PARSEDEBUG: " + str); } + /** + * Compiles a CQL query. + *
+ * The resulting parse tree may be further processed by hand (see
+ * the individual node-types' documentation for details on the
+ * data structure) or, more often, simply rendered out in the
+ * desired form using one of the back-ends. toCQL()
+ * returns a decompiled CQL query equivalent to the one that was
+ * compiled in the first place; and toXCQL() returns an
+ * XML snippet representing the query.
+ *
+ * @param cql The query
+ * @return A CQLNode object which is the root of a parse
+ * tree representing the query. */
public CQLNode parse(String cql)
throws CQLParseException, IOException {
lexer = new CQLLexer(cql, LEXDEBUG);
@@ -55,7 +73,12 @@ public class CQLParser {
CQLNode term2 = parse_term(qualifier, relation);
term = new CQLNotNode(term, term2);
} else if (lexer.ttype == lexer.TT_PROX) {
- // ### Handle "prox"
+ match(lexer.TT_PROX);
+ CQLProxNode proxnode = new CQLProxNode(term);
+ gatherProxParameters(proxnode);
+ CQLNode term2 = parse_term(qualifier, relation);
+ proxnode.addSecondSubterm(term2);
+ term = (CQLNode) proxnode;
} else {
throw new CQLParseException("expected boolean, got " +
lexer.render());
@@ -78,13 +101,19 @@ public class CQLParser {
CQLNode expr = parse_query(qualifier, relation);
match(')');
return expr;
- } else if (lexer.ttype != lexer.TT_WORD && lexer.ttype != '"') {
+ } else if (lexer.ttype != lexer.TT_WORD &&
+ lexer.ttype != lexer.TT_NUMBER &&
+ lexer.ttype != '"') {
throw new CQLParseException("expected qualifier or term, " +
"got " + lexer.render());
}
debug("non-parenthesised term");
- word = lexer.sval;
+ if (lexer.ttype == lexer.TT_NUMBER) {
+ word = lexer.render();
+ } else {
+ word = lexer.sval;
+ }
match(lexer.ttype);
if (!isBaseRelation())
break;
@@ -95,12 +124,13 @@ public class CQLParser {
while (lexer.ttype == '/') {
match('/');
- // ### could insist on known modifiers only
- if (lexer.ttype != lexer.TT_WORD)
+ if (lexer.ttype != lexer.TT_RELEVANT &&
+ lexer.ttype != lexer.TT_FUZZY &&
+ lexer.ttype != lexer.TT_STEM)
throw new CQLParseException("expected relation modifier, "
+ "got " + lexer.render());
relation.addModifier(lexer.sval);
- match(lexer.TT_WORD);
+ match(lexer.ttype);
}
debug("qualifier='" + qualifier + ", " +
@@ -112,18 +142,87 @@ public class CQLParser {
return node;
}
- boolean isBaseRelation() {
+ private void gatherProxParameters(CQLProxNode node)
+ throws CQLParseException, IOException {
+ for (int i = 0; i < 4; i++) {
+ if (lexer.ttype != '/')
+ return; // end of proximity parameters
+
+ match('/');
+ if (lexer.ttype != '/') {
+ // not an omitted default
+ switch (i) {
+ // Order should be: relation/distance/unit/ordering
+ // For now, use MA's: unit/relation/distance/ordering
+ case 0: gatherProxRelation(node); break;
+ case 1: gatherProxDistance(node); break;
+ case 2: gatherProxUnit(node); break;
+ case 3: gatherProxOrdering(node); break;
+ }
+ }
+ }
+ }
+
+ private void gatherProxRelation(CQLProxNode node)
+ throws CQLParseException, IOException {
+ if (!isProxRelation())
+ throw new CQLParseException("expected proximity relation, got " +
+ lexer.render());
+ node.addModifier("relation", lexer.render(lexer.ttype, false));
+ match(lexer.ttype);
+ debug("gPR matched " + lexer.render(lexer.ttype, false));
+ }
+
+ private void gatherProxDistance(CQLProxNode node)
+ throws CQLParseException, IOException {
+ if (lexer.ttype != lexer.TT_NUMBER)
+ throw new CQLParseException("expected proximity distance, got " +
+ lexer.render());
+ node.addModifier("distance", lexer.render(lexer.ttype, false));
+ match(lexer.ttype);
+ debug("gPD matched " + lexer.render(lexer.ttype, false));
+ }
+
+ private void gatherProxUnit(CQLProxNode node)
+ throws CQLParseException, IOException {
+ if (lexer.ttype != lexer.TT_pWORD &&
+ lexer.ttype != lexer.TT_SENTENCE &&
+ lexer.ttype != lexer.TT_PARAGRAPH &&
+ lexer.ttype != lexer.TT_ELEMENT)
+ throw new CQLParseException("expected proximity unit, got " +
+ lexer.render());
+ node.addModifier("unit", lexer.render());
+ match(lexer.ttype);
+ }
+
+ private void gatherProxOrdering(CQLProxNode node)
+ throws CQLParseException, IOException {
+ if (lexer.ttype != lexer.TT_ORDERED &&
+ lexer.ttype != lexer.TT_UNORDERED)
+ throw new CQLParseException("expected proximity ordering, got " +
+ lexer.render());
+ node.addModifier("ordering", lexer.render());
+ match(lexer.ttype);
+ }
+
+ private boolean isBaseRelation() {
debug("isBaseRelation: checking ttype=" + lexer.ttype +
" (" + lexer.render() + ")");
+ return (isProxRelation() ||
+ lexer.ttype == lexer.TT_ANY ||
+ lexer.ttype == lexer.TT_ALL ||
+ lexer.ttype == lexer.TT_EXACT);
+ }
+
+ private boolean isProxRelation() {
+ debug("isProxRelation: checking ttype=" + lexer.ttype +
+ " (" + lexer.render() + ")");
return (lexer.ttype == '<' ||
lexer.ttype == '>' ||
lexer.ttype == '=' ||
lexer.ttype == lexer.TT_LE ||
lexer.ttype == lexer.TT_GE ||
- lexer.ttype == lexer.TT_NE ||
- lexer.ttype == lexer.TT_ANY ||
- lexer.ttype == lexer.TT_ALL ||
- lexer.ttype == lexer.TT_EXACT);
+ lexer.ttype == lexer.TT_NE);
}
private void match(int token)
@@ -140,60 +239,148 @@ public class CQLParser {
}
- // Test harness.
- //
- // e.g. echo '(au=Kerninghan or au=Ritchie) and ti=Unix' |
- // java org.z3950.zing.cql.CQLParser
- // yields:
- //
+ * Reads a CQL query either from its command-line argument, if + * there is one, or standard input otherwise. So these two + * invocations are equivalent: + *
+ * CQLParser 'au=(Kerninghan or Ritchie) and ti=Unix' + * echo au=(Kerninghan or Ritchie) and ti=Unix | CQLParser + *+ * The test-harness parses the supplied query and renders is as + * XCQL, so that both of the invocations above produce the + * following output: + *
+ * <triple> + * <boolean> + * <value>and</value> + * </boolean> + * <triple> + * <boolean> + * <value>or</value> + * </boolean> + * <searchClause> + * <index>au</index> + * <relation> + * <value>=</value> + * </relation> + * <term>Kerninghan</term> + * </searchClause> + * <searchClause> + * <index>au</index> + * <relation> + * <value>=</value> + * </relation> + * <term>Ritchie</term> + * </searchClause> + * </triple> + * <searchClause> + * <index>ti</index> + * <relation> + * <value>=</value> + * </relation> + * <term>Unix</term> + * </searchClause> + * </triple> + *+ *
+ * @param -c
+ * Causes the output to be written in CQL rather than XCQL - that
+ * is, a query equivalent to that which was input, is output. In
+ * effect, the test harness acts as a query canonicaliser.
+ * @return
+ * The input query, either as XCQL [default] or CQL [if the
+ * -c option is supplied].
+ */
public static void main (String[] args) {
- if (args.length != 0) {
- System.err.println("Usage: " + args[0]);
+ char mode = 'x'; // x=XCQL, c=CQL, p=PQF
+ String pfile = null;
+
+ Vector argv = new Vector();
+ for (int i = 0; i < args.length; i++) {
+ argv.add(args[i]);
+ }
+
+ if (argv.size() > 0 && argv.get(0).equals("-c")) {
+ mode = 'c';
+ argv.remove(0);
+ } else if (argv.size() > 1 && argv.get(0).equals("-p")) {
+ mode = 'p';
+ argv.remove(0);
+ pfile = (String) argv.get(0);
+ argv.remove(0);
+ }
+
+ if (argv.size() > 1) {
+ System.err.println(
+ "Usage: CQLParser [-c] [-p