src/facet.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data
   3  * See the file LICENSE for details.
   4  */
   5
   6 /**
   7  * \file facet.c
   8  * \brief Facet utilities
   9  */
  10
  11 #if HAVE_CONFIG_H
  12 #include <config.h>
  13 #endif
  14
  15 #include <yaz/facet.h>
  16 #include <yaz/diagbib1.h>
  17 #include <yaz/oid_db.h>
  18 #include <yaz/oid_std.h>
  19 #include <yaz/otherinfo.h>
  20 #include <yaz/pquery.h>
  21 #include <assert.h>
  22
  23 void yaz_oi_set_facetlist(
  24     Z_OtherInformation **otherInformation, ODR odr,
  25     Z_FacetList *facet_list)
  26 {
  27     int categoryValue = 1;
  28     Z_External *z_external = 0;
  29     Z_OtherInformationUnit *oi =
  30         yaz_oi_update(otherInformation, odr, yaz_oid_userinfo_facet_1,
  31                       categoryValue, 0);
  32     if (!oi)
  33         return;
  34     oi->which = Z_OtherInfo_externallyDefinedInfo;
  35     z_external = odr_malloc(odr, sizeof(*z_external));
  36     z_external->which = Z_External_userFacets;
  37     z_external->direct_reference = odr_oiddup(odr, yaz_oid_userinfo_facet_1);
  38     z_external->indirect_reference = 0;
  39     z_external->descriptor = 0;
  40     z_external->u.facetList = facet_list;
  41     oi->information.externallyDefinedInfo = z_external;
  42 }
  43
  44 Z_FacetList *yaz_oi_get_facetlist(Z_OtherInformation **otherInformation)
  45 {
  46     Z_OtherInformation *oi = *otherInformation;
  47     if (oi)
  48     {
  49         int i;
  50         for (i = 0; i < oi->num_elements; i++)
  51         {
  52             Z_OtherInformationUnit *oiu = oi->list[i];
  53             if (oiu->which == Z_OtherInfo_externallyDefinedInfo
  54                 && oiu->information.externallyDefinedInfo->which ==
  55                 Z_External_userFacets)
  56             {
  57                 return oiu->information.externallyDefinedInfo->u.facetList;
  58             }
  59         }
  60     }
  61     return 0;
  62 }
  63
  64 /* Little helper to extract a string attribute */
  65 /* Gets the first string, there is usually only one */
  66 /* in case of errors, returns null */
  67
  68 void yaz_facet_attr_init(struct yaz_facet_attr *attr_values)
  69 {
  70     attr_values->errcode   = 0;
  71     attr_values->errstring = 0;
  72     attr_values->sortorder = 0;
  73     attr_values->useattr   = 0;
  74     attr_values->useattrbuff[0] = 0;
  75     attr_values->limit     = 0;
  76     attr_values->start     = 0;
  77 }
  78
  79 static const char *stringattr(Z_ComplexAttribute *c)
  80 {
  81     int i;
  82      Z_StringOrNumeric *son;
  83     for (i = 0; i < c->num_list; i++)
  84     {
  85         son = c->list[i];
  86         if ( son->which == Z_StringOrNumeric_string)
  87             return son->u.string;
  88     }
  89     return 0;
  90 }
  91
  92 /* Use attribute, @attr1, can be numeric or string */
  93 static void useattr(Z_AttributeElement *ae, struct yaz_facet_attr *av)
  94 {
  95     const char *s;
  96     if (ae->which == Z_AttributeValue_complex)
  97     {
  98         s = stringattr(ae->value.complex);
  99         if (s)
 100         {
 101             if (!av->useattr)
 102                 av->useattr = s;
 103             else
 104             { /* already seen one, can't have duplicates */
 105                 av->errcode = YAZ_BIB1_UNSUPP_ATTRIBUTE_COMBI;
 106                 av->errstring = "multiple use attributes";
 107             }
 108         }
 109         else
 110         { /* complex that did not return a string */
 111             av->errcode = YAZ_BIB1_UNSUPP_ATTRIBUTE_COMBI;
 112             av->errstring = "non-string complex attribute";
 113         }
 114     }
 115     else
 116     { /* numeric - could translate 4 to 'title' etc */
 117         sprintf(av->useattrbuff, ODR_INT_PRINTF, *ae->value.numeric);
 118         av->useattr = av->useattrbuff;
 119     }
 120 }
 121
 122
 123 static void numattr(Z_AttributeElement *ae, struct yaz_facet_attr *av,
 124                     int *v)
 125 {
 126     if (ae->which == Z_AttributeValue_numeric)
 127     {
 128         *v = *ae->value.numeric;
 129     }
 130     else
 131     {
 132         av->errcode = YAZ_BIB1_UNSUPP_ATTRIBUTE;
 133         av->errstring = "non-numeric limit/sort/start attribute";
 134     }
 135 }
 136
 137 /* Get the index to be searched from the attributes.
 138    @attr 1
 139      can be either "string", or some well-known value like
 140      4 for title
 141    Returns a null and sets errors in rr,
 142    emtpy string if no attr found,
 143    or the string itself - always a pointer to the Z-structs,
 144    so no need to free that string!
 145 */
 146
 147 void yaz_facet_attr_get_z_attributes(const Z_AttributeList *attributes,
 148                                      struct yaz_facet_attr *av)
 149 {
 150     int i;
 151     Z_AttributeElement *ae;
 152     for (i = 0; i < attributes->num_attributes; i++)
 153     {
 154         ae = attributes->attributes[i];
 155         /* ignoring the attributeSet here */
 156         if (*ae->attributeType == 1)
 157         { /* use attribute */
 158             useattr(ae, av);
 159         }
 160         else if (*ae->attributeType == 2)
 161         {
 162             numattr(ae, av, &av->sortorder);
 163         }
 164         else if (*ae->attributeType == 3)
 165         {
 166             numattr(ae, av, &av->limit);
 167         }
 168         else if (*ae->attributeType == 4)
 169         {
 170             numattr(ae, av, &av->start);
 171         }
 172         else
 173         { /* unknown attribute */
 174             av->errcode = YAZ_BIB1_UNSUPP_ATTRIBUTE_TYPE;
 175             sprintf(av->useattrbuff, ODR_INT_PRINTF,
 176                         *ae-> attributeType);
 177             av->errstring = av->useattrbuff;
 178             yaz_log(YLOG_WARN, "Unsupported attribute type %s", av->useattrbuff);
 179             /* would like to give a better message, but the standard */
 180             /* tells me to return the attribute type */
 181         }
 182         if (av->errcode)
 183             return; /* no need to dig deeper, return on first error */
 184     }
 185     return;
 186 } /* facetattrs */
 187
 188 #if 0
 189 Z_Term *term_create(ODR odr, const char *cstr)
 190 {
 191     Z_Term *term = odr_malloc(odr, sizeof(*term));
 192     term->which = Z_Term_characterString;
 193     term->u.characterString = odr_strdup(odr, cstr);
 194     return term;
 195 }
 196
 197 Z_FacetTerm* facet_term_create(ODR odr, Z_Term *term, int freq)
 198 {
 199     Z_FacetTerm *facet_term = odr_malloc(odr, sizeof(*facet_term));
 200     facet_term->count = odr_malloc(odr, sizeof(*facet_term->count));
 201     facet_term->term = term;
 202     *facet_term->count = freq;
 203     return facet_term;
 204 }
 205 #endif
 206
 207 Z_FacetTerm *facet_term_create_cstr(ODR odr, const char *cstr, Odr_int freq)
 208 {
 209     Z_FacetTerm *facet_term = odr_malloc(odr, sizeof(*facet_term));
 210     Z_Term *term = z_Term_create(odr, Z_Term_general, cstr, strlen(cstr));
 211     facet_term->term = term;
 212     facet_term->count = odr_intdup(odr, freq);
 213     return facet_term;
 214 }
 215
 216 Z_FacetField* facet_field_create(ODR odr, Z_AttributeList *attributes,
 217                                  int num_terms)
 218 {
 219     Z_FacetField *facet_field = odr_malloc(odr, sizeof(*facet_field));
 220     facet_field->attributes = attributes;
 221     facet_field->num_terms = num_terms;
 222     facet_field->terms = odr_malloc(odr, num_terms * sizeof(*facet_field->terms));
 223     return facet_field;
 224 }
 225
 226 void facet_field_term_set(ODR odr, Z_FacetField *field,
 227                           Z_FacetTerm *facet_term, int index)
 228 {
 229     assert(0 <= index && index < field->num_terms);
 230     field->terms[index] = facet_term;
 231 }
 232
 233 Z_FacetList* facet_list_create(ODR odr, int num_facets)
 234 {
 235     Z_FacetList *facet_list = odr_malloc(odr, sizeof(*facet_list));
 236     facet_list->num = num_facets;
 237     facet_list->elements =
 238         odr_malloc(odr, facet_list->num * sizeof(*facet_list->elements));
 239     return facet_list;
 240 }
 241
 242 void facet_list_field_set(ODR odr, Z_FacetList *list, Z_FacetField *field,
 243                           int index)
 244 {
 245     assert(0 <= index && index < list->num);
 246     list->elements[index] = field;
 247 }
 248
 249 /*
 250  * Local variables:
 251  * c-basic-offset: 4
 252  * c-file-style: "Stroustrup"
 253  * indent-tabs-mode: nil
 254  * End:
 255  * vim: shiftwidth=4 tabstop=8 expandtab
 256  */
 257