include/yaz/srw.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: srw.h,v 1.22 2005-06-25 15:46:03 adam Exp $
   6  */
   7 /**
   8  * \file srw.h
   9  * \brief Header for SRW/SRU
  10  */
  11
  12 #ifndef YAZ_SRW_H
  13 #define YAZ_SRW_H
  14
  15 #include <yaz/soap.h>
  16 #include <yaz/zgdu.h>
  17 #include <yaz/diagsrw.h>
  18
  19 YAZ_BEGIN_CDECL
  20
  21 typedef struct {
  22     char *recordSchema;
  23     int recordPacking;
  24 #define Z_SRW_recordPacking_string 0
  25 #define Z_SRW_recordPacking_XML 1
  26     char *recordData_buf;
  27     int recordData_len;
  28     int *recordPosition;
  29 } Z_SRW_record;
  30
  31 typedef struct {
  32     char *uri;
  33     char *details;
  34     char *message;
  35 } Z_SRW_diagnostic;
  36
  37 typedef struct {
  38
  39 #define Z_SRW_query_type_cql  1
  40 #define Z_SRW_query_type_xcql 2
  41 #define Z_SRW_query_type_pqf  3
  42     int query_type;
  43     union {
  44         char *cql;
  45         char *xcql;
  46         char *pqf;
  47     } query;
  48
  49 #define Z_SRW_sort_type_none 1
  50 #define Z_SRW_sort_type_sort 2
  51 #define Z_SRW_sort_type_xSort 3
  52     int sort_type;
  53     union {
  54         char *none;
  55         char *sortKeys;
  56         char *xSortKeys;
  57     } sort;
  58     int *startRecord;
  59     int *maximumRecords;
  60     char *recordSchema;
  61     char *recordPacking;
  62     char *recordXPath;
  63     char *database;
  64     char *stylesheet;
  65     int *resultSetTTL;
  66 } Z_SRW_searchRetrieveRequest;
  67
  68 typedef struct {
  69     int * numberOfRecords;
  70     char * resultSetId;
  71     int * resultSetIdleTime;
  72
  73     Z_SRW_record *records;
  74     int num_records;
  75
  76     Z_SRW_diagnostic *diagnostics;
  77     int num_diagnostics;
  78     int *nextRecordPosition;
  79 } Z_SRW_searchRetrieveResponse;
  80
  81 typedef struct {
  82     char *recordPacking;
  83     char *database;
  84     char *stylesheet;
  85 } Z_SRW_explainRequest;
  86
  87 typedef struct {
  88     Z_SRW_record record;
  89     Z_SRW_diagnostic *diagnostics;
  90     int num_diagnostics;
  91 } Z_SRW_explainResponse;
  92
  93 typedef struct {
  94     int query_type;
  95     union {
  96         char *cql;
  97         char *xcql;
  98         char *pqf;
  99     } scanClause;
 100     int *responsePosition;
 101     int *maximumTerms;
 102     char *stylesheet;
 103     char *database;
 104 } Z_SRW_scanRequest;
 105
 106 typedef struct {
 107     char *value;
 108     int *numberOfRecords;
 109     char *displayTerm;
 110     char *whereInList;
 111 } Z_SRW_scanTerm;
 112
 113 typedef struct {
 114     Z_SRW_scanTerm *terms;
 115     int num_terms;
 116     Z_SRW_diagnostic *diagnostics;
 117     int num_diagnostics;
 118 } Z_SRW_scanResponse;
 119
 120 #define Z_SRW_searchRetrieve_request  1
 121 #define Z_SRW_searchRetrieve_response 2
 122 #define Z_SRW_explain_request 3
 123 #define Z_SRW_explain_response 4
 124 #define Z_SRW_scan_request 5
 125 #define Z_SRW_scan_response 6
 126
 127 typedef struct {
 128     int which;
 129     union {
 130         Z_SRW_searchRetrieveRequest *request;
 131         Z_SRW_searchRetrieveResponse *response;
 132         Z_SRW_explainRequest *explain_request;
 133         Z_SRW_explainResponse *explain_response;
 134         Z_SRW_scanRequest *scan_request;
 135         Z_SRW_scanResponse *scan_response;
 136     } u;
 137     char *srw_version;
 138 } Z_SRW_PDU;
 139
 140 YAZ_EXPORT int yaz_srw_codec(ODR o, void * pptr,
 141                              Z_SRW_PDU **handler_data,
 142                              void *client_data, const char *ns);
 143 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get(ODR o, int which);
 144
 145 YAZ_EXPORT int yaz_diag_bib1_to_srw (int bib1_code);
 146
 147 YAZ_EXPORT int yaz_diag_srw_to_bib1(int srw_code);
 148
 149 YAZ_EXPORT char *yaz_uri_val(const char *path, const char *name, ODR o);
 150 YAZ_EXPORT void yaz_uri_val_int(const char *path, const char *name,
 151                                 ODR o, int **intp);
 152 YAZ_EXPORT int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 153                               Z_SOAP **soap_package, ODR decode, char **charset);
 154 YAZ_EXPORT int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 155                               Z_SOAP **soap_package, ODR decode,
 156                               char **charset,
 157                               Z_SRW_diagnostic **, int *num_diagnostic);
 158
 159 YAZ_EXPORT void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
 160                                        int *num, int code,
 161                                        const char *addinfo);
 162
 163 YAZ_EXPORT void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
 164                                       int code, const char *details);
 165 YAZ_END_CDECL
 166
 167 #endif
 168 /*
 169  * Local variables:
 170  * c-basic-offset: 4
 171  * indent-tabs-mode: nil
 172  * End:
 173  * vim: shiftwidth=4 tabstop=8 expandtab
 174  */
 175