c2fb952e8573e8518dfd1fe4852685c96ba70298
[yaz-moved-to-github.git] / include / d1_attset.h
1 /*
2  * Copyright (c) 1995, 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 <oid.h>
32
33 /*
34  * This structure describes a attset, perhaps made up by inclusion
35  * (supersetting) of other attribute sets. When indexing and searching,
36  * we perform a normalisation, where we associate a given tag with
37  * the set that originally defined it, rather than the superset. This
38  * allows the most flexible access. Eg, the tags common to GILS and BIB-1
39  * should be searchable by both names.
40  */
41
42 struct data1_attset;
43
44 typedef struct data1_local_attribute
45 {
46     int local;
47     struct data1_local_attribute *next;
48 } data1_local_attribute;
49
50 typedef struct data1_att
51 {
52     struct data1_attset *parent;   /* attribute set */
53     char *name;                    /* symbolic name of this attribute */
54     int value;                     /* attribute value */
55     data1_local_attribute *locals; /* local index values */
56     struct data1_att *next;
57 } data1_att;
58
59 typedef struct data1_attset
60 {
61     char *name;          /* symbolic name */
62     oid_value reference;   /* external ID of attset */
63     int ordinal;           /* attset identification in index */
64     data1_att *atts;          /* attributes */
65     struct data1_attset *children;  /* included attset */
66     struct data1_attset *next;       /* sibling */
67 } data1_attset;
68
69 data1_att *data1_getattbyname(data1_attset *s, char *name);
70 data1_attset *data1_read_attset(char *file);
71
72 #endif