toXCQL() refactored as layer over new underlyingToXCQL()
[cql-java-moved-to-github.git] / src / org / z3950 / zing / cql / ModifierSet.java
index 66380ff..7b6991a 100644 (file)
@@ -1,32 +1,32 @@
-// $Id: ModifierSet.java,v 1.7 2002-11-20 17:56:22 mike Exp $
+// $Id: ModifierSet.java,v 1.13 2007-07-03 13:30:18 mike Exp $
 
 package org.z3950.zing.cql;
 import java.util.Vector;
 import java.lang.StringBuffer;
 
 /**
- * Represents a base String and a set of modifier Strings.
+ * Represents a base String and a set of Modifiers.
  * <P>
  * This class is used as a workhorse delegate by both CQLRelation and
  * CQLProxNode - two functionally very separate classes that happen to
  * require similar data structures and functionality.
  * <P>
  * A ModifierSet consists of a ``base'' string together with a set of
- * zero or more <I>type</I>=<I>value</I> pairs, where both type and
- * value are strings.  Types may be null, values may not.
+ * zero or more <I>type</I> <I>comparison</I> <I>value</I> pairs,
+ * where type, comparison and value are all strings.
  *
- * @version $Id: ModifierSet.java,v 1.7 2002-11-20 17:56:22 mike Exp $
+ * @version $Id: ModifierSet.java,v 1.13 2007-07-03 13:30:18 mike Exp $
  */
 public class ModifierSet {
     String base;
-    Vector modifiers;
+    Vector<Modifier> modifiers;
 
     /**
      * Creates a new ModifierSet with the specified base.
      */
     public ModifierSet(String base) {
        this.base = base;
-       modifiers = new Vector();
+       modifiers = new Vector<Modifier>();
     }
 
     /**
@@ -37,13 +37,20 @@ public class ModifierSet {
     }
 
     /**
-     * Adds a modifier of the specified <TT>type</TT> and
-     * <TT>value</TT> to a ModifierSet.
+     * Adds a modifier of the specified <TT>type</TT>,
+     * <TT>comparison</TT> and <TT>value</TT> to a ModifierSet.
      */
-    public void addModifier(String type, String value) {
-       Vector modifier = new Vector();
-       modifier.add(type);
-       modifier.add(value);
+    public void addModifier(String type, String comparison, String value) {
+       Modifier modifier = new Modifier(type, comparison, value);
+       modifiers.add(modifier);
+    }
+
+    /**
+     * Adds a modifier of the specified <TT>type</TT>, but with no
+     * <TT>comparison</TT> and <TT>value</TT>, to a ModifierSet.
+     */
+    public void addModifier(String type) {
+       Modifier modifier = new Modifier(type);
        modifiers.add(modifier);
     }
 
@@ -54,9 +61,9 @@ public class ModifierSet {
     public String modifier(String type) {
        int n = modifiers.size();
        for (int i = 0; i < n; i++) {
-           Vector pair = (Vector) modifiers.get(i);
-           if (pair.get(0).equals(type))
-               return (String) pair.get(1);
+           Modifier mod = modifiers.get(i);
+           if (mod.type.equals(type))
+               return mod.value;
        }
        return null;
     }
@@ -64,40 +71,31 @@ public class ModifierSet {
     /**
      * Returns an array of the modifiers in a ModifierSet.
      * @return
-     * An array of modifiers, each represented by a two-element
-     * <TT>Vector</TT>, in which element 0 is the modifier type and
-     * element 1 is the associated value.
+     * An array of Modifiers.
      */
-    public Vector[] getModifiers() {
-       int n = modifiers.size();
-       Vector[] res = new Vector[n];
-       for (int i = 0; i < n; i++) {
-           res[i] = (Vector) modifiers.get(i);
-       }
-
-       return res;
+    public Vector<Modifier> getModifiers() {
+       return modifiers;
     }
 
     public String toXCQL(int level, String topLevelElement) {
+       return underlyingToXCQL(level, topLevelElement, "value");
+    }
+
+    public String sortKeyToXCQL(int level) {
+       return underlyingToXCQL(level, "key", "index");
+    }
+
+    private String underlyingToXCQL(int level, String topLevelElement,
+                                   String valueElement) {
        StringBuffer buf = new StringBuffer();
-       buf.append (Utils.indent(level) + "<" + topLevelElement + ">\n" +
-                   Utils.indent(level+1) + "<value>" + Utils.xq(base) +
-                   "</value>\n");
-       Vector[] mods = getModifiers();
-       if (mods.length > 0) {
+       buf.append(Utils.indent(level) + "<" + topLevelElement + ">\n");
+       buf.append(Utils.indent(level+1) +
+                  "<" + valueElement + ">" + Utils.xq(base) +
+                  "</" + valueElement + ">\n");
+       if (modifiers.size() > 0) {
            buf.append(Utils.indent(level+1) + "<modifiers>\n");
-           for (int i = 0; i < mods.length; i++) {
-               Vector modifier = mods[i];
-               buf.append(Utils.indent(level+2)).
-                   append("<modifier>");
-               if (modifier.get(0) != null)
-                   buf.append("<type>").
-                       append(Utils.xq((String) modifier.get(0))).
-                       append("</type>");
-               buf.append("<value>").
-                   append(Utils.xq((String) modifier.get(1))).
-                   append("</value>");
-               buf.append("</modifier>\n");
+           for (int i = 0; i < modifiers.size(); i++) {
+               buf.append(modifiers.get(i).toXCQL(level+2, "comparison"));
            }
            buf.append(Utils.indent(level+1) + "</modifiers>\n");
        }
@@ -107,9 +105,8 @@ public class ModifierSet {
 
     public String toCQL() {
        StringBuffer buf = new StringBuffer(base);
-       Vector[] mods = getModifiers();
-       for (int i = 0; i < mods.length; i++) {
-           buf.append("/").append(mods[i].get(1));
+       for (int i = 0; i < modifiers.size(); i++) {
+           buf.append("/" + modifiers.get(i).toCQL());
        }
 
        return buf.toString();
@@ -117,13 +114,13 @@ public class ModifierSet {
 
     public static void main(String[] args) {
        if (args.length < 1) {
-           System.err.println("Usage: ModifierSet <base> [<type> <name>]...");
+           System.err.println("Usage: ModifierSet <base> [<type> <comparison> <name>]...");
            System.exit(1);
        }
 
        ModifierSet res = new ModifierSet(args[0]);
-       for (int i = 1; i < args.length; i += 2) {
-           res.addModifier(args[i], args[i+1]);
+       for (int i = 1; i < args.length; i += 3) {
+           res.addModifier(args[i], args[i+1], args[i+2]);
        }
 
        System.out.println(res.toCQL());