1 | // |
---|
2 | // ConfigurationMapper.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Util/include/Poco/Util/ConfigurationMapper.h#1 $ |
---|
5 | // |
---|
6 | // Library: Util |
---|
7 | // Package: Configuration |
---|
8 | // Module: ConfigurationMapper |
---|
9 | // |
---|
10 | // Definition of the ConfigurationMapper class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Util_ConfigurationMapper_INCLUDED |
---|
40 | #define Util_ConfigurationMapper_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Util/Util.h" |
---|
44 | #include "Poco/Util/AbstractConfiguration.h" |
---|
45 | |
---|
46 | |
---|
47 | namespace Poco { |
---|
48 | namespace Util { |
---|
49 | |
---|
50 | |
---|
51 | class Util_API ConfigurationMapper: public AbstractConfiguration |
---|
52 | /// This configuration maps a property hierarchy into another |
---|
53 | /// hierarchy. |
---|
54 | /// |
---|
55 | /// For example, given a configuration with the following properties: |
---|
56 | /// config.value1 |
---|
57 | /// config.value2 |
---|
58 | /// config.sub.value1 |
---|
59 | /// config.sub.value2 |
---|
60 | /// and a ConfigurationView with fromPrefix == "config" and toPrefix == "root.conf", then |
---|
61 | /// the above properties will be available via the mapper as |
---|
62 | /// root.conf.value1 |
---|
63 | /// root.conf.value2 |
---|
64 | /// root.conf.sub.value1 |
---|
65 | /// root.conf.sub.value2 |
---|
66 | /// |
---|
67 | /// FromPrefix can be empty, in which case, and given toPrefix == "root", |
---|
68 | /// the properties will be available as |
---|
69 | /// root.config.value1 |
---|
70 | /// root.config.value2 |
---|
71 | /// root.config.sub.value1 |
---|
72 | /// root.config.sub.value2 |
---|
73 | /// |
---|
74 | /// This is equivalent to the functionality of the ConfigurationView class. |
---|
75 | /// |
---|
76 | /// Similarly, toPrefix can also be empty. Given fromPrefix == "config" and |
---|
77 | /// toPrefix == "", the properties will be available as |
---|
78 | /// value1 |
---|
79 | /// value2 |
---|
80 | /// sub.value1 |
---|
81 | /// sub.value2 |
---|
82 | /// |
---|
83 | /// If both fromPrefix and toPrefix are empty, no mapping is performed. |
---|
84 | /// |
---|
85 | /// A ConfigurationMapper is most useful in combination with a |
---|
86 | /// LayeredConfiguration. |
---|
87 | { |
---|
88 | public: |
---|
89 | ConfigurationMapper(const std::string& fromPrefix, const std::string& toPrefix, AbstractConfiguration* pConfig); |
---|
90 | /// Creates the ConfigurationMapper. The ConfigurationMapper does not take |
---|
91 | /// ownership of the passed configuration. |
---|
92 | |
---|
93 | protected: |
---|
94 | bool getRaw(const std::string& key, std::string& value) const; |
---|
95 | void setRaw(const std::string& key, const std::string& value); |
---|
96 | void enumerate(const std::string& key, Keys& range) const; |
---|
97 | |
---|
98 | std::string translateKey(const std::string& key) const; |
---|
99 | |
---|
100 | ~ConfigurationMapper(); |
---|
101 | |
---|
102 | private: |
---|
103 | ConfigurationMapper(const ConfigurationMapper&); |
---|
104 | ConfigurationMapper& operator = (const ConfigurationMapper&); |
---|
105 | |
---|
106 | std::string _fromPrefix; |
---|
107 | std::string _toPrefix; |
---|
108 | AbstractConfiguration* _pConfig; |
---|
109 | }; |
---|
110 | |
---|
111 | |
---|
112 | } } // namespace Poco::Util |
---|
113 | |
---|
114 | |
---|
115 | #endif // Util_ConfigurationMapper_INCLUDED |
---|