src/org/z3950/zing/cql/CQLTermNode.java

   1 // $Id: CQLTermNode.java,v 1.8 2002-11-06 20:13:45 mike Exp $
   2
   3 package org.z3950.zing.cql;
   4 import java.util.Properties;
   5 import java.util.Vector;
   6
   7
   8 /**
   9  * Represents a terminal node in a CQL parse-tree.
  10  * A term node consists of the term String itself, together with,
  11  * optionally, a qualifier string and a relation.  Neither or both of
  12  * these must be provided - you can't have a qualifier without a
  13  * relation or vice versa.
  14  *
  15  * @version     $Id: CQLTermNode.java,v 1.8 2002-11-06 20:13:45 mike Exp $
  16  */
  17 public class CQLTermNode extends CQLNode {
  18     private String qualifier;
  19     private CQLRelation relation;
  20     private String term;
  21
  22     /**
  23      * Creates a new term node with the specified <TT>qualifier</TT>,
  24      * <TT>relation</TT> and <TT>term</TT>.  The first two may be
  25      * <TT>null</TT>, but the <TT>term</TT> may not.
  26      */
  27     public CQLTermNode(String qualifier, CQLRelation relation, String term) {
  28         this.qualifier = qualifier;
  29         this.relation = relation;
  30         this.term = term;
  31     }
  32
  33     public String getQualifier() { return qualifier; }
  34     public CQLRelation getRelation() { return relation; }
  35     public String getTerm() { return term; }
  36
  37     public String toXCQL(int level) {
  38         return (indent(level) + "<searchClause>\n" +
  39                 indent(level+1) + "<index>" + xq(qualifier) + "</index>\n" +
  40                 relation.toXCQL(level+1) +
  41                 indent(level+1) + "<term>" + xq(term) + "</term>\n" +
  42                 indent(level) + "</searchClause>\n");
  43     }
  44
  45     public String toCQL() {
  46         String quotedQualifier = maybeQuote(qualifier);
  47         String quotedTerm = maybeQuote(term);
  48         String res = quotedTerm;
  49
  50         if (!qualifier.equalsIgnoreCase("srw.serverChoice")) {
  51             // ### We don't always need spaces around `relation'.
  52             res = quotedQualifier + " " + relation.toCQL() + " " + quotedTerm;
  53         }
  54
  55         return res;
  56     }
  57
  58     public String toPQF(Properties config) throws PQFTranslationException {
  59         Vector attrs = new Vector();
  60
  61         String attr;
  62         attr = config.getProperty("qualifier." + qualifier);
  63         if (attr == null)
  64             throw new UnknownQualifierException(qualifier);
  65         attrs.add(attr);
  66
  67         String rel = relation.getBase();
  68         if (rel.equals("=")) {
  69             rel = "eq";
  70         } else if (rel.equals("<=")) {
  71             rel = "le";
  72         } else if (rel.equals(">=")) {
  73             rel = "ge";
  74         }
  75         // ### Handling "any" and "all" properly would involve breaking
  76         // the string down into a bunch of individual words and ORring
  77         // or ANDing them together.  Another day.
  78         attr = config.getProperty("relation." + rel);
  79         if (attr == null)
  80             throw new UnknownRelationException(rel);
  81         attrs.add(attr);
  82
  83         String[] mods = relation.getModifiers();
  84         for (int i = 0; i < mods.length; i++) {
  85             attr = config.getProperty("relationModifier." + mods[i]);
  86             if (attr == null)
  87                 throw new UnknownRelationModifierException(mods[i]);
  88             attrs.add(attr);
  89         }
  90
  91         String pos = "unanchored";
  92         String text = term;
  93         if (text.length() > 0 && text.substring(0, 1).equals("^")) {
  94             text = text.substring(1);
  95             pos = "anchored";
  96         }
  97         attr = config.getProperty("position." + pos);
  98         if (attr == null)
  99             throw new UnknownPositionException(pos);
 100         attrs.add(attr);
 101
 102         attr = config.getProperty("structure." + rel);
 103         if (attr == null)
 104             attr = config.getProperty("structure.*");
 105         attrs.add(attr);
 106
 107         attr = config.getProperty("always");
 108         if (attr != null)
 109             attrs.add(attr);
 110
 111         String s = "";
 112         for (int i = 0; i < attrs.size(); i++) {
 113             attr = (String) attrs.get(i);
 114             s += "@attr " + Utils.replaceString(attr, " ", " @attr ") + " ";
 115         }
 116
 117         return s + maybeQuote(text);
 118     }
 119
 120     static String maybeQuote(String str) {
 121         // There _must_ be a better way to make this test ...
 122         if (str.length() == 0 ||
 123             str.indexOf('"') != -1 ||
 124             str.indexOf(' ') != -1 ||
 125             str.indexOf('\t') != -1 ||
 126             str.indexOf('=') != -1 ||
 127             str.indexOf('<') != -1 ||
 128             str.indexOf('>') != -1 ||
 129             str.indexOf('/') != -1 ||
 130             str.indexOf('(') != -1 ||
 131             str.indexOf(')') != -1) {
 132             str = '"' + Utils.replaceString(str, "\"", "\\\"") + '"';
 133         }
 134
 135         return str;
 136     }
 137 }