1 | /*
|
---|
2 | * FlatDatabaseWrapper.java
|
---|
3 | * Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
|
---|
4 | *
|
---|
5 | * This program is free software; you can redistribute it and/or modify
|
---|
6 | * it under the terms of the GNU General Public License as published by
|
---|
7 | * the Free Software Foundation; either version 2 of the License, or
|
---|
8 | * (at your option) any later version.
|
---|
9 | *
|
---|
10 | * This program is distributed in the hope that it will be useful,
|
---|
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
13 | * GNU General Public License for more details.
|
---|
14 | *
|
---|
15 | * You should have received a copy of the GNU General Public License
|
---|
16 | * along with this program; if not, write to the Free Software
|
---|
17 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
18 | */
|
---|
19 | package org.greenstone.gsdl3.util;
|
---|
20 |
|
---|
21 | public interface FlatDatabaseWrapper {
|
---|
22 |
|
---|
23 | /* just read access, many readers can share a database */
|
---|
24 | public final static int READ = 0;
|
---|
25 | /* read/write, exclusive access */
|
---|
26 | public final static int WRITE = 1;
|
---|
27 |
|
---|
28 | // do we want the other modes?
|
---|
29 | // -- read/write - create if doesn't exist
|
---|
30 | // -- read/write - create a new database
|
---|
31 | /** open database named filename, using mode */
|
---|
32 | public boolean openDatabase(String filename, int mode);
|
---|
33 |
|
---|
34 | /** close the database associated with this wrapper */
|
---|
35 | public void closeDatabase();
|
---|
36 |
|
---|
37 | /** returns the value associated with the key */
|
---|
38 | public String getValue(String key);
|
---|
39 |
|
---|
40 | /** sets the given key to the given value in the database */
|
---|
41 | public boolean setValue(String key, String value);
|
---|
42 |
|
---|
43 | /** deletes the given key from the database */
|
---|
44 | public boolean deleteKey(String key);
|
---|
45 |
|
---|
46 | /** returns a string of key-value entries that can be
|
---|
47 | * printed for debugging purposes*/
|
---|
48 | public String displayAllEntries();
|
---|
49 | }
|
---|
50 |
|
---|