X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ftools.xml;h=1fce5182782cbadbb8febafd4ff45c184aa2fe5a;hb=f720562471a064dba92a465d999aa833e59d69b1;hp=132cb9b778cb1fae3238d85ae3df9bce7c817dec;hpb=c91efbe35fe8ff53aeafedf0ffb8f1b90841ecdc;p=yaz-moved-to-github.git
diff --git a/doc/tools.xml b/doc/tools.xml
index 132cb9b..1fce518 100644
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -52,17 +52,16 @@
#include <yaz/pquery.h>
- YAZ_PQF_Parser yaz_pqf_create (void);
+ YAZ_PQF_Parser yaz_pqf_create(void);
- void yaz_pqf_destroy (YAZ_PQF_Parser p);
+ void yaz_pqf_destroy(YAZ_PQF_Parser p);
- Z_RPNQuery *yaz_pqf_parse (YAZ_PQF_Parser p, ODR o, const char *qbuf);
+ Z_RPNQuery *yaz_pqf_parse(YAZ_PQF_Parser p, ODR o, const char *qbuf);
- Z_AttributesPlusTerm *yaz_pqf_scan (YAZ_PQF_Parser p, ODR o,
+ Z_AttributesPlusTerm *yaz_pqf_scan(YAZ_PQF_Parser p, ODR o,
Odr_oid **attributeSetId, const char *qbuf);
-
- int yaz_pqf_error (YAZ_PQF_Parser p, const char **msg, size_t *off);
+ int yaz_pqf_error(YAZ_PQF_Parser p, const char **msg, size_t *off);
A PQF parser is created and destructed by functions
@@ -91,12 +90,12 @@
#include <yaz/pquery.h>
- Z_RPNQuery *p_query_rpn (ODR o, oid_proto proto, const char *qbuf);
+ Z_RPNQuery *p_query_rpn(ODR o, oid_proto proto, const char *qbuf);
- Z_AttributesPlusTerm *p_query_scan (ODR o, oid_proto proto,
+ Z_AttributesPlusTerm *p_query_scan(ODR o, oid_proto proto,
Odr_oid **attributeSetP, const char *qbuf);
- int p_query_attset (const char *arg);
+ int p_query_attset(const char *arg);
The function p_query_rpn() takes as arguments an
@@ -501,6 +500,12 @@
(dylan and bob) or set=1
+ righttrunc?
+
+ "notrunc?"
+
+ singlechar#mask
+
Assuming that the qualifiers ti,
@@ -862,6 +867,11 @@
?
+ mask
+ Masking character. Requires YAZ 4.2.58 or later
+ #
+
+
field
Specifies how multiple fields are to be
combined. There are two modes: or:
@@ -928,8 +938,8 @@
To parse a simple string with a FIND query use the function
-struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
- int *error, int *pos);
+struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset, const char *str,
+ int *error, int *pos);
which takes the CCL profile (bibset) and query
@@ -1087,6 +1097,7 @@ struct cql_node *cql_parser_result(CQL_parser cp);
#define CQL_NODE_ST 1
#define CQL_NODE_BOOL 2
+#define CQL_NODE_SORT 3
struct cql_node {
int which;
union {
@@ -1104,10 +1115,17 @@ struct cql_node {
struct cql_node *right;
struct cql_node *modifiers;
} boolean;
+ struct {
+ char *index;
+ struct cql_node *next;
+ struct cql_node *modifiers;
+ struct cql_node *search;
+ } sort;
} u;
};
- There are two node types: search term (ST) and boolean (BOOL).
+ There are three node types: search term (ST), boolean (BOOL)
+ and sortby (SORT).
A modifier is treated as a search term too.
@@ -1152,8 +1170,8 @@ struct cql_node {
- The boolean node represents both and,
- or, not as well as
+ The boolean node represents and,
+ or, not +
proximity.
@@ -1170,6 +1188,10 @@ struct cql_node {
+
+ The sort node represents both the SORTBY clause.
+
+
CQL to PQF conversion
@@ -1552,6 +1574,27 @@ void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
a file.
+
+ PQF to CQL conversion
+
+ Conversion from PQF to CQL is offered by the two functions shown
+ below. The former uses a generic stream for result. The latter
+ puts result in a WRBUF (string container).
+
+#include <yaz/rpn2cql.h>
+
+int cql_transform_rpn2cql_stream(cql_transform_t ct,
+ void (*pr)(const char *buf, void *client_data),
+ void *client_data,
+ Z_RPNQuery *q);
+
+int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
+ WRBUF w,
+ Z_RPNQuery *q);
+
+ The configuration is the same as used in CQL to PQF conversions.
+
+
Object Identifiers