-// $Id: CQLNode.java,v 1.16 2002-12-04 16:56:06 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;
/**
* 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.26 2007-07-03 13:36:03 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
* parse-tree whose root is this node.
*/
public String toXCQL(int level) {
- return toXCQL(level, new Vector());
+ return toXCQL(level, null);
}
- abstract public String toXCQL(int level, Vector prefixes);
+ public String toXCQL(int level, Vector<CQLPrefix> prefixes) {
+ return toXCQL(level, prefixes, null);
+ }
+
+ 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++) {
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>
* <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;
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 <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
/**
* 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?
/**
* 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) {
}
// 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;
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);
projects / cql-java-moved-to-github.git / blobdiff