1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>log4cpp: log4cpp::PropertyConfiguratorImpl Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<div class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html">PropertyConfiguratorImpl</a></div>
<h1>log4cpp::PropertyConfiguratorImpl Class Reference</h1><code>#include <<a class="el" href="PropertyConfiguratorImpl_8hh-source.html">PropertyConfiguratorImpl.hh</a>></code>
<p>
Collaboration diagram for log4cpp::PropertyConfiguratorImpl:<p><center><img src="classlog4cpp_1_1PropertyConfiguratorImpl__coll__graph.png" border="0" usemap="#log4cpp_1_1PropertyConfiguratorImpl__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1PropertyConfiguratorImpl__coll__map">
<area href="classlog4cpp_1_1Properties.html" shape="rect" coords="53,9,189,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cpp_1_1PropertyConfiguratorImpl-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map< std::string,<br>
<a class="el" href="classlog4cpp_1_1Appender.html">Appender</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#w0">AppenderMap</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#a0">PropertyConfiguratorImpl</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#a1">~PropertyConfiguratorImpl</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#a2">doConfigure</a> (const std::string &initFileName) throw (ConfigureFailure)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#a3">doConfigure</a> (std::istream &in) throw (ConfigureFailure)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#b0">configureCategory</a> (const std::string &categoryname) throw (ConfigureFailure)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">configure the given category. <a href="#b0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#b1">getCategories</a> (std::vector< std::string > &categories) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the categories contained within the map of properties. <a href="#b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#b2">instantiateAllAppenders</a> () throw (ConfigureFailure)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1Appender.html">Appender</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#b3">instantiateAppender</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Intantiate and configure the appender referred to by the given name. <a href="#b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#b4">setLayout</a> (<a class="el" href="classlog4cpp_1_1Appender.html">Appender</a> *appender, const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method for instantiating and configuring the layouts associated with each appender. <a href="#b4"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1Properties.html">Properties</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#p0">_properties</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#w0">AppenderMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#p1">_allAppenders</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="log4cpp::PropertyConfiguratorImpl::AppenderMap"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef std::map<std::string, <a class="el" href="classlog4cpp_1_1Appender.html">Appender</a>*> <a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#w0">log4cpp::PropertyConfiguratorImpl::AppenderMap</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="log4cpp::PropertyConfiguratorImpl::PropertyConfiguratorImpl"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">log4cpp::PropertyConfiguratorImpl::PropertyConfiguratorImpl </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="log4cpp::PropertyConfiguratorImpl::~PropertyConfiguratorImpl"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">log4cpp::PropertyConfiguratorImpl::~PropertyConfiguratorImpl </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b0" doxytag="log4cpp::PropertyConfiguratorImpl::configureCategory"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::PropertyConfiguratorImpl::configureCategory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>categoryname</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
configure the given category.
<p>
This includes setting its <a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> and adding any Appenders. <dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>setting other properties like 'additivity'.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>categoryname</em> </td><td>Name of the category to configure. The name 'rootCategory' refers to the root <a class="el" href="classlog4cpp_1_1Category.html">Category</a>. throw <a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a> </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="log4cpp::PropertyConfiguratorImpl::doConfigure"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::PropertyConfiguratorImpl::doConfigure </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::istream & </td>
<td class="mdname1" valign="top" nowrap> <em>in</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="log4cpp::PropertyConfiguratorImpl::doConfigure"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::PropertyConfiguratorImpl::doConfigure </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>initFileName</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="b1" doxytag="log4cpp::PropertyConfiguratorImpl::getCategories"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::PropertyConfiguratorImpl::getCategories </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< std::string > & </td>
<td class="mdname1" valign="top" nowrap> <em>categories</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the categories contained within the map of properties.
<p>
This simply extracts the categories from the map. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>categories</em> </td><td>Reference to a list which is to receive the list of categories. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b2" doxytag="log4cpp::PropertyConfiguratorImpl::instantiateAllAppenders"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::PropertyConfiguratorImpl::instantiateAllAppenders </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="b3" doxytag="log4cpp::PropertyConfiguratorImpl::instantiateAppender"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Appender.html">Appender</a> * log4cpp::PropertyConfiguratorImpl::instantiateAppender </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Intantiate and configure the appender referred to by the given name.
<p>
This method searches the map to find all configuration parameters for the appender, and adds the appender to the given category. This isn't very general in the sense that it will need to be modified for each type of appender and layout. A more general solution would be to define an "options" interface for each appender and layout, so that we can simply call this method with a list of options instead of needing to know what is or is not available. This would also require some generic way of instantiating an object for which we have no knowledge. An "AppenderFactory" could be used which maps the given type to an actual object class registered with the factory (?? is this possible?). <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>String containing the name of the type of appender to be instantiated. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b4" doxytag="log4cpp::PropertyConfiguratorImpl::setLayout"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::PropertyConfiguratorImpl::setLayout </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Appender.html">Appender</a> * </td>
<td class="mdname" nowrap> <em>appender</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>name</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Method for instantiating and configuring the layouts associated with each appender.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appender</em> </td><td><a class="el" href="classlog4cpp_1_1Appender.html">Appender</a> to which we are setting this layout. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name in the properties of this appender. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p1" doxytag="log4cpp::PropertyConfiguratorImpl::_allAppenders"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#w0">AppenderMap</a> <a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#p1">log4cpp::PropertyConfiguratorImpl::_allAppenders</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="p0" doxytag="log4cpp::PropertyConfiguratorImpl::_properties"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Properties.html">Properties</a> <a class="el" href="classlog4cpp_1_1PropertyConfiguratorImpl.html#p0">log4cpp::PropertyConfiguratorImpl::_properties</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="PropertyConfiguratorImpl_8hh-source.html">PropertyConfiguratorImpl.hh</a><li><a class="el" href="PropertyConfiguratorImpl_8cpp.html">PropertyConfiguratorImpl.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jul 29 14:13:21 2005 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
