include/sortidx.h

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