1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.properties.spi.config.ds;
17
18 import java.io.Serializable;
19
20 /**
21 * Interface to describe the structure of a data base that contains properties
22 * information.
23 */
24 public interface PropertiesDataSourceDescriptor extends Serializable
25 {
26 // ********************************* Fields *********************************
27
28 // --- constants ------------------------------------------------------------
29
30 // ****************************** Initializer *******************************
31
32 // ****************************** Inner Classes *****************************
33
34 // ********************************* Methods ********************************
35
36 // --- get&set --------------------------------------------------------------
37
38 /**
39 * Returns the identifier of the data source.
40 *
41 * @return the identifier of the data source.
42 */
43 String getDataSourceId();
44
45 /**
46 * Returns the name of the configuration table.
47 *
48 * @return the name of the configuration table.
49 */
50 String getTable();
51
52 /**
53 * Returns the name of the configuration key column.
54 *
55 * @return the name of the configuration key column.
56 */
57 String getConfigColumn();
58
59 /**
60 * Returns the name of the property name column.
61 *
62 * @return the name of the property name column.
63 */
64 String getNameColumn();
65
66 /**
67 * Returns the name of the property value column.
68 *
69 * @return the name of the property value column.
70 */
71 String getValueColumn();
72
73 // --- business -------------------------------------------------------------
74
75 // --- object basics --------------------------------------------------------
76
77 }