include/yaz/d1_attset.h

   1 /*
   2  * Copyright (c) 1995-2000, 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 YAZ_BEGIN_CDECL
  34
  35 /*
  36  * This structure describes a attset, perhaps made up by inclusion
  37  * (supersetting) of other attribute sets. When indexing and searching,
  38  * we perform a normalisation, where we associate a given tag with
  39  * the set that originally defined it, rather than the superset. This
  40  * allows the most flexible access. Eg, the tags common to GILS and BIB-1
  41  * should be searchable by both names.
  42  */
  43
  44 struct data1_attset;
  45
  46 typedef struct data1_local_attribute
  47 {
  48     int local;
  49     struct data1_local_attribute *next;
  50 } data1_local_attribute;
  51
  52 typedef struct data1_attset data1_attset;
  53 typedef struct data1_att data1_att;
  54 typedef struct data1_attset_child data1_attset_child;
  55
  56 struct data1_att
  57 {
  58     data1_attset *parent;          /* attribute set */
  59     char *name;                    /* symbolic name of this attribute */
  60     int value;                     /* attribute value */
  61     data1_local_attribute *locals; /* local index values */
  62     data1_att *next;
  63 };
  64
  65 struct data1_attset_child {
  66     data1_attset *child;
  67     data1_attset_child *next;
  68 };
  69
  70 struct data1_attset
  71 {
  72     char *name;          /* symbolic name */
  73     oid_value reference;   /* external ID of attset */
  74     data1_att *atts;          /* attributes */
  75     data1_attset_child *children;  /* included attset */
  76     data1_attset *next;       /* next in cache */
  77 };
  78
  79 typedef struct data1_handle_info *data1_handle;
  80
  81 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
  82                                          char *name);
  83 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
  84
  85 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
  86
  87 YAZ_END_CDECL
  88
  89 #endif