Primary toXCQL() API now includes a Vector of sort keys.

[cql-java-moved-to-github.git] / src / org / z3950 / zing / cql / CQLNode.java

diff --git a/src/org/z3950/zing/cql/CQLNode.java b/src/org/z3950/zing/cql/CQLNode.java
index cfc6e29..3e42e1e 100644 (file)
--- a/src/org/z3950/zing/cql/CQLNode.java
+++ b/src/org/z3950/zing/cql/CQLNode.java
@@ -1,4 +1,4 @@
-// $Id: CQLNode.java,v 1.21 2002-12-12 10:24:25 mike Exp $
+// $Id: CQLNode.java,v 1.26 2007-07-03 13:36:03 mike Exp $
 
 package org.z3950.zing.cql;
 import java.util.Properties;
@@ -8,7 +8,7 @@ import java.util.Vector;
 /**
  * Represents a node in a CQL parse-tree.
  *
- * @version    $Id: CQLNode.java,v 1.21 2002-12-12 10:24:25 mike Exp $
+ * @version    $Id: CQLNode.java,v 1.26 2007-07-03 13:36:03 mike Exp $
  */
 public abstract class CQLNode {
     CQLNode() {}               // prevent javadoc from documenting this
@@ -21,7 +21,9 @@ public abstract class CQLNode {
      * else, then null is returned instead.
      * @return the name of the referenced result-set
      */
-    public String getResultSetName() { return null; }
+    public String getResultSetName() {
+       return null;
+    }
 
     /**
      * Translates a parse-tree into an XCQL document.
@@ -36,13 +38,18 @@ public abstract class CQLNode {
      * parse-tree whose root is this node.
      */
     public String toXCQL(int level) {
-       return toXCQL(level, new Vector());
+       return toXCQL(level, null);
+    }
+
+    public String toXCQL(int level, Vector<CQLPrefix> prefixes) {
+       return toXCQL(level, prefixes, null);
     }
 
-    abstract public String toXCQL(int level, Vector prefixes);
+    abstract public String toXCQL(int level, Vector<CQLPrefix> prefixes,
+                                 Vector<ModifierSet> sortkeys);
 
     protected static String renderPrefixes(int level, Vector prefixes) {
-       if (prefixes.size() == 0)
+       if (prefixes == null || prefixes.size() == 0)
            return "";
        String res = indent(level) + "<prefixes>\n";
        for (int i = 0; i < prefixes.size(); i++) {
@@ -57,6 +64,18 @@ public abstract class CQLNode {
        return res + indent(level) + "</prefixes>\n";
     }
 
+    protected static String renderSortKeys(int level,
+                                          Vector<ModifierSet> sortkeys) {
+       if (sortkeys == null || sortkeys.size() == 0)
+           return "";
+       String res = indent(level) + "<sortKeys>\n";
+       for (int i = 0; i < sortkeys.size(); i++) {
+           ModifierSet key = sortkeys.get(i);
+           res += key.sortKeyToXCQL(level+1);
+       }
+       return res + indent(level) + "</sortKeys>\n";
+    }
+
     /**
      * Decompiles a parse-tree into a CQL query.
      * <P>
@@ -79,7 +98,7 @@ public abstract class CQLNode {
      * <P>
      * @param config
      * A <TT>Properties</TT> object containing configuration
-     * information that specifies the mapping from CQL qualifiers,
+     * information that specifies the mapping from CQL indexes,
      * relations, etc. to Type-1 attributes.  The mapping
      * specification is described in the CQL-Java distribution's
      * sample PQF-mapping configuration file,
@@ -111,7 +130,7 @@ public abstract class CQLNode {
      *
      * @param config
      * A <TT>Properties</TT> object containing configuration
-     * information that specifies the mapping from CQL qualifiers,
+     * information that specifies the mapping from CQL indexes,
      * relations, etc. to Type-1 attributes.  The mapping
      * specification is described in the CQL-Java distribution's
      * sample PQF-mapping configuration file,
@@ -169,7 +188,7 @@ public abstract class CQLNode {
     /**
      * Put a length directly into a BER record.
      *
-     * @param length length to put into record
+     * @param len length to put into record
      * @return the new, incremented value of the offset parameter.
      */
     public // ### shouldn't this be protected?
@@ -208,7 +227,7 @@ public abstract class CQLNode {
     /**
      * Get the length needed to represent the given number.
      *
-     * @param number determine length needed to encode this
+     * @param num determine length needed to encode this
      * @return length needed to encode given number
      */
     protected static final int numLen(long num) {
@@ -243,8 +262,8 @@ public abstract class CQLNode {
     }
 
     // Used only by the makeOID() method
-    private static final java.util.Hashtable madeOIDs =
-       new java.util.Hashtable(10);
+    private static final java.util.Hashtable<String, byte[]> madeOIDs =
+       new java.util.Hashtable<String, byte[]>(10);
 
     protected static final byte[] makeOID(String oid) {
         byte[] o;