X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=src%2Forg%2Fz3950%2Fzing%2Fcql%2FCQLNode.java;h=28521268ca9d5df8f15780c48e6cebbf92be0868;hb=3d47a2407f3b28ce9bb43013a6d6da0e99f336c5;hp=6a936bec318409b912ce256d414d1873d440cab4;hpb=39dd2263245ef87e3189e8dcfc61fc8a17882771;p=cql-java-moved-to-github.git

diff --git a/src/org/z3950/zing/cql/CQLNode.java b/src/org/z3950/zing/cql/CQLNode.java
index 6a936be..2852126 100644
--- 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.17 2002-12-06 12:35:15 mike Exp $
+// $Id: CQLNode.java,v 1.25 2007-06-27 22:39:55 mike Exp $
 
 package org.z3950.zing.cql;
 import java.util.Properties;
@@ -8,12 +8,24 @@ import java.util.Vector;
 /**
  * Represents a node in a CQL parse-tree.
  *
- * @version	$Id: CQLNode.java,v 1.17 2002-12-06 12:35:15 mike Exp $
+ * @version	$Id: CQLNode.java,v 1.25 2007-06-27 22:39:55 mike Exp $
  */
 public abstract class CQLNode {
     CQLNode() {}		// prevent javadoc from documenting this
 
     /**
+     * Returns the name of the result-set to which this query is a
+     * reference, if and only if the entire query consists only of a
+     * result-set reference.  If it's anything else, including a
+     * boolean combination of a result-set reference with something
+     * else, then null is returned instead.
+     * @return the name of the referenced result-set
+     */
+    public String getResultSetName() {
+	return null;
+    }
+
+    /**
      * Translates a parse-tree into an XCQL document.
      * <P>
      * @param level
@@ -26,10 +38,10 @@ public abstract class CQLNode {
      *	parse-tree whose root is this node.
      */
     public String toXCQL(int level) {
-	return toXCQL(level, new Vector());
+	return toXCQL(level, new Vector<CQLPrefix>());
     }
 
-    abstract public String toXCQL(int level, Vector prefixes);
+    abstract public String toXCQL(int level, Vector<CQLPrefix> prefixes);
 
     protected static String renderPrefixes(int level, Vector prefixes) {
 	if (prefixes.size() == 0)
@@ -69,15 +81,14 @@ 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
+     *	specification is described in the CQL-Java distribution's
      *	sample PQF-mapping configuration file,
      *	<TT>etc/pqf.properties</TT>, which see.
      * @return
      *	A String containing a PQF query equivalent to the parse-tree
-     *	whose root is this node.  This may be fed into the tool of
-     *	your choice to obtain a BER-encoded packet.
+     *	whose root is this node.
      */
     abstract public String toPQF(Properties config)
 	throws PQFTranslationException;
@@ -95,10 +106,25 @@ public abstract class CQLNode {
     protected static String xq(String str) { return Utils.xq(str); }
 
     /**
-     * ### Document this!
-     * ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc
+     * Renders a parser-tree into a BER-endoded packet representing an
+     * equivalent Z39.50 Type-1 query.  If you don't know what that
+     * means, then you don't need this method :-)  This is useful
+     * primarily for SRW-to-Z39.50 gateways.
+     *
+     * @param config
+     *	A <TT>Properties</TT> object containing configuration
+     *	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,
+     *	<TT>etc/pqf.properties</TT>, which see.
+     * @return
+     *	A byte array containing the BER packet.
+     * @see
+     *	<A href="ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc"
+     *	        >ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc</A>
      */
-    abstract public byte[] toType1(Properties config)
+    abstract public byte[] toType1BER(Properties config)
 	throws PQFTranslationException;
 
     // ANS.1 classes
@@ -145,7 +171,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?
@@ -184,7 +210,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) {
@@ -219,8 +245,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;
@@ -290,7 +316,7 @@ public abstract class CQLNode {
 
     public static final byte[] makeQuery(CQLNode root, Properties properties)
 	throws PQFTranslationException {
-        byte[] rpnStructure = root.toType1(properties);
+        byte[] rpnStructure = root.toType1BER(properties);
         byte[] qry = new byte[rpnStructure.length+100];
         int offset = 0;
         offset = putTag(CONTEXT, 1, CONSTRUCTED, qry, offset);