root/gsdl/trunk/common-src/src/lib/gdbmclass.h @ 18050

Revision 18050, 2.4 KB (checked in by mdewsnip, 11 years ago)

Moved the txtgz code into a new function to tidy up the opendatabase() function, and marked it as deprecated since it will no longer be necessary now that the GDBM library reads both little and big endian databases.

Line 
1/**********************************************************************
2 *
3 * gdbmclass.h --
4 * Copyright (C) 1999-2008  The New Zealand Digital Library Project
5 *
6 * A component of the Greenstone digital library software
7 * from the New Zealand Digital Library Project at the
8 * University of Waikato, New Zealand.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 *
24 *********************************************************************/
25
26#ifndef GDBMCLASS_H
27#define GDBMCLASS_H
28
29
30#include "gsdlconf.h"
31#include "dbclass.h"
32
33#ifdef __WIN32__
34
35#ifdef __cplusplus
36  extern "C" {
37#endif
38#include "autoconf.h"
39#include "systems.h"
40#include "gdbmconst.h"
41#include "gdbm.h"
42#ifdef __cplusplus
43  }
44#endif
45
46#else
47#include <gdbm.h>
48#endif
49
50
51class gdbmclass : public dbclass
52{
53public:
54  gdbmclass() { gdbmfile = NULL; };
55  ~gdbmclass();
56
57  // returns true if opened
58  bool opendatabase (const text_t &filename, int mode, int num_retrys, bool need_filelock);
59
60  void closedatabase ();
61
62  void deletekey (const text_t &key);
63
64  // returns file extension string
65  text_t getfileextension ();
66
67  // returns true on success
68  bool getkeydata (const text_t& key, text_t &data);
69
70  // returns array of keys
71  text_tarray getkeys ();
72
73  // returns true on success
74  bool setkeydata (const text_t &key, const text_t &data);
75
76protected:
77  text_t openfile;
78  GDBM_FILE gdbmfile;
79
80  // getfirstkey and getnextkey are used for traversing the database
81  // no insertions or deletions should be carried out while traversing
82  // the database. when there are no keys left to visit in the database
83  // an empty string is returned.
84  text_t getfirstkey ();
85  text_t getnextkey (const text_t &key);
86
87  // DEPRECATED -- No longer necessary now that the GDBM library reads both little-endian and big-endian
88  void generate_from_txtgz (text_t filename);
89};
90
91
92#endif
Note: See TracBrowser for help on using the browser.