X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=src%2Forg%2Fz3950%2Fzing%2Fcql%2FCQLNode.java;h=e0fba9d1698a7c1b75eefff963b21995a4a7565d;hb=aaafb116f81536ca6f842885f4a64fbc3c345b99;hp=200776fdf1f93de5326eb26a6cffd95c4dae5f41;hpb=136cb9d5cc54a9be6ea3c7240257b80c7da96f18;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 200776f..e0fba9d 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.16 2002-12-04 16:56:06 mike Exp $
+// $Id: CQLNode.java,v 1.19 2002-12-09 16:29:44 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.16 2002-12-04 16:56:06 mike Exp $
+ * @version $Id: CQLNode.java,v 1.19 2002-12-09 16:29:44 mike Exp $
*/
public abstract class CQLNode {
CQLNode() {} // prevent javadoc from documenting this
@@ -71,13 +71,12 @@ public abstract class CQLNode {
* A Properties object containing configuration
* information that specifies the mapping from CQL qualifiers,
* 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,
* etc/pqf.properties, 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,7 +94,23 @@ public abstract class CQLNode {
protected static String xq(String str) { return Utils.xq(str); }
/**
- * ### Document this!
+ * 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 Properties object containing configuration
+ * information that specifies the mapping from CQL qualifiers,
+ * relations, etc. to Type-1 attributes. The mapping
+ * specification is described in the CQL-Java distribution's
+ * sample PQF-mapping configuration file,
+ * etc/pqf.properties, which see.
+ * @return
+ * A byte array containing the BER packet.
+ * @see
+ * ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc
*/
abstract public byte[] toType1(Properties config)
throws PQFTranslationException;