root/gsdl/trunk/lib/gdbmclass.h @ 15630

Revision 15630, 2.6 KB (checked in by mdewsnip, 12 years ago)

(Adding new DB support) Replaced the "getfirstkey()" and "getnextkey()" functions in dbclass with "getkeys()" (which returns them all). These functions were only used in userdb.cpp, and having the one function is simpler without being (much) less efficient. Also, implementing getkeys() for the new sql db classes will be easier than getfirstkey() and getnextkey().

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,
59             bool need_filelock);
60  void closedatabase ();
61
62  // returns true on success
63  bool getinfo (const text_t& key, infodbclass &info);
64
65  // returns true if exists
66  bool exists (const text_t& key);
67
68  // returns true on success
69  bool setinfo (const text_t &key, const infodbclass &info);
70  // returns true on success
71  bool setinfo (const text_t &key, const text_t &data);
72
73  void deletekey (const text_t &key);
74
75  text_tarray getkeys ();
76
77    // returns true on success
78  bool getkeydata (const text_t& key, text_t &data);
79
80protected:
81  text_t openfile;
82  GDBM_FILE gdbmfile;
83
84  // getfirstkey and getnextkey are used for traversing the database
85  // no insertions or deletions should be carried out while traversing
86  // the database. when there are no keys left to visit in the database
87  // an empty string is returned.
88  text_t getfirstkey ();
89  text_t getnextkey (const text_t &key);
90
91  // returns true on success
92  bool getinfoline (text_t::iterator &here, text_t::iterator end,
93           text_t &key, text_t &value);
94};
95
96
97#endif
Note: See TracBrowser for help on using the browser.