org.z3950.zing.cql
Class CQLRelation

java.lang.Object
  extended by org.z3950.zing.cql.CQLNode
      extended by org.z3950.zing.cql.CQLRelation

public class CQLRelation
extends CQLNode

Represents a relation between a CQL index and term.

Version:
$Id: CQLRelation.java,v 1.19 2007-07-03 13:40:58 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
CQLRelation(java.lang.String base)
          Creates a new CQLRelation with the specified base relation.
 
Method Summary
 java.lang.String getBase()
          Returns the base relation with which the CQLRelation was originally created.
 java.util.Vector<Modifier> getModifiers()
          Returns an array of the modifiers associated with a CQLRelation.
 void setModifiers(ModifierSet ms)
          Sets the modifiers of the specified CQLRelation.
 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 prefixes, java.util.Vector sortkeys)
           
 
Methods inherited from class org.z3950.zing.cql.CQLNode
getResultSetName, 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

CQLRelation

public CQLRelation(java.lang.String base)
Creates a new CQLRelation with the specified base relation. Typical base relations include the usual six ordering relations (<=, >, etc.), the text relations any, all and exact, the old server-choice relation scr and profiled relations of the form prefix.name.

Method Detail

getBase

public java.lang.String getBase()
Returns the base relation with which the CQLRelation was originally created.


setModifiers

public void setModifiers(ModifierSet ms)
Sets the modifiers of the specified CQLRelation. Typical relation modifiers include relevant, fuzzy, stem and phonetic. On the whole, these modifiers have a meaningful interpretation only for the text relations.


getModifiers

public java.util.Vector<Modifier> getModifiers()
Returns an array of the modifiers associated with a CQLRelation.

Returns:
An array of Modifier objects.

toXCQL

public java.lang.String toXCQL(int level,
                               java.util.Vector prefixes,
                               java.util.Vector 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)
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.
See Also:
ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc