~ubuntu-branches/ubuntu/karmic/cedar-backup2/karmic

« back to all changes in this revision

Viewing changes to doc/interface/private/CedarBackup2.xmlutil-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2005-12-13 16:13:31 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051213161331-dw0cj6f534u8oxgf
Tags: 2.7.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
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>CedarBackup2.xmlutil</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="CedarBackup2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://cedar-solutions.com/software/cedar-backup">CedarBackup2</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="CedarBackup2-module.html">Package&nbsp;CedarBackup2</a> ::
 
33
        Module&nbsp;xmlutil
 
34
      </b></font></br>
 
35
    </td>
 
36
    <td><table cellpadding="0" cellspacing="0">
 
37
      <tr><td align="right"><font size="-2">[<b>show&nbsp;private</b>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="../private/CedarBackup2.xmlutil-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF MODULE DESCRIPTION =========== -->
 
43
<h2 class="module">Module CedarBackup2.xmlutil</h2>
 
44
 
 
45
<p>Provides general XML-related functionality.</p>
 
46
<p>What I'm trying to do here is abstract much of the functionality that 
 
47
directly accesses the DOM tree. This is not so much to 
 
48
&quot;protect&quot; the other code from the DOM, but to standardize the 
 
49
way it's used. It will also help extension authors write code that easily 
 
50
looks more like the rest of Cedar Backup.</p>
 
51
This module is one of the few pieces of code in the CedarBackup2 
 
52
package that requires functionality outside of the Python 2.3 standard 
 
53
library. It requires the PyXML package, mostly for the pretty-print 
 
54
functionality provided there.
 
55
<hr/>
 
56
<p><b>Author:</b> Kenneth J. Pronovici &lt;pronovic&#64;ieee.org&gt;
 
57
</p>
 
58
 
 
59
 
 
60
<!-- =========== START OF CLASSES =========== -->
 
61
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
62
<tr bgcolor="#70b0f0" class="summary">
 
63
  <th colspan="2">Classes</th></tr>
 
64
<tr><td width="15%">
 
65
  <b><a href="../private/CedarBackup2.xmlutil.Serializer-class.html"><code>Serializer</code></a></b></td>
 
66
  <td>XML serializer class.</td></tr>
 
67
</table><br />
 
68
 
 
69
 
 
70
<!-- =========== START OF FUNCTION SUMMARY =========== -->
 
71
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
72
<tr bgcolor="#70b0f0" class="summary">
 
73
  <th colspan="2">Function Summary</th></tr>
 
74
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
75
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#createInputDom" class="summary-sig-name"><code>createInputDom</code></a>(<span class=summary-sig-arg>xmlData</span>,
 
76
          <span class=summary-sig-arg>name</span>)</span></code>
 
77
<br />
 
78
Creates a DOM tree based on reading an XML string.</td></tr>
 
79
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
80
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#createOutputDom" class="summary-sig-name"><code>createOutputDom</code></a>(<span class=summary-sig-arg>name</span>)</span></code>
 
81
<br />
 
82
Creates a DOM tree used for writing an XML document.</td></tr>
 
83
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
84
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#serializeDom" class="summary-sig-name"><code>serializeDom</code></a>(<span class=summary-sig-arg>xmlDom</span>,
 
85
          <span class=summary-sig-arg>indent</span>)</span></code>
 
86
<br />
 
87
Serializes a DOM tree and returns the result in a string.</td></tr>
 
88
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
89
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#isElement" class="summary-sig-name"><code>isElement</code></a>(<span class=summary-sig-arg>node</span>)</span></code>
 
90
<br />
 
91
Returns True or False depending on whether the XML node is an element 
 
92
node.</td></tr>
 
93
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
94
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#readChildren" class="summary-sig-name"><code>readChildren</code></a>(<span class=summary-sig-arg>parent</span>,
 
95
          <span class=summary-sig-arg>name</span>)</span></code>
 
96
<br />
 
97
Returns a list of nodes with a given name immediately beneath the 
 
98
parent.</td></tr>
 
99
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
100
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#readFirstChild" class="summary-sig-name"><code>readFirstChild</code></a>(<span class=summary-sig-arg>parent</span>,
 
101
          <span class=summary-sig-arg>name</span>)</span></code>
 
102
<br />
 
103
Returns the first child with a given name immediately beneath the 
 
104
parent.</td></tr>
 
105
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
106
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#readStringList" class="summary-sig-name"><code>readStringList</code></a>(<span class=summary-sig-arg>parent</span>,
 
107
          <span class=summary-sig-arg>name</span>)</span></code>
 
108
<br />
 
109
Returns a list of the string contents associated with nodes with a 
 
110
given name immediately beneath the parent.</td></tr>
 
111
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
112
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#readString" class="summary-sig-name"><code>readString</code></a>(<span class=summary-sig-arg>parent</span>,
 
113
          <span class=summary-sig-arg>name</span>)</span></code>
 
114
<br />
 
115
Returns string contents of the first child with a given name 
 
116
immediately beneath the parent.</td></tr>
 
117
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
118
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#readInteger" class="summary-sig-name"><code>readInteger</code></a>(<span class=summary-sig-arg>parent</span>,
 
119
          <span class=summary-sig-arg>name</span>)</span></code>
 
120
<br />
 
121
Returns integer contents of the first child with a given name 
 
122
immediately beneath the parent.</td></tr>
 
123
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
124
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#readBoolean" class="summary-sig-name"><code>readBoolean</code></a>(<span class=summary-sig-arg>parent</span>,
 
125
          <span class=summary-sig-arg>name</span>)</span></code>
 
126
<br />
 
127
Returns boolean contents of the first child with a given name 
 
128
immediately beneath the parent.</td></tr>
 
129
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
130
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#addContainerNode" class="summary-sig-name"><code>addContainerNode</code></a>(<span class=summary-sig-arg>xmlDom</span>,
 
131
          <span class=summary-sig-arg>parentNode</span>,
 
132
          <span class=summary-sig-arg>nodeName</span>)</span></code>
 
133
<br />
 
134
Adds a container node as the next child of a parent node.</td></tr>
 
135
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
136
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#addStringNode" class="summary-sig-name"><code>addStringNode</code></a>(<span class=summary-sig-arg>xmlDom</span>,
 
137
          <span class=summary-sig-arg>parentNode</span>,
 
138
          <span class=summary-sig-arg>nodeName</span>,
 
139
          <span class=summary-sig-arg>nodeValue</span>)</span></code>
 
140
<br />
 
141
Adds a text node as the next child of a parent, to contain a 
 
142
string.</td></tr>
 
143
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
144
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#addIntegerNode" class="summary-sig-name"><code>addIntegerNode</code></a>(<span class=summary-sig-arg>xmlDom</span>,
 
145
          <span class=summary-sig-arg>parentNode</span>,
 
146
          <span class=summary-sig-arg>nodeName</span>,
 
147
          <span class=summary-sig-arg>nodeValue</span>)</span></code>
 
148
<br />
 
149
Adds a text node as the next child of a parent, to contain an 
 
150
integer.</td></tr>
 
151
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
152
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#addBooleanNode" class="summary-sig-name"><code>addBooleanNode</code></a>(<span class=summary-sig-arg>xmlDom</span>,
 
153
          <span class=summary-sig-arg>parentNode</span>,
 
154
          <span class=summary-sig-arg>nodeName</span>,
 
155
          <span class=summary-sig-arg>nodeValue</span>)</span></code>
 
156
<br />
 
157
Adds a text node as the next child of a parent, to contain a 
 
158
boolean.</td></tr>
 
159
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
160
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#_encodeText" class="summary-sig-name"><code>_encodeText</code></a>(<span class=summary-sig-arg>text</span>,
 
161
          <span class=summary-sig-arg>encoding</span>)</span></code>
 
162
</td></tr>
 
163
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
164
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#_translateCDATA" class="summary-sig-name"><code>_translateCDATA</code></a>(<span class=summary-sig-arg>characters</span>,
 
165
          <span class=summary-sig-arg>encoding</span>,
 
166
          <span class=summary-sig-arg>prev_chars</span>,
 
167
          <span class=summary-sig-arg>markupSafe</span>)</span></code>
 
168
</td></tr>
 
169
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
170
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.xmlutil-module.html#_translateCDATAAttr" class="summary-sig-name"><code>_translateCDATAAttr</code></a>(<span class=summary-sig-arg>characters</span>)</span></code>
 
171
<br />
 
172
Handles normalization and some intelligence about quoting.</td></tr>
 
173
</table><br />
 
174
 
 
175
 
 
176
<!-- =========== START OF VARIABLE SUMMARY =========== -->
 
177
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
178
<tr bgcolor="#70b0f0" class="summary">
 
179
  <th colspan="2">Variable Summary</th></tr>
 
180
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
181
<td><b><a href="../private/CedarBackup2.xmlutil-module.html#TRUE_BOOLEAN_VALUES"><code>TRUE_BOOLEAN_VALUES</code></a></b>: List of boolean values in XML representing <code>True</code>.</td></tr>
 
182
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
183
<td><b><a href="../private/CedarBackup2.xmlutil-module.html#FALSE_BOOLEAN_VALUES"><code>FALSE_BOOLEAN_VALUES</code></a></b>: List of boolean values in XML representing <code>False</code>.</td></tr>
 
184
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
185
<td><b><a href="../private/CedarBackup2.xmlutil-module.html#VALID_BOOLEAN_VALUES"><code>VALID_BOOLEAN_VALUES</code></a></b>: List of valid boolean values in XML.</td></tr>
 
186
</table><br />
 
187
 
 
188
 
 
189
<!-- =========== START OF FUNCTION DETAILS =========== -->
 
190
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
191
<tr bgcolor="#70b0f0" class="details">
 
192
  <th colspan="2">Function Details</th></tr>
 
193
</table>
 
194
 
 
195
<a name="createInputDom"></a>
 
196
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
197
  <h3><span class="sig"><span class="sig-name">createInputDom</span>(<span class=sig-arg>xmlData</span>,
 
198
          <span class=sig-arg>name</span>=<span class=sig-default>'cb_config'</span>)</span>
 
199
  </h3>
 
200
  Creates a DOM tree based on reading an XML string.
 
201
  <dl><dt></dt><dd>
 
202
    <dl><dt><b>Parameters:</b></dt>
 
203
      <dd><code><b>name</b></code> -
 
204
         Assumed base name of the document (root node name).
 
205
      </dd>
 
206
    </dl>
 
207
    <dl><dt><b>Returns:</b></dt>
 
208
      <dd>
 
209
        Tuple (xmlDom, parentNode) for the parsed document
 
210
      </dd>
 
211
    </dl>
 
212
    <dl><dt><b>Raises:</b></dt>
 
213
      <dd><code><b>ValueError</b></code> -
 
214
        If the document can't be parsed.
 
215
    </dl>
 
216
  </dd></dl>
 
217
</td></tr></table>
 
218
 
 
219
<a name="createOutputDom"></a>
 
220
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
221
  <h3><span class="sig"><span class="sig-name">createOutputDom</span>(<span class=sig-arg>name</span>=<span class=sig-default>'cb_config'</span>)</span>
 
222
  </h3>
 
223
  Creates a DOM tree used for writing an XML document.
 
224
  <dl><dt></dt><dd>
 
225
    <dl><dt><b>Parameters:</b></dt>
 
226
      <dd><code><b>name</b></code> -
 
227
         Base name of the document (root node name).
 
228
      </dd>
 
229
    </dl>
 
230
    <dl><dt><b>Returns:</b></dt>
 
231
      <dd>
 
232
        Tuple (xmlDom, parentNode) for the new document
 
233
      </dd>
 
234
    </dl>
 
235
  </dd></dl>
 
236
</td></tr></table>
 
237
 
 
238
<a name="serializeDom"></a>
 
239
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
240
  <h3><span class="sig"><span class="sig-name">serializeDom</span>(<span class=sig-arg>xmlDom</span>,
 
241
          <span class=sig-arg>indent</span>=<span class=sig-default>3</span>)</span>
 
242
  </h3>
 
243
  Serializes a DOM tree and returns the result in a string.
 
244
  <dl><dt></dt><dd>
 
245
    <dl><dt><b>Parameters:</b></dt>
 
246
      <dd><code><b>xmlDom</b></code> -
 
247
         XML DOM tree to serialize
 
248
      <dd><code><b>indent</b></code> -
 
249
         Number of spaces to indent, as an integer
 
250
      </dd>
 
251
    </dl>
 
252
    <dl><dt><b>Returns:</b></dt>
 
253
      <dd>
 
254
        String form of DOM tree, pretty-printed.
 
255
      </dd>
 
256
    </dl>
 
257
  </dd></dl>
 
258
</td></tr></table>
 
259
 
 
260
<a name="isElement"></a>
 
261
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
262
  <h3><span class="sig"><span class="sig-name">isElement</span>(<span class=sig-arg>node</span>)</span>
 
263
  </h3>
 
264
  Returns True or False depending on whether the XML node is an 
 
265
  element node.
 
266
  <dl><dt></dt><dd>
 
267
  </dd></dl>
 
268
</td></tr></table>
 
269
 
 
270
<a name="readChildren"></a>
 
271
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
272
  <h3><span class="sig"><span class="sig-name">readChildren</span>(<span class=sig-arg>parent</span>,
 
273
          <span class=sig-arg>name</span>)</span>
 
274
  </h3>
 
275
  <p>Returns a list of nodes with a given name immediately beneath the 
 
276
  parent.</p>
 
277
  <p>By &quot;immediately beneath&quot; the parent, we mean from among 
 
278
  nodes that are direct children of the passed-in parent node.</p>
 
279
  Underneath, we use the Python <code>getElementsByTagName</code> 
 
280
  method, which is pretty cool, but which (surprisingly?) returns a list 
 
281
  of all children with a given name below the parent, at any level. We 
 
282
  just prune that list to include only children whose 
 
283
  <code>parentNode</code> matches the passed-in parent.
 
284
  <dl><dt></dt><dd>
 
285
    <dl><dt><b>Parameters:</b></dt>
 
286
      <dd><code><b>parent</b></code> -
 
287
         Parent node to search beneath.
 
288
      <dd><code><b>name</b></code> -
 
289
         Name of nodes to search for.
 
290
      </dd>
 
291
    </dl>
 
292
    <dl><dt><b>Returns:</b></dt>
 
293
      <dd>
 
294
        List of child nodes with correct parent, or an empty list if 
 
295
        no matching nodes are found.
 
296
      </dd>
 
297
    </dl>
 
298
  </dd></dl>
 
299
</td></tr></table>
 
300
 
 
301
<a name="readFirstChild"></a>
 
302
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
303
  <h3><span class="sig"><span class="sig-name">readFirstChild</span>(<span class=sig-arg>parent</span>,
 
304
          <span class=sig-arg>name</span>)</span>
 
305
  </h3>
 
306
  <p>Returns the first child with a given name immediately beneath the 
 
307
  parent.</p>
 
308
  By &quot;immediately beneath&quot; the parent, we mean from among 
 
309
  nodes that are direct children of the passed-in parent node.
 
310
  <dl><dt></dt><dd>
 
311
    <dl><dt><b>Parameters:</b></dt>
 
312
      <dd><code><b>parent</b></code> -
 
313
         Parent node to search beneath.
 
314
      <dd><code><b>name</b></code> -
 
315
         Name of node to search for.
 
316
      </dd>
 
317
    </dl>
 
318
    <dl><dt><b>Returns:</b></dt>
 
319
      <dd>
 
320
        First properly-named child of parent, or <code>None</code> if 
 
321
        no matching nodes are found.
 
322
      </dd>
 
323
    </dl>
 
324
  </dd></dl>
 
325
</td></tr></table>
 
326
 
 
327
<a name="readStringList"></a>
 
328
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
329
  <h3><span class="sig"><span class="sig-name">readStringList</span>(<span class=sig-arg>parent</span>,
 
330
          <span class=sig-arg>name</span>)</span>
 
331
  </h3>
 
332
  <p>Returns a list of the string contents associated with nodes with a 
 
333
  given name immediately beneath the parent.</p>
 
334
  <p>By &quot;immediately beneath&quot; the parent, we mean from among 
 
335
  nodes that are direct children of the passed-in parent node.</p>
 
336
  First, we find all of the nodes using <a 
 
337
  href="../private/CedarBackup2.xmlutil-module.html#readChildren" 
 
338
  class="link"><code>readChildren</code></a>, and then we retrieve the 
 
339
  &quot;string contents&quot; of each of those nodes. The returned list 
 
340
  has one entry per matching node. We assume that string contents of a 
 
341
  given node belong to the first <code>TEXT_NODE</code> child of that 
 
342
  node. Nodes which have no <code>TEXT_NODE</code> children are not 
 
343
  represented in the returned list.
 
344
  <dl><dt></dt><dd>
 
345
    <dl><dt><b>Parameters:</b></dt>
 
346
      <dd><code><b>parent</b></code> -
 
347
         Parent node to search beneath.
 
348
      <dd><code><b>name</b></code> -
 
349
         Name of node to search for.
 
350
      </dd>
 
351
    </dl>
 
352
    <dl><dt><b>Returns:</b></dt>
 
353
      <dd>
 
354
        List of strings as described above, or <code>None</code> if no 
 
355
        matching nodes are found.
 
356
      </dd>
 
357
    </dl>
 
358
  </dd></dl>
 
359
</td></tr></table>
 
360
 
 
361
<a name="readString"></a>
 
362
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
363
  <h3><span class="sig"><span class="sig-name">readString</span>(<span class=sig-arg>parent</span>,
 
364
          <span class=sig-arg>name</span>)</span>
 
365
  </h3>
 
366
  <p>Returns string contents of the first child with a given name 
 
367
  immediately beneath the parent.</p>
 
368
  By &quot;immediately beneath&quot; the parent, we mean from among 
 
369
  nodes that are direct children of the passed-in parent node. We assume 
 
370
  that string contents of a given node belong to the first 
 
371
  <code>TEXT_NODE</code> child of that node.
 
372
  <dl><dt></dt><dd>
 
373
    <dl><dt><b>Parameters:</b></dt>
 
374
      <dd><code><b>parent</b></code> -
 
375
         Parent node to search beneath.
 
376
      <dd><code><b>name</b></code> -
 
377
         Name of node to search for.
 
378
      </dd>
 
379
    </dl>
 
380
    <dl><dt><b>Returns:</b></dt>
 
381
      <dd>
 
382
        String contents of node or <code>None</code> if no matching 
 
383
        nodes are found.
 
384
      </dd>
 
385
    </dl>
 
386
  </dd></dl>
 
387
</td></tr></table>
 
388
 
 
389
<a name="readInteger"></a>
 
390
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
391
  <h3><span class="sig"><span class="sig-name">readInteger</span>(<span class=sig-arg>parent</span>,
 
392
          <span class=sig-arg>name</span>)</span>
 
393
  </h3>
 
394
  <p>Returns integer contents of the first child with a given name 
 
395
  immediately beneath the parent.</p>
 
396
  By &quot;immediately beneath&quot; the parent, we mean from among 
 
397
  nodes that are direct children of the passed-in parent node.
 
398
  <dl><dt></dt><dd>
 
399
    <dl><dt><b>Parameters:</b></dt>
 
400
      <dd><code><b>parent</b></code> -
 
401
         Parent node to search beneath.
 
402
      <dd><code><b>name</b></code> -
 
403
         Name of node to search for.
 
404
      </dd>
 
405
    </dl>
 
406
    <dl><dt><b>Returns:</b></dt>
 
407
      <dd>
 
408
        Integer contents of node or <code>None</code> if no matching 
 
409
        nodes are found.
 
410
      </dd>
 
411
    </dl>
 
412
    <dl><dt><b>Raises:</b></dt>
 
413
      <dd><code><b>ValueError</b></code> -
 
414
        If the string at the location can't be converted to an 
 
415
        integer.
 
416
    </dl>
 
417
  </dd></dl>
 
418
</td></tr></table>
 
419
 
 
420
<a name="readBoolean"></a>
 
421
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
422
  <h3><span class="sig"><span class="sig-name">readBoolean</span>(<span class=sig-arg>parent</span>,
 
423
          <span class=sig-arg>name</span>)</span>
 
424
  </h3>
 
425
  <p>Returns boolean contents of the first child with a given name 
 
426
  immediately beneath the parent.</p>
 
427
  <p>By &quot;immediately beneath&quot; the parent, we mean from among 
 
428
  nodes that are direct children of the passed-in parent node.</p>
 
429
  The string value of the node must be one of the values in <a 
 
430
  href="../private/CedarBackup2.xmlutil-module.html#VALID_BOOLEAN_VALUES" 
 
431
  class="link"><code>VALID_BOOLEAN_VALUES</code></a>.
 
432
  <dl><dt></dt><dd>
 
433
    <dl><dt><b>Parameters:</b></dt>
 
434
      <dd><code><b>parent</b></code> -
 
435
         Parent node to search beneath.
 
436
      <dd><code><b>name</b></code> -
 
437
         Name of node to search for.
 
438
      </dd>
 
439
    </dl>
 
440
    <dl><dt><b>Returns:</b></dt>
 
441
      <dd>
 
442
        Boolean contents of node or <code>None</code> if no matching 
 
443
        nodes are found.
 
444
      </dd>
 
445
    </dl>
 
446
    <dl><dt><b>Raises:</b></dt>
 
447
      <dd><code><b>ValueError</b></code> -
 
448
        If the string at the location can't be converted to a 
 
449
        boolean.
 
450
    </dl>
 
451
  </dd></dl>
 
452
</td></tr></table>
 
453
 
 
454
<a name="addContainerNode"></a>
 
455
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
456
  <h3><span class="sig"><span class="sig-name">addContainerNode</span>(<span class=sig-arg>xmlDom</span>,
 
457
          <span class=sig-arg>parentNode</span>,
 
458
          <span class=sig-arg>nodeName</span>)</span>
 
459
  </h3>
 
460
  Adds a container node as the next child of a parent node.
 
461
  <dl><dt></dt><dd>
 
462
    <dl><dt><b>Parameters:</b></dt>
 
463
      <dd><code><b>xmlDom</b></code> -
 
464
         DOM tree as from <code>impl.createDocument()</code>.
 
465
      <dd><code><b>parentNode</b></code> -
 
466
         Parent node to create child for.
 
467
      <dd><code><b>nodeName</b></code> -
 
468
         Name of the new container node.
 
469
      </dd>
 
470
    </dl>
 
471
    <dl><dt><b>Returns:</b></dt>
 
472
      <dd>
 
473
        Reference to the newly-created node.
 
474
      </dd>
 
475
    </dl>
 
476
  </dd></dl>
 
477
</td></tr></table>
 
478
 
 
479
<a name="addStringNode"></a>
 
480
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
481
  <h3><span class="sig"><span class="sig-name">addStringNode</span>(<span class=sig-arg>xmlDom</span>,
 
482
          <span class=sig-arg>parentNode</span>,
 
483
          <span class=sig-arg>nodeName</span>,
 
484
          <span class=sig-arg>nodeValue</span>)</span>
 
485
  </h3>
 
486
  <p>Adds a text node as the next child of a parent, to contain a 
 
487
  string.</p>
 
488
  If the <code>nodeValue</code> is None, then the node will be 
 
489
  created, but will be empty (i.e. will contain no text node child).
 
490
  <dl><dt></dt><dd>
 
491
    <dl><dt><b>Parameters:</b></dt>
 
492
      <dd><code><b>xmlDom</b></code> -
 
493
         DOM tree as from <code>impl.createDocument()</code>.
 
494
      <dd><code><b>parentNode</b></code> -
 
495
         Parent node to create child for.
 
496
      <dd><code><b>nodeName</b></code> -
 
497
         Name of the new container node.
 
498
      <dd><code><b>nodeValue</b></code> -
 
499
         The value to put into the node.
 
500
      </dd>
 
501
    </dl>
 
502
    <dl><dt><b>Returns:</b></dt>
 
503
      <dd>
 
504
        Reference to the newly-created node.
 
505
      </dd>
 
506
    </dl>
 
507
  </dd></dl>
 
508
</td></tr></table>
 
509
 
 
510
<a name="addIntegerNode"></a>
 
511
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
512
  <h3><span class="sig"><span class="sig-name">addIntegerNode</span>(<span class=sig-arg>xmlDom</span>,
 
513
          <span class=sig-arg>parentNode</span>,
 
514
          <span class=sig-arg>nodeName</span>,
 
515
          <span class=sig-arg>nodeValue</span>)</span>
 
516
  </h3>
 
517
  <p>Adds a text node as the next child of a parent, to contain an 
 
518
  integer.</p>
 
519
  <p>If the <code>nodeValue</code> is None, then the node will be 
 
520
  created, but will be empty (i.e. will contain no text node child).</p>
 
521
  The integer will be converted to a string using &quot;%d&quot;. The 
 
522
  result will be added to the document via <a 
 
523
  href="../private/CedarBackup2.xmlutil-module.html#addStringNode" 
 
524
  class="link"><code>addStringNode</code></a>.
 
525
  <dl><dt></dt><dd>
 
526
    <dl><dt><b>Parameters:</b></dt>
 
527
      <dd><code><b>xmlDom</b></code> -
 
528
         DOM tree as from <code>impl.createDocument()</code>.
 
529
      <dd><code><b>parentNode</b></code> -
 
530
         Parent node to create child for.
 
531
      <dd><code><b>nodeName</b></code> -
 
532
         Name of the new container node.
 
533
      <dd><code><b>nodeValue</b></code> -
 
534
         The value to put into the node.
 
535
      </dd>
 
536
    </dl>
 
537
    <dl><dt><b>Returns:</b></dt>
 
538
      <dd>
 
539
        Reference to the newly-created node.
 
540
      </dd>
 
541
    </dl>
 
542
  </dd></dl>
 
543
</td></tr></table>
 
544
 
 
545
<a name="addBooleanNode"></a>
 
546
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
547
  <h3><span class="sig"><span class="sig-name">addBooleanNode</span>(<span class=sig-arg>xmlDom</span>,
 
548
          <span class=sig-arg>parentNode</span>,
 
549
          <span class=sig-arg>nodeName</span>,
 
550
          <span class=sig-arg>nodeValue</span>)</span>
 
551
  </h3>
 
552
  <p>Adds a text node as the next child of a parent, to contain a 
 
553
  boolean.</p>
 
554
  <p>If the <code>nodeValue</code> is None, then the node will be 
 
555
  created, but will be empty (i.e. will contain no text node child).</p>
 
556
  Boolean <code>True</code>, or anything else interpreted as 
 
557
  <code>True</code> by Python, will be converted to a string 
 
558
  &quot;Y&quot;. Anything else will be converted to a string 
 
559
  &quot;N&quot;. The result is added to the document via <a 
 
560
  href="../private/CedarBackup2.xmlutil-module.html#addStringNode" 
 
561
  class="link"><code>addStringNode</code></a>.
 
562
  <dl><dt></dt><dd>
 
563
    <dl><dt><b>Parameters:</b></dt>
 
564
      <dd><code><b>xmlDom</b></code> -
 
565
         DOM tree as from <code>impl.createDocument()</code>.
 
566
      <dd><code><b>parentNode</b></code> -
 
567
         Parent node to create child for.
 
568
      <dd><code><b>nodeName</b></code> -
 
569
         Name of the new container node.
 
570
      <dd><code><b>nodeValue</b></code> -
 
571
         The value to put into the node.
 
572
      </dd>
 
573
    </dl>
 
574
    <dl><dt><b>Returns:</b></dt>
 
575
      <dd>
 
576
        Reference to the newly-created node.
 
577
      </dd>
 
578
    </dl>
 
579
  </dd></dl>
 
580
</td></tr></table>
 
581
 
 
582
<a name="_encodeText"></a>
 
583
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
584
  <h3><span class="sig"><span class="sig-name">_encodeText</span>(<span class=sig-arg>text</span>,
 
585
          <span class=sig-arg>encoding</span>)</span>
 
586
  </h3>
 
587
  <dl><dt></dt><dd>
 
588
<p><b>Copyright:</b> This code, prior to customization, was part of the PyXML codebase, and 
 
589
before that was part of the 4DOM suite developed by Fourthought, Inc. It 
 
590
its original form, it was attributed to Martin v. L�wis and was Copyright 
 
591
(c) 2000 Fourthought Inc, USA; All Rights Reserved.
 
592
</p>
 
593
 
 
594
  </dd></dl>
 
595
</td></tr></table>
 
596
 
 
597
<a name="_translateCDATA"></a>
 
598
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
599
  <h3><span class="sig"><span class="sig-name">_translateCDATA</span>(<span class=sig-arg>characters</span>,
 
600
          <span class=sig-arg>encoding</span>=<span class=sig-default>'UTF-8'</span>,
 
601
          <span class=sig-arg>prev_chars</span>=<span class=sig-default>''</span>,
 
602
          <span class=sig-arg>markupSafe</span>=<span class=sig-default>0</span>)</span>
 
603
  </h3>
 
604
  <dl><dt></dt><dd>
 
605
<p><b>Copyright:</b> This code, prior to customization, was part of the PyXML codebase, and 
 
606
before that was part of the 4DOM suite developed by Fourthought, Inc. It 
 
607
its original form, it was Copyright (c) 2000 Fourthought Inc, USA; All 
 
608
Rights Reserved.
 
609
</p>
 
610
 
 
611
  </dd></dl>
 
612
</td></tr></table>
 
613
 
 
614
<a name="_translateCDATAAttr"></a>
 
615
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
616
  <h3><span class="sig"><span class="sig-name">_translateCDATAAttr</span>(<span class=sig-arg>characters</span>)</span>
 
617
  </h3>
 
618
  Handles normalization and some intelligence about quoting.
 
619
  <dl><dt></dt><dd>
 
620
<p><b>Copyright:</b> This code, prior to customization, was part of the PyXML codebase, and 
 
621
before that was part of the 4DOM suite developed by Fourthought, Inc. It 
 
622
its original form, it was Copyright (c) 2000 Fourthought Inc, USA; All 
 
623
Rights Reserved.
 
624
</p>
 
625
 
 
626
  </dd></dl>
 
627
</td></tr></table>
 
628
<br />
 
629
 
 
630
 
 
631
<!-- =========== START OF VARIABLE DETAILS =========== -->
 
632
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
633
<tr bgcolor="#70b0f0" class="details">
 
634
  <th colspan="2">Variable Details</th></tr>
 
635
</table>
 
636
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
637
<a name="TRUE_BOOLEAN_VALUES"></a>
 
638
<h3>TRUE_BOOLEAN_VALUES</h3>
 
639
List of boolean values in XML representing <code>True</code>.
 
640
<dl>
 
641
  <dt></dt>
 
642
  <dd>
 
643
    <dl>
 
644
      <dt><b>Type:</b></dt>
 
645
      <dd>
 
646
          <code>list</code>
 
647
 
 
648
      </dd>
 
649
<span title="['Y', 'y']">      <dt><b>Value:</b></dt>
 
650
      <dd><table><tr><td>
 
651
<pre class="variable">
 
652
['Y', 'y']                                                             </pre>
 
653
        </td></tr></table></dd>
 
654
</span>    </dl>
 
655
  </dd>
 
656
</dl></td></tr></table>
 
657
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
658
<a name="FALSE_BOOLEAN_VALUES"></a>
 
659
<h3>FALSE_BOOLEAN_VALUES</h3>
 
660
List of boolean values in XML representing <code>False</code>.
 
661
<dl>
 
662
  <dt></dt>
 
663
  <dd>
 
664
    <dl>
 
665
      <dt><b>Type:</b></dt>
 
666
      <dd>
 
667
          <code>list</code>
 
668
 
 
669
      </dd>
 
670
<span title="['N', 'n']">      <dt><b>Value:</b></dt>
 
671
      <dd><table><tr><td>
 
672
<pre class="variable">
 
673
['N', 'n']                                                             </pre>
 
674
        </td></tr></table></dd>
 
675
</span>    </dl>
 
676
  </dd>
 
677
</dl></td></tr></table>
 
678
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
679
<a name="VALID_BOOLEAN_VALUES"></a>
 
680
<h3>VALID_BOOLEAN_VALUES</h3>
 
681
List of valid boolean values in XML.
 
682
<dl>
 
683
  <dt></dt>
 
684
  <dd>
 
685
    <dl>
 
686
      <dt><b>Type:</b></dt>
 
687
      <dd>
 
688
          <code>list</code>
 
689
 
 
690
      </dd>
 
691
<span title="['Y', 'y', 'N', 'n']">      <dt><b>Value:</b></dt>
 
692
      <dd><table><tr><td>
 
693
<pre class="variable">
 
694
['Y', 'y', 'N', 'n']                                                   </pre>
 
695
        </td></tr></table></dd>
 
696
</span>    </dl>
 
697
  </dd>
 
698
</dl></td></tr></table>
 
699
<br />
 
700
 
 
701
 
 
702
<!-- =========== START OF NAVBAR =========== -->
 
703
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
704
  <tr valign="center">
 
705
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="CedarBackup2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
706
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
707
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
708
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
709
    <th class="navbar" align="right" width="100%">
 
710
      <table border="0" cellpadding="0" cellspacing="0">
 
711
      <tr><th class="navbar" align="center">
 
712
        <p class="nomargin">
 
713
          <a class="navbar" target="_top" href="http://cedar-solutions.com/software/cedar-backup">CedarBackup2</a>
 
714
      </p></th></tr></table>
 
715
    </th>
 
716
  </tr>
 
717
</table>
 
718
 
 
719
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
720
  <tr>
 
721
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Dec 13 16:00:22 2005</font></td>
 
722
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
723
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
724
  </tr>
 
725
</table>
 
726
</body>
 
727
</html>