01: /**
02: * com.mckoi.dbcontrol.DBConfig 27 Mar 2002
03: *
04: * Mckoi SQL Database ( http://www.mckoi.com/database )
05: * Copyright (C) 2000, 2001, 2002 Diehl and Associates, Inc.
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License
09: * Version 2 as published by the Free Software Foundation.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License Version 2 for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * Version 2 along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19: *
20: * Change Log:
21: *
22: *
23: */package com.mckoi.database.control;
24:
25: import java.io.File;
26:
27: /**
28: * A container object of configuration details of a database system. This
29: * object can be used to programmatically setup configuration properies
30: * in a database system.
31: *
32: * @author Tobias Downer
33: */
34:
35: public interface DBConfig {
36:
37: /**
38: * Returns the current path set for this configuration. This is
39: * useful if the configuration is based on a configuration file that has
40: * path references relative to the configuration file. In this case,
41: * the path returned here would be the path to the configuration
42: * file.
43: */
44: File currentPath();
45:
46: /**
47: * Returns the value that was set for the configuration property with the
48: * given name.
49: * <p>
50: * This method must always returns a value that the database engine can use
51: * provided the 'property_key' is a supported key. If the property key
52: * is not supported and the key was not set, null is returned.
53: */
54: String getValue(String property_key);
55:
56: /**
57: * Makes an immutable copy of this configuration.
58: */
59: DBConfig immutableCopy();
60:
61: }
|