include/yaz/facet.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file facet.h
  30  * \brief Header for the facet utilities
  31  */
  32
  33 #ifndef YAZ_FACET_H
  34 #define YAZ_FACET_H
  35
  36 #include <yaz/yconfig.h>
  37 #include <yaz/odr.h>
  38 #include <yaz/z-core.h>
  39 #include <yaz/z-facet-1.h>
  40 #include <yaz/log.h>
  41
  42 YAZ_BEGIN_CDECL
  43
  44 /*
  45  * Helper function for extracting facet values from the ASN structures.
  46  *
  47  */
  48
  49 /** A helper structure to extract all the attribute stuff
  50    from one Z_AttributesList for facets. The pointers will all be to
  51    the Z-structures, or to constants, so there is no need to
  52    worry about freeing them */
  53 struct yaz_facet_attr {
  54     int  errcode;   /* set in case of errors */
  55     char *errstring; /* opt */
  56     const char *useattr; /* @attr 1, from a string attr */
  57                    /* or number converted to a string */
  58                    /* defaults to 'any' */
  59     char useattrbuff[30]; /* for converting numbers to strings */
  60     char *relation; /* @attr 2, defaults to '=' */
  61     int limit; /* for facet attributes */
  62 };
  63
  64 YAZ_EXPORT
  65 void facet_struct_init(struct yaz_facet_attr *attr_values);
  66
  67 /* Use attribute, @attr1, can be numeric or string */
  68 YAZ_EXPORT
  69 void useattr(Z_AttributeElement *ae, struct yaz_facet_attr *av);
  70
  71 YAZ_EXPORT
  72 void relationattr(Z_AttributeElement *ae, struct yaz_facet_attr *av);
  73
  74 YAZ_EXPORT
  75 void limitattr(Z_AttributeElement *ae, struct yaz_facet_attr *av);
  76
  77 YAZ_EXPORT
  78 void limitattr(Z_AttributeElement *ae, struct yaz_facet_attr *av);
  79
  80 YAZ_EXPORT
  81 void facetattrs(Z_AttributeList *attributes, struct yaz_facet_attr *av);
  82
  83 YAZ_EXPORT
  84 Z_FacetList *extract_facet_request(ODR odr, Z_OtherInformation *search_input);
  85
  86 YAZ_EXPORT
  87 Z_Term *term_create(ODR odr, const char *cstr);
  88
  89 YAZ_EXPORT
  90 Z_FacetTerm* facet_term_create(ODR odr, Z_Term *term, int freq);
  91
  92 YAZ_EXPORT
  93 Z_FacetField* facet_field_create(ODR odr, Z_AttributeList *attributes,
  94                                  int num_terms);
  95
  96 YAZ_EXPORT
  97 void facet_field_term_set(ODR odr, Z_FacetField *field,
  98                           Z_FacetTerm *facetTerm, int index);
  99
 100 YAZ_EXPORT
 101 Z_FacetList* facet_list_create(ODR odr, int num_facets);
 102
 103 YAZ_EXPORT
 104 void facet_list_field_set(ODR odr, Z_FacetList *list, Z_FacetField *field,
 105                           int index);
 106
 107 YAZ_END_CDECL
 108
 109 #endif
 110 /*
 111  * Local variables:
 112  * c-basic-offset: 4
 113  * c-file-style: "Stroustrup"
 114  * indent-tabs-mode: nil
 115  * End:
 116  * vim: shiftwidth=4 tabstop=8 expandtab
 117  */
 118