X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=src%2Forg%2Fz3950%2Fzing%2Fcql%2FCQLParser.java;h=6117b2312cdd32271c7b3df380f29ee8fc6ffd75;hb=d524fe097f11c7ab8a16ac98e1dedd3a3e24c993;hp=96e67f018dd13ac2faed4481ce1f4976d08c063b;hpb=c77bd4c9ead8ea2dc08e1fadd801a5d01db84a9a;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 96e67f0..6117b23 100644 --- a/src/org/z3950/zing/cql/CQLParser.java +++ b/src/org/z3950/zing/cql/CQLParser.java @@ -1,15 +1,18 @@ -// $Id: CQLParser.java,v 1.13 2002-11-02 01:24:14 mike Exp $ +// $Id: CQLParser.java,v 1.18 2002-11-08 01:10:55 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.13 2002-11-02 01:24:14 mike Exp $ + * @version $Id: CQLParser.java,v 1.18 2002-11-08 01:10:55 mike Exp $ * @see http://zing.z3950.org/cql/index.html */ @@ -23,13 +26,28 @@ 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); lexer.nextToken(); debug("about to parse_query()"); - CQLNode root = parse_query("srw.serverChoice", new CQLRelation("=")); + CQLNode root = parse_query("srw.serverChoice", new CQLRelation("scr")); + // ### "scr" above should arguably be "=" if (lexer.ttype != lexer.TT_EOF) throw new CQLParseException("junk after end: " + lexer.render()); @@ -137,9 +155,9 @@ public class CQLParser { switch (i) { // Order should be: relation/distance/unit/ordering // For now, use MA's: unit/relation/distance/ordering - case 1: gatherProxRelation(node); break; - case 2: gatherProxDistance(node); break; - case 0: gatherProxUnit(node); break; + case 0: gatherProxRelation(node); break; + case 1: gatherProxDistance(node); break; + case 2: gatherProxUnit(node); break; case 3: gatherProxOrdering(node); break; } } @@ -188,7 +206,7 @@ public class CQLParser { match(lexer.ttype); } - boolean isBaseRelation() { + private boolean isBaseRelation() { debug("isBaseRelation: checking ttype=" + lexer.ttype + " (" + lexer.render() + ")"); return (isProxRelation() || @@ -197,7 +215,7 @@ public class CQLParser { lexer.ttype == lexer.TT_EXACT); } - boolean isProxRelation() { + private boolean isProxRelation() { debug("isProxRelation: checking ttype=" + lexer.ttype + " (" + lexer.render() + ")"); return (lexer.ttype == '<' || @@ -222,47 +240,83 @@ public class CQLParser { } - // Test harness. - // - // e.g. echo '(au=Kerninghan or au=Ritchie) and ti=Unix' | - // java org.z3950.zing.cql.CQLParser - // yields: - // - // and - // - // or - // - // au - // = - // Kerninghan - // - // - // au - // = - // Ritchie - // - // - // - // ti - // = - // Unix - // - // - // + /** + * Simple test-harness for the CQLParser class. + *

+ * 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) { - boolean canonicalise = false; + 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")) { - canonicalise = true; + 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] []"); + System.err.println( + "Usage: CQLParser [-c] [-p []"); System.err.println("If unspecified, query is read from stdin"); System.exit(1); } @@ -275,7 +329,7 @@ public class CQLParser { try { // Read in the whole of standard input in one go int nbytes = System.in.read(bytes); - } catch (java.io.IOException ex) { + } catch (IOException ex) { System.err.println("Can't read query: " + ex.getMessage()); System.exit(2); } @@ -283,21 +337,51 @@ public class CQLParser { } CQLParser parser = new CQLParser(); - CQLNode root; + CQLNode root = null; try { root = parser.parse(cql); - debug("root='" + root + "'"); - if (canonicalise) { - System.out.println(root.toCQL()); - } else { - System.out.print(root.toXCQL(0)); - } } catch (CQLParseException ex) { System.err.println("Syntax error: " + ex.getMessage()); System.exit(3); - } catch (java.io.IOException ex) { + } catch (IOException ex) { System.err.println("Can't compile query: " + ex.getMessage()); System.exit(4); } + + try { + if (mode == 'c') { + System.out.println(root.toCQL()); + } else if (mode == 'p') { + InputStream f = new FileInputStream(pfile); + if (f == null) + throw new FileNotFoundException(pfile); + + Properties config = new Properties(); + config.load(f); + f.close(); + System.out.println(root.toPQF(config)); + } else { + System.out.print(root.toXCQL(0)); + } + } catch (IOException ex) { + System.err.println("Can't render query: " + ex.getMessage()); + System.exit(5); + } catch (UnknownQualifierException ex) { + System.err.println("Unknown qualifier: " + ex.getMessage()); + System.exit(6); + } catch (UnknownRelationException ex) { + System.err.println("Unknown relation: " + ex.getMessage()); + System.exit(7); + } catch (UnknownRelationModifierException ex) { + System.err.println("Unknown relation modifier: " + + ex.getMessage()); + System.exit(8); + } catch (UnknownPositionException ex) { + System.err.println("Unknown position: " + ex.getMessage()); + System.exit(9); + } catch (PQFTranslationException ex) { + // We catch all of this class's subclasses, so -- + throw new Error("can't get a PQFTranslationException"); + } } }