include/sortidx.h

   1 /* This file is part of the Zebra server.
   2    Copyright (C) 1995-2008 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/version.h>
  25 #include <idzebra/bfile.h>
  26 #include <yaz/wrbuf.h>
  27
  28 YAZ_BEGIN_CDECL
  29
  30 #define SORT_IDX_ENTRYSIZE 64
  31
  32 /** \var zebra_sort_index_t
  33     \brief sort index handle
  34 */
  35 typedef struct zebra_sort_index *zebra_sort_index_t;
  36
  37 #define ZEBRA_SORT_TYPE_FLAT 1
  38 #define ZEBRA_SORT_TYPE_ISAMB 2
  39 #define ZEBRA_SORT_TYPE_MULTI 3
  40
  41
  42 /** \brief creates sort handle
  43     \param bfs block files handle
  44     \param write_flag (0=read-only, 1=write and read)
  45     \param sort_type one of ZEBRA_SORT_TYPE_..
  46     \return sort index handle
  47 */
  48 zebra_sort_index_t zebra_sort_open(BFiles bfs, int write_flag, int sort_type);
  49
  50 /** \brief frees sort handle
  51 */
  52 void zebra_sort_close(zebra_sort_index_t si);
  53
  54 /** \brief sets type for sort usage
  55     \param si sort index handle
  56     \param type opaque type .. A sort file for each type is created
  57 */
  58 int zebra_sort_type(zebra_sort_index_t si, int type);
  59
  60 /** \brief sets sort system number for read / add / delete
  61     \param si sort index handle
  62     \param sysno system number
  63 */
  64 void zebra_sort_sysno(zebra_sort_index_t si, zint sysno);
  65
  66 /** \brief adds content to sort file
  67     \param si sort index handle
  68     \param buf buffer content
  69     \param len length
  70
  71     zebra_sort_type and zebra_sort_sysno must be called prior to this
  72 */
  73 void zebra_sort_add(zebra_sort_index_t si, const char *buf, int len);
  74
  75
  76 /** \brief delete sort entry
  77     \param si sort index handle
  78
  79     zebra_sort_type and zebra_sort_sysno must be called prior to this
  80 */
  81 void zebra_sort_delete(zebra_sort_index_t si);
  82
  83 /** \brief reads sort entry
  84     \param si sort index handle
  85     \param buf 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, WRBUF w);
  90
  91 YAZ_END_CDECL
  92
  93 #endif
  94 /*
  95  * Local variables:
  96  * c-basic-offset: 4
  97  * indent-tabs-mode: nil
  98  * End:
  99  * vim: shiftwidth=4 tabstop=8 expandtab
 100  */
 101