root/gsdl/trunk/lib/dbclass.h @ 15650

Revision 15650, 3.2 KB (checked in by mdewsnip, 12 years ago)

(Adding new DB support) Adding some more comments, and making the setkeydata() function compulsory as well.

RevLine 
[15436]1/**********************************************************************
2 *
3 * dbclass.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 DBCLASS_H
27#define DBCLASS_H
28
29
30#include "text_t.h"
31#include "infodbclass.h"
32
33#if defined(GSDL_USE_OBJECTSPACE)
34#  include <ospace\std\iostream>
35#  include <ospace\std\fstream>
36#elif defined(GSDL_USE_IOS_H)
37#  include <iostream.h>
38#  include <fstream.h>
39#else
40#  include <iostream>
41#  include <fstream>
42#endif
43
44
[15557]45#define DB_READER         1
46#define DB_WRITER         2
47#define DB_WRITER_CREATE  3
48
49
[15436]50class dbclass
51{
52public:
53  dbclass() { logout = &cerr; }
[15557]54  virtual ~dbclass();
[15436]55
[15650]56  // Must be implemented by subclasses; returns true if opened
[15645]57  virtual bool opendatabase (const text_t &filename, int mode, int num_retrys, bool need_filelock) = 0;
[15557]58
[15650]59  // Must be implemented by subclasses
[15645]60  virtual void closedatabase () = 0;
61
[15650]62  // Must be implemented by subclasses
[15645]63  virtual void deletekey (const text_t &key) = 0;
64
[15650]65  // Must be implemented by subclasses; returns true if exists
[15645]66  virtual bool exists (const text_t& key) = 0;
[15585]67
[15650]68  // Must be implemented by subclasses; returns true on success
[15645]69  virtual bool getinfo (const text_t& key, infodbclass &info) = 0;
[15557]70
[15650]71  // Must be implemented by subclasses; returns true on success
[15645]72  virtual bool getkeydata (const text_t& key, text_t &data) = 0;
[15585]73
[15650]74  // Must be implemented by subclasses; returns array of keys
[15630]75  virtual text_tarray getkeys () = 0;
[15585]76
[15650]77  // Must be implemented by subclasses; returns true on success
[15645]78  virtual bool setinfo (const text_t &key, const infodbclass &info) = 0;
[15585]79
[15650]80  // Must be implemented by subclasses; returns true on success
81  virtual bool setkeydata (const text_t &key, const text_t &data) = 0;
82
83
84  void setlogout (ostream *logout_arg) { logout = logout_arg; }
85
[15598]86  // replaces the .c, .p, .n, .l syntax (child, parent, next, previous)
87  // it expects child, parent, etc. to exist if syntax has been used
88  // so you should test before using
89  text_t translate_OID(const text_t &OID, infodbclass &info);
90
[15436]91protected:
92  ostream *logout;
[15598]93
94  void get_first_child (text_t &OID, infodbclass &info);
95  void get_last_child (text_t &OID, infodbclass &info);
96  void get_next_sibling (text_t &OID, infodbclass &info);
97  void get_previous_sibling (text_t &OID, infodbclass &info);
[15436]98};
99
100
101#endif
Note: See TracBrowser for help on using the browser.