include/yaz/d1_attset.h

   1 /*
   2  * Copyright (c) 1995-1998, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The names of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  */
  27
  28 #ifndef D1_ATTSET_H
  29 #define D1_ATTSET_H
  30
  31 #include <yaz/oid.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*
  38  * This structure describes a attset, perhaps made up by inclusion
  39  * (supersetting) of other attribute sets. When indexing and searching,
  40  * we perform a normalisation, where we associate a given tag with
  41  * the set that originally defined it, rather than the superset. This
  42  * allows the most flexible access. Eg, the tags common to GILS and BIB-1
  43  * should be searchable by both names.
  44  */
  45
  46 struct data1_attset;
  47
  48 typedef struct data1_local_attribute
  49 {
  50     int local;
  51     struct data1_local_attribute *next;
  52 } data1_local_attribute;
  53
  54 typedef struct data1_attset data1_attset;
  55 typedef struct data1_att data1_att;
  56 typedef struct data1_attset_child data1_attset_child;
  57
  58 struct data1_att
  59 {
  60     data1_attset *parent;          /* attribute set */
  61     char *name;                    /* symbolic name of this attribute */
  62     int value;                     /* attribute value */
  63     data1_local_attribute *locals; /* local index values */
  64     data1_att *next;
  65 };
  66
  67 struct data1_attset_child {
  68     data1_attset *child;
  69     data1_attset_child *next;
  70 };
  71
  72 struct data1_attset
  73 {
  74     char *name;          /* symbolic name */
  75     oid_value reference;   /* external ID of attset */
  76     data1_att *atts;          /* attributes */
  77     data1_attset_child *children;  /* included attset */
  78     data1_attset *next;       /* next in cache */
  79 };
  80
  81 typedef struct data1_handle_info *data1_handle;
  82
  83 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
  84                                          char *name);
  85 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
  86
  87 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif