org.z3950.zing.cql
Class CQLTermNode

java.lang.Object
  org.z3950.zing.cql.CQLNode
      org.z3950.zing.cql.CQLTermNode

public class CQLTermNode
extends CQLNode

Represents a terminal node in a CQL parse-tree. A term node consists of the term String itself, together with, optionally, an index string and a relation. Neither or both of these must be provided - you can't have an index without a relation or vice versa.

Version:

$Id: CQLTermNode.java,v 1.28 2007/07/03 13:41:24 mike Exp $

Field Summary

Fields inherited from class org.z3950.zing.cql.CQLNode

APPLICATION, BITSTRING, BOOLEAN, CONSTRUCTED, CONTEXT, ENUMERATED, EXTERNAL, GENERALSTRING, INTEGER, NULL, OBJECTDESCRIPTOR, OBJECTIDENTIFIER, OCTETSTRING, PRIMITIVE, PRIVATE, SEQUENCE, SET, UNIVERSAL, VISIBLESTRING

Constructor Summary

CQLTermNode(java.lang.String index, CQLRelation relation, java.lang.String term)
Creates a new term node with the specified index, relation and term.

Method Summary

java.lang.String	getIndex()
CQLRelation	getRelation()
java.lang.String	getResultSetName() 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.
java.lang.String	getTerm()
java.lang.String	toCQL() Decompiles a parse-tree into a CQL query.
java.lang.String	toPQF(java.util.Properties config) Renders a parse-tree into a Yaz-style PQF string.
byte[]	toType1BER(java.util.Properties config) Renders a parser-tree into a BER-endoded packet representing an equivalent Z39.50 Type-1 query.
java.lang.String	toXCQL(int level, java.util.Vector<CQLPrefix> prefixes, java.util.Vector<ModifierSet> sortkeys)

Methods inherited from class org.z3950.zing.cql.CQLNode

indent, lenLen, makeOID, makeQuery, numLen, putLen, putNum, putTag, renderPrefixes, renderSortKeys, toXCQL, toXCQL, xq

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CQLTermNode

public CQLTermNode(java.lang.String index,
                   CQLRelation relation,
                   java.lang.String term)

Creates a new term node with the specified index, relation and term. The first two may be null, but the term may not.

Method Detail

getIndex

public java.lang.String getIndex()

getRelation

public CQLRelation getRelation()

getTerm

public java.lang.String getTerm()

getResultSetName

public java.lang.String getResultSetName()

Description copied from class: CQLNode

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.

Overrides:

getResultSetName in class CQLNode

Returns:

the name of the referenced result-set

toXCQL

public java.lang.String toXCQL(int level,
                               java.util.Vector<CQLPrefix> prefixes,
                               java.util.Vector<ModifierSet> sortkeys)

Specified by:

toXCQL in class CQLNode

toCQL

public java.lang.String toCQL()

Description copied from class: CQLNode

Decompiles a parse-tree into a CQL query.

Specified by:

toCQL in class CQLNode

Returns:

A String containing a CQL query equivalent to the parse-tree whose root is this node, so that compiling that query will yield an identical tree.

toPQF

public java.lang.String toPQF(java.util.Properties config)
                       throws PQFTranslationException

Description copied from class: CQLNode

Renders a parse-tree into a Yaz-style PQF string. PQF, or Prefix Query Format, is a cryptic but powerful notation that can be trivially mapped, one-to-one, int Z39.50 Type-1 and Type-101 queries. A specification for the format can be found in Chapter 7 (Supporting Tools) of the YAZ manual.

Specified by:

toPQF in class CQLNode

Parameters:

config - A Properties 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, etc/pqf.properties, which see.

Returns:

A String containing a PQF query equivalent to the parse-tree whose root is this node.

Throws:

PQFTranslationException

toType1BER

public byte[] toType1BER(java.util.Properties config)
                  throws PQFTranslationException

Description copied from class: CQLNode

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.

Specified by:

toType1BER in class CQLNode

Parameters:

config - A Properties 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, etc/pqf.properties, which see.

Returns:

A byte array containing the BER packet.

Throws:

PQFTranslationException

See Also:

ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc