1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/* This file is part of the Zebra server.
Copyright (C) Index Data
Zebra is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef SORTIDX_H
#define SORTIDX_H
#include <yaz/yconfig.h>
#include <idzebra/bfile.h>
#include <yaz/wrbuf.h>
YAZ_BEGIN_CDECL
#define SORT_IDX_ENTRYSIZE 64
/** \var zebra_sort_index_t
\brief sort index handle
*/
typedef struct zebra_sort_index *zebra_sort_index_t;
#define ZEBRA_SORT_TYPE_FLAT 1
#define ZEBRA_SORT_TYPE_ISAMB 2
#define ZEBRA_SORT_TYPE_MULTI 3
/** \brief creates sort handle
\param bfs block files handle
\param write_flag (0=read-only, 1=write and read)
\param sort_type one of ZEBRA_SORT_TYPE_..
\return sort index handle
*/
zebra_sort_index_t zebra_sort_open(BFiles bfs, int write_flag, int sort_type);
/** \brief frees sort handle
*/
void zebra_sort_close(zebra_sort_index_t si);
/** \brief sets type for sort usage
\param si sort index handle
\param type opaque type .. A sort file for each type is created
*/
int zebra_sort_type(zebra_sort_index_t si, int type);
/** \brief sets sort system number for read / add / delete
\param si sort index handle
\param sysno system number
*/
void zebra_sort_sysno(zebra_sort_index_t si, zint sysno);
/** \brief adds multi-map content to sort file
\param si sort index handle
\param section_id section of key
\param w one or more 0-terminted strings (thus an array)
zebra_sort_type and zebra_sort_sysno must be called prior to this
*/
void zebra_sort_add(zebra_sort_index_t si, zint section_id, WRBUF w);
/** \brief delete sort entry
\param si sort index handle
\param section_id section of sort key to be deleted
zebra_sort_type and zebra_sort_sysno must be called prior to this
*/
void zebra_sort_delete(zebra_sort_index_t si, zint section_id);
/** \brief reads sort entry
\param si sort index handle
\param section_id output section ID (may be NULL and it will not be set)
\param w resulting buffer
\retval 0 could not be read
\retval 1 could be read (found)
*/
int zebra_sort_read(zebra_sort_index_t si, zint *section_id, WRBUF w);
YAZ_END_CDECL
#endif
/*
* Local variables:
* c-basic-offset: 4
* c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
|
