|
1 <?xml version="1.0" encoding="ascii"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
5 <head> |
|
6 <title>configuration.NestedConfigurationBuilder</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="configuration-module.html">Module configuration</a> :: |
|
38 Class NestedConfigurationBuilder |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="configuration.NestedConfigurationBuilder-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class NestedConfigurationBuilder</h1><span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="configuration.ConfigurationBuilder-class.html">ConfigurationBuilder</a> --+ |
|
60 | |
|
61 <strong class="uidshort">NestedConfigurationBuilder</strong> |
|
62 </pre> |
|
63 |
|
64 <hr /> |
|
65 Builder for building Configuration objects from nested configurations.<br /><br /> |
|
66 |
|
67 <!-- ==================== INSTANCE METHODS ==================== --> |
|
68 <a name="section-InstanceMethods"></a> |
|
69 <table class="summary" border="1" cellpadding="3" |
|
70 cellspacing="0" width="100%" bgcolor="white"> |
|
71 <tr bgcolor="#70b0f0" class="table-header"> |
|
72 <td colspan="2" class="table-header"> |
|
73 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
74 <tr valign="top"> |
|
75 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
76 <td align="right" valign="top" |
|
77 ><span class="options">[<a href="#section-InstanceMethods" |
|
78 class="privatelink" onclick="toggle_private();" |
|
79 >hide private</a>]</span></td> |
|
80 </tr> |
|
81 </table> |
|
82 </td> |
|
83 </tr> |
|
84 <tr> |
|
85 <td width="15%" align="right" valign="top" class="summary"> |
|
86 <span class="summary-type"> </span> |
|
87 </td><td class="summary"> |
|
88 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
89 <tr> |
|
90 <td><span class="summary-sig"><a href="configuration.NestedConfigurationBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
91 <span class="summary-sig-arg">inputfile</span>, |
|
92 <span class="summary-sig-arg">configname</span>=<span class="summary-sig-default">''</span>)</span><br /> |
|
93 Initialization.</td> |
|
94 <td align="right" valign="top"> |
|
95 <span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.__init__">source code</a></span> |
|
96 |
|
97 </td> |
|
98 </tr> |
|
99 </table> |
|
100 |
|
101 </td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td width="15%" align="right" valign="top" class="summary"> |
|
105 <span class="summary-type"> </span> |
|
106 </td><td class="summary"> |
|
107 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
108 <tr> |
|
109 <td><span class="summary-sig"><a href="configuration.NestedConfigurationBuilder-class.html#getConfiguration" class="summary-sig-name">getConfiguration</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
110 Returns a ConfigurationSet object.</td> |
|
111 <td align="right" valign="top"> |
|
112 <span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.getConfiguration">source code</a></span> |
|
113 |
|
114 </td> |
|
115 </tr> |
|
116 </table> |
|
117 |
|
118 </td> |
|
119 </tr> |
|
120 <tr> |
|
121 <td width="15%" align="right" valign="top" class="summary"> |
|
122 <span class="summary-type"> </span> |
|
123 </td><td class="summary"> |
|
124 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
125 <tr> |
|
126 <td><span class="summary-sig"><a href="configuration.NestedConfigurationBuilder-class.html#getConfigurations" class="summary-sig-name">getConfigurations</a>(<span class="summary-sig-arg">self</span>, |
|
127 <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>, |
|
128 <span class="summary-sig-arg">type</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
129 Get a list of the individual configurations.</td> |
|
130 <td align="right" valign="top"> |
|
131 <span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.getConfigurations">source code</a></span> |
|
132 |
|
133 </td> |
|
134 </tr> |
|
135 </table> |
|
136 |
|
137 </td> |
|
138 </tr> |
|
139 <tr> |
|
140 <td width="15%" align="right" valign="top" class="summary"> |
|
141 <span class="summary-type"> </span> |
|
142 </td><td class="summary"> |
|
143 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
144 <tr> |
|
145 <td><span class="summary-sig"><a name="getReferences"></a><span class="summary-sig-name">getReferences</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
146 <td align="right" valign="top"> |
|
147 <span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.getReferences">source code</a></span> |
|
148 |
|
149 </td> |
|
150 </tr> |
|
151 </table> |
|
152 |
|
153 </td> |
|
154 </tr> |
|
155 <tr> |
|
156 <td width="15%" align="right" valign="top" class="summary"> |
|
157 <span class="summary-type"> </span> |
|
158 </td><td class="summary"> |
|
159 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
160 <tr> |
|
161 <td><span class="summary-sig"><a name="parseConfiguration"></a><span class="summary-sig-name">parseConfiguration</span>(<span class="summary-sig-arg">self</span>, |
|
162 <span class="summary-sig-arg">configNode</span>, |
|
163 <span class="summary-sig-arg">configs</span>, |
|
164 <span class="summary-sig-arg">parentConfig</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
165 Parse an individual nested configuration.</td> |
|
166 <td align="right" valign="top"> |
|
167 <span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.parseConfiguration">source code</a></span> |
|
168 |
|
169 </td> |
|
170 </tr> |
|
171 </table> |
|
172 |
|
173 </td> |
|
174 </tr> |
|
175 <tr> |
|
176 <td width="15%" align="right" valign="top" class="summary"> |
|
177 <span class="summary-type"> </span> |
|
178 </td><td class="summary"> |
|
179 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
180 <tr> |
|
181 <td><span class="summary-sig"><a name="getNodeByReference"></a><span class="summary-sig-name">getNodeByReference</span>(<span class="summary-sig-arg">self</span>, |
|
182 <span class="summary-sig-arg">refName</span>)</span><br /> |
|
183 Find a node based on a reference to it.</td> |
|
184 <td align="right" valign="top"> |
|
185 <span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.getNodeByReference">source code</a></span> |
|
186 |
|
187 </td> |
|
188 </tr> |
|
189 </table> |
|
190 |
|
191 </td> |
|
192 </tr> |
|
193 <tr> |
|
194 <td colspan="2" class="summary"> |
|
195 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
196 <code>__delattr__</code>, |
|
197 <code>__getattribute__</code>, |
|
198 <code>__hash__</code>, |
|
199 <code>__new__</code>, |
|
200 <code>__reduce__</code>, |
|
201 <code>__reduce_ex__</code>, |
|
202 <code>__repr__</code>, |
|
203 <code>__setattr__</code>, |
|
204 <code>__str__</code> |
|
205 </p> |
|
206 </td> |
|
207 </tr> |
|
208 </table> |
|
209 <!-- ==================== CLASS VARIABLES ==================== --> |
|
210 <a name="section-ClassVariables"></a> |
|
211 <table class="summary" border="1" cellpadding="3" |
|
212 cellspacing="0" width="100%" bgcolor="white"> |
|
213 <tr bgcolor="#70b0f0" class="table-header"> |
|
214 <td colspan="2" class="table-header"> |
|
215 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
216 <tr valign="top"> |
|
217 <td align="left"><span class="table-header">Class Variables</span></td> |
|
218 <td align="right" valign="top" |
|
219 ><span class="options">[<a href="#section-ClassVariables" |
|
220 class="privatelink" onclick="toggle_private();" |
|
221 >hide private</a>]</span></td> |
|
222 </tr> |
|
223 </table> |
|
224 </td> |
|
225 </tr> |
|
226 <tr class="private"> |
|
227 <td width="15%" align="right" valign="top" class="summary"> |
|
228 <span class="summary-type"> </span> |
|
229 </td><td class="summary"> |
|
230 <a href="configuration.NestedConfigurationBuilder-class.html#_constructors" class="summary-name">_constructors</a> = <code title="{'spec': Specification, 'config': NestedConfiguration}">{'spec': Specification, 'config': NestedConfig<code class="variable-ellipsis">...</code></code> |
|
231 </td> |
|
232 </tr> |
|
233 </table> |
|
234 <!-- ==================== PROPERTIES ==================== --> |
|
235 <a name="section-Properties"></a> |
|
236 <table class="summary" border="1" cellpadding="3" |
|
237 cellspacing="0" width="100%" bgcolor="white"> |
|
238 <tr bgcolor="#70b0f0" class="table-header"> |
|
239 <td colspan="2" class="table-header"> |
|
240 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
241 <tr valign="top"> |
|
242 <td align="left"><span class="table-header">Properties</span></td> |
|
243 <td align="right" valign="top" |
|
244 ><span class="options">[<a href="#section-Properties" |
|
245 class="privatelink" onclick="toggle_private();" |
|
246 >hide private</a>]</span></td> |
|
247 </tr> |
|
248 </table> |
|
249 </td> |
|
250 </tr> |
|
251 <tr> |
|
252 <td colspan="2" class="summary"> |
|
253 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
254 <code>__class__</code> |
|
255 </p> |
|
256 </td> |
|
257 </tr> |
|
258 </table> |
|
259 <!-- ==================== METHOD DETAILS ==================== --> |
|
260 <a name="section-MethodDetails"></a> |
|
261 <table class="details" border="1" cellpadding="3" |
|
262 cellspacing="0" width="100%" bgcolor="white"> |
|
263 <tr bgcolor="#70b0f0" class="table-header"> |
|
264 <td colspan="2" class="table-header"> |
|
265 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
266 <tr valign="top"> |
|
267 <td align="left"><span class="table-header">Method Details</span></td> |
|
268 <td align="right" valign="top" |
|
269 ><span class="options">[<a href="#section-MethodDetails" |
|
270 class="privatelink" onclick="toggle_private();" |
|
271 >hide private</a>]</span></td> |
|
272 </tr> |
|
273 </table> |
|
274 </td> |
|
275 </tr> |
|
276 </table> |
|
277 <a name="__init__"></a> |
|
278 <div> |
|
279 <table class="details" border="1" cellpadding="3" |
|
280 cellspacing="0" width="100%" bgcolor="white"> |
|
281 <tr><td> |
|
282 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
283 <tr valign="top"><td> |
|
284 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
285 <span class="sig-arg">inputfile</span>, |
|
286 <span class="sig-arg">configname</span>=<span class="sig-default">''</span>)</span> |
|
287 <br /><em class="fname">(Constructor)</em> |
|
288 </h3> |
|
289 </td><td align="right" valign="top" |
|
290 ><span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.__init__">source code</a></span> |
|
291 </td> |
|
292 </table> |
|
293 |
|
294 Initialization. |
|
295 <dl class="fields"> |
|
296 <dt>Overrides: |
|
297 object.__init__ |
|
298 </dt> |
|
299 </dl> |
|
300 </td></tr></table> |
|
301 </div> |
|
302 <a name="getConfiguration"></a> |
|
303 <div> |
|
304 <table class="details" border="1" cellpadding="3" |
|
305 cellspacing="0" width="100%" bgcolor="white"> |
|
306 <tr><td> |
|
307 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
308 <tr valign="top"><td> |
|
309 <h3 class="epydoc"><span class="sig"><span class="sig-name">getConfiguration</span>(<span class="sig-arg">self</span>)</span> |
|
310 </h3> |
|
311 </td><td align="right" valign="top" |
|
312 ><span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.getConfiguration">source code</a></span> |
|
313 </td> |
|
314 </table> |
|
315 |
|
316 <p>Returns a ConfigurationSet object.</p> |
|
317 <p>A ConfigurationSet represents a number of Configuration objects |
|
318 that all may need to be processed.</p> |
|
319 <dl class="fields"> |
|
320 <dt>Overrides: |
|
321 <a href="configuration.ConfigurationBuilder-class.html#getConfiguration">ConfigurationBuilder.getConfiguration</a> |
|
322 </dt> |
|
323 </dl> |
|
324 </td></tr></table> |
|
325 </div> |
|
326 <a name="getConfigurations"></a> |
|
327 <div> |
|
328 <table class="details" border="1" cellpadding="3" |
|
329 cellspacing="0" width="100%" bgcolor="white"> |
|
330 <tr><td> |
|
331 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
332 <tr valign="top"><td> |
|
333 <h3 class="epydoc"><span class="sig"><span class="sig-name">getConfigurations</span>(<span class="sig-arg">self</span>, |
|
334 <span class="sig-arg">name</span>=<span class="sig-default">None</span>, |
|
335 <span class="sig-arg">type</span>=<span class="sig-default">None</span>)</span> |
|
336 </h3> |
|
337 </td><td align="right" valign="top" |
|
338 ><span class="codelink"><a href="configuration-pysrc.html#NestedConfigurationBuilder.getConfigurations">source code</a></span> |
|
339 </td> |
|
340 </table> |
|
341 |
|
342 <p>Get a list of the individual configurations.</p> |
|
343 <p>Once read a new builder must be opened to retrieve a differently filtered set of configurations.</p> |
|
344 <dl class="fields"> |
|
345 </dl> |
|
346 </td></tr></table> |
|
347 </div> |
|
348 <br /> |
|
349 <!-- ==================== CLASS VARIABLE DETAILS ==================== --> |
|
350 <a name="section-ClassVariableDetails"></a> |
|
351 <table class="details" border="1" cellpadding="3" |
|
352 cellspacing="0" width="100%" bgcolor="white"> |
|
353 <tr bgcolor="#70b0f0" class="table-header"> |
|
354 <td colspan="2" class="table-header"> |
|
355 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
356 <tr valign="top"> |
|
357 <td align="left"><span class="table-header">Class Variable Details</span></td> |
|
358 <td align="right" valign="top" |
|
359 ><span class="options">[<a href="#section-ClassVariableDetails" |
|
360 class="privatelink" onclick="toggle_private();" |
|
361 >hide private</a>]</span></td> |
|
362 </tr> |
|
363 </table> |
|
364 </td> |
|
365 </tr> |
|
366 </table> |
|
367 <a name="_constructors"></a> |
|
368 <div class="private"> |
|
369 <table class="details" border="1" cellpadding="3" |
|
370 cellspacing="0" width="100%" bgcolor="white"> |
|
371 <tr><td> |
|
372 <h3 class="epydoc">_constructors</h3> |
|
373 |
|
374 <dl class="fields"> |
|
375 </dl> |
|
376 <dl class="fields"> |
|
377 <dt>Value:</dt> |
|
378 <dd><table><tr><td><pre class="variable"> |
|
379 {'spec': Specification, 'config': NestedConfiguration} |
|
380 </pre></td></tr></table> |
|
381 </dd> |
|
382 </dl> |
|
383 </td></tr></table> |
|
384 </div> |
|
385 <br /> |
|
386 <!-- ==================== NAVIGATION BAR ==================== --> |
|
387 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
388 bgcolor="#a0c0ff" cellspacing="0"> |
|
389 <tr valign="middle"> |
|
390 |
|
391 <!-- Tree link --> |
|
392 <th> <a |
|
393 href="module-tree.html">Trees</a> </th> |
|
394 |
|
395 <!-- Index link --> |
|
396 <th> <a |
|
397 href="identifier-index.html">Indices</a> </th> |
|
398 |
|
399 <!-- Help link --> |
|
400 <th> <a |
|
401 href="help.html">Help</a> </th> |
|
402 |
|
403 <th class="navbar" width="100%"></th> |
|
404 </tr> |
|
405 </table> |
|
406 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
407 <tr> |
|
408 <td align="left" class="footer"> |
|
409 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
410 </td> |
|
411 <td align="right" class="footer"> |
|
412 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
413 </td> |
|
414 </tr> |
|
415 </table> |
|
416 |
|
417 <script type="text/javascript"> |
|
418 <!-- |
|
419 // Private objects are initially displayed (because if |
|
420 // javascript is turned off then we want them to be |
|
421 // visible); but by default, we want to hide them. So hide |
|
422 // them unless we have a cookie that says to show them. |
|
423 checkCookie() |
|
424 // --> |
|
425 </script> |
|
426 |
|
427 </body> |
|
428 </html> |