/usr/share/doc/cedar-backup3-doc/interface/CedarBackup3.xmlutil-module.html is in cedar-backup3-doc 3.1.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup3.xmlutil</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup3-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/cedarsolutions/cedar-backup3">CedarBackup3</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup3-module.html">Package CedarBackup3</a> ::
Module xmlutil
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup3.xmlutil-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module xmlutil</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html">source code</a></span></p>
<p>Provides general XML-related functionality.</p>
<p>What I'm trying to do here is abstract much of the functionality that
directly accesses the DOM tree. This is not so much to
"protect" the other code from the DOM, but to standardize the
way it's used. It will also help extension authors write code that
easily looks more like the rest of Cedar Backup.</p>
<hr />
<div class="fields"> <p><strong>Author:</strong>
Kenneth J. Pronovici <pronovic@ieee.org>
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup3.xmlutil.Serializer-class.html" class="summary-name">Serializer</a><br />
XML serializer class.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#createInputDom" class="summary-sig-name">createInputDom</a>(<span class="summary-sig-arg">xmlData</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">cb_config</code><code class="variable-quote">'</code></span>)</span><br />
Creates a DOM tree based on reading an XML string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#createInputDom">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#createOutputDom" class="summary-sig-name">createOutputDom</a>(<span class="summary-sig-arg">name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">cb_config</code><code class="variable-quote">'</code></span>)</span><br />
Creates a DOM tree used for writing an XML document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#createOutputDom">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#serializeDom" class="summary-sig-name">serializeDom</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">3</span>)</span><br />
Serializes a DOM tree and returns the result in a string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#serializeDom">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="isElement"></a><span class="summary-sig-name">isElement</span>(<span class="summary-sig-arg">node</span>)</span><br />
Returns True or False depending on whether the XML node is an element
node.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#isElement">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readChildren" class="summary-sig-name">readChildren</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns a list of nodes with a given name immediately beneath the
parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readChildren">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readFirstChild" class="summary-sig-name">readFirstChild</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns the first child with a given name immediately beneath the
parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readFirstChild">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readStringList" class="summary-sig-name">readStringList</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns a list of the string contents associated with nodes with a
given name immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readStringList">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readString" class="summary-sig-name">readString</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns string contents of the first child with a given name
immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readString">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readInteger" class="summary-sig-name">readInteger</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns integer contents of the first child with a given name
immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readInteger">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readBoolean" class="summary-sig-name">readBoolean</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns boolean contents of the first child with a given name
immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readBoolean">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#addContainerNode" class="summary-sig-name">addContainerNode</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">nodeName</span>)</span><br />
Adds a container node as the next child of a parent node.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addContainerNode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#addStringNode" class="summary-sig-name">addStringNode</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">nodeName</span>,
<span class="summary-sig-arg">nodeValue</span>)</span><br />
Adds a text node as the next child of a parent, to contain a string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addStringNode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#addIntegerNode" class="summary-sig-name">addIntegerNode</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">nodeName</span>,
<span class="summary-sig-arg">nodeValue</span>)</span><br />
Adds a text node as the next child of a parent, to contain an
integer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addIntegerNode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#addBooleanNode" class="summary-sig-name">addBooleanNode</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">nodeName</span>,
<span class="summary-sig-arg">nodeValue</span>)</span><br />
Adds a text node as the next child of a parent, to contain a boolean.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addBooleanNode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readLong" class="summary-sig-name">readLong</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns long integer contents of the first child with a given name
immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readLong">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#readFloat" class="summary-sig-name">readFloat</a>(<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Returns float contents of the first child with a given name
immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readFloat">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#addLongNode" class="summary-sig-name">addLongNode</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">nodeName</span>,
<span class="summary-sig-arg">nodeValue</span>)</span><br />
Adds a text node as the next child of a parent, to contain a long
integer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addLongNode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_encodeText"></a><span class="summary-sig-name">_encodeText</span>(<span class="summary-sig-arg">text</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
Safely encodes the passed-in text as a Unicode string, converting
bytes to UTF-8 if necessary.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#_encodeText">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#_translateCDATAAttr" class="summary-sig-name" onclick="show_private();">_translateCDATAAttr</a>(<span class="summary-sig-arg">characters</span>)</span><br />
Handles normalization and some intelligence about quoting.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#_translateCDATAAttr">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup3.xmlutil-module.html#_translateCDATA" class="summary-sig-name" onclick="show_private();">_translateCDATA</a>(<span class="summary-sig-arg">characters</span>,
<span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">UTF-8</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">prev_chars</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">markupSafe</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#_translateCDATA">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="TRUE_BOOLEAN_VALUES"></a><span class="summary-name">TRUE_BOOLEAN_VALUES</span> = <code title="['Y', 'y']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Y</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">y</code><code class="variable-quote">'</code><code class="variable-group">]</code></code><br />
List of boolean values in XML representing <code>True</code>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="FALSE_BOOLEAN_VALUES"></a><span class="summary-name">FALSE_BOOLEAN_VALUES</span> = <code title="['N', 'n']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">N</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">n</code><code class="variable-quote">'</code><code class="variable-group">]</code></code><br />
List of boolean values in XML representing <code>False</code>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="VALID_BOOLEAN_VALUES"></a><span class="summary-name">VALID_BOOLEAN_VALUES</span> = <code title="['Y', 'y', 'N', 'n']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Y</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">y</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">N</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">n</code><code class="variable-quote">'</code><code class="variable-group">]</code></code><br />
List of valid boolean values in XML.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger("CedarBackup3.log.xml")">logging.getLogger("CedarBackup3.log.xml")</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'CedarBackup3'"><code class="variable-quote">'</code><code class="variable-string">CedarBackup3</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="createInputDom"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">createInputDom</span>(<span class="sig-arg">xmlData</span>,
<span class="sig-arg">name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">cb_config</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#createInputDom">source code</a></span>
</td>
</tr></table>
<p>Creates a DOM tree based on reading an XML string.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> - Assumed base name of the document (root node name).</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Tuple (xmlDom, parentNode) for the parsed document</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the document can't be parsed.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="createOutputDom"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">createOutputDom</span>(<span class="sig-arg">name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">cb_config</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#createOutputDom">source code</a></span>
</td>
</tr></table>
<p>Creates a DOM tree used for writing an XML document.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> - Base name of the document (root node name).</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Tuple (xmlDom, parentNode) for the new document</dd>
</dl>
</td></tr></table>
</div>
<a name="serializeDom"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">serializeDom</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">indent</span>=<span class="sig-default">3</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#serializeDom">source code</a></span>
</td>
</tr></table>
<p>Serializes a DOM tree and returns the result in a string.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - XML DOM tree to serialize</li>
<li><strong class="pname"><code>indent</code></strong> - Number of spaces to indent, as an integer</li>
</ul></dd>
<dt>Returns:</dt>
<dd>String form of DOM tree, pretty-printed.</dd>
</dl>
</td></tr></table>
</div>
<a name="readChildren"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readChildren</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readChildren">source code</a></span>
</td>
</tr></table>
<p>Returns a list of nodes with a given name immediately beneath the
parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<p>Underneath, we use the Python <code>getElementsByTagName</code>
method, which is pretty cool, but which (surprisingly?) returns a list of
all children with a given name below the parent, at any level. We just
prune that list to include only children whose <code>parentNode</code>
matches the passed-in parent.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of nodes to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List of child nodes with correct parent, or an empty list if no
matching nodes are found.</dd>
</dl>
</td></tr></table>
</div>
<a name="readFirstChild"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readFirstChild</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readFirstChild">source code</a></span>
</td>
</tr></table>
<p>Returns the first child with a given name immediately beneath the
parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>First properly-named child of parent, or <code>None</code> if no
matching nodes are found.</dd>
</dl>
</td></tr></table>
</div>
<a name="readStringList"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readStringList</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readStringList">source code</a></span>
</td>
</tr></table>
<p>Returns a list of the string contents associated with nodes with a
given name immediately beneath the parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<p>First, we find all of the nodes using <a
href="CedarBackup3.xmlutil-module.html#readChildren"
class="link">readChildren</a>, and then we retrieve the "string
contents" of each of those nodes. The returned list has one entry
per matching node. We assume that string contents of a given node belong
to the first <code>TEXT_NODE</code> child of that node. Nodes which have
no <code>TEXT_NODE</code> children are not represented in the returned
list.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List of strings as described above, or <code>None</code> if no
matching nodes are found.</dd>
</dl>
</td></tr></table>
</div>
<a name="readString"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readString</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readString">source code</a></span>
</td>
</tr></table>
<p>Returns string contents of the first child with a given name
immediately beneath the parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node. We assume
that string contents of a given node belong to the first
<code>TEXT_NODE</code> child of that node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>String contents of node or <code>None</code> if no matching nodes
are found.</dd>
</dl>
</td></tr></table>
</div>
<a name="readInteger"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readInteger</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readInteger">source code</a></span>
</td>
</tr></table>
<p>Returns integer contents of the first child with a given name
immediately beneath the parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Integer contents of node or <code>None</code> if no matching
nodes are found.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the string at the location can't be converted to an integer.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="readBoolean"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readBoolean</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readBoolean">source code</a></span>
</td>
</tr></table>
<p>Returns boolean contents of the first child with a given name
immediately beneath the parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<p>The string value of the node must be one of the values in <a
href="CedarBackup3.xmlutil-module.html#VALID_BOOLEAN_VALUES"
class="link">VALID_BOOLEAN_VALUES</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Boolean contents of node or <code>None</code> if no matching
nodes are found.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the string at the location can't be converted to a boolean.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addContainerNode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addContainerNode</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">nodeName</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addContainerNode">source code</a></span>
</td>
</tr></table>
<p>Adds a container node as the next child of a parent node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent node to create child for.</li>
<li><strong class="pname"><code>nodeName</code></strong> - Name of the new container node.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Reference to the newly-created node.</dd>
</dl>
</td></tr></table>
</div>
<a name="addStringNode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addStringNode</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">nodeName</span>,
<span class="sig-arg">nodeValue</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addStringNode">source code</a></span>
</td>
</tr></table>
<p>Adds a text node as the next child of a parent, to contain a
string.</p>
<p>If the <code>nodeValue</code> is None, then the node will be created,
but will be empty (i.e. will contain no text node child).</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent node to create child for.</li>
<li><strong class="pname"><code>nodeName</code></strong> - Name of the new container node.</li>
<li><strong class="pname"><code>nodeValue</code></strong> - The value to put into the node.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Reference to the newly-created node.</dd>
</dl>
</td></tr></table>
</div>
<a name="addIntegerNode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addIntegerNode</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">nodeName</span>,
<span class="sig-arg">nodeValue</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addIntegerNode">source code</a></span>
</td>
</tr></table>
<p>Adds a text node as the next child of a parent, to contain an
integer.</p>
<p>If the <code>nodeValue</code> is None, then the node will be created,
but will be empty (i.e. will contain no text node child).</p>
<p>The integer will be converted to a string using "%d". The
result will be added to the document via <a
href="CedarBackup3.xmlutil-module.html#addStringNode"
class="link">addStringNode</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent node to create child for.</li>
<li><strong class="pname"><code>nodeName</code></strong> - Name of the new container node.</li>
<li><strong class="pname"><code>nodeValue</code></strong> - The value to put into the node.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Reference to the newly-created node.</dd>
</dl>
</td></tr></table>
</div>
<a name="addBooleanNode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addBooleanNode</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">nodeName</span>,
<span class="sig-arg">nodeValue</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addBooleanNode">source code</a></span>
</td>
</tr></table>
<p>Adds a text node as the next child of a parent, to contain a
boolean.</p>
<p>If the <code>nodeValue</code> is None, then the node will be created,
but will be empty (i.e. will contain no text node child).</p>
<p>Boolean <code>True</code>, or anything else interpreted as
<code>True</code> by Python, will be converted to a string "Y".
Anything else will be converted to a string "N". The result is
added to the document via <a
href="CedarBackup3.xmlutil-module.html#addStringNode"
class="link">addStringNode</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent node to create child for.</li>
<li><strong class="pname"><code>nodeName</code></strong> - Name of the new container node.</li>
<li><strong class="pname"><code>nodeValue</code></strong> - The value to put into the node.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Reference to the newly-created node.</dd>
</dl>
</td></tr></table>
</div>
<a name="readLong"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readLong</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readLong">source code</a></span>
</td>
</tr></table>
<p>Returns long integer contents of the first child with a given name
immediately beneath the parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Long integer contents of node or <code>None</code> if no matching
nodes are found.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the string at the location can't be converted to an integer.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="readFloat"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">readFloat</span>(<span class="sig-arg">parent</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#readFloat">source code</a></span>
</td>
</tr></table>
<p>Returns float contents of the first child with a given name
immediately beneath the parent.</p>
<p>By "immediately beneath" the parent, we mean from among
nodes that are direct children of the passed-in parent node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
<li><strong class="pname"><code>name</code></strong> - Name of node to search for.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Float contents of node or <code>None</code> if no matching nodes
are found.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the string at the location can't be converted to a float value.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addLongNode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addLongNode</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">nodeName</span>,
<span class="sig-arg">nodeValue</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#addLongNode">source code</a></span>
</td>
</tr></table>
<p>Adds a text node as the next child of a parent, to contain a long
integer.</p>
<p>If the <code>nodeValue</code> is None, then the node will be created,
but will be empty (i.e. will contain no text node child).</p>
<p>The integer will be converted to a string using "%d". The
result will be added to the document via <a
href="CedarBackup3.xmlutil-module.html#addStringNode"
class="link">addStringNode</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent node to create child for.</li>
<li><strong class="pname"><code>nodeName</code></strong> - Name of the new container node.</li>
<li><strong class="pname"><code>nodeValue</code></strong> - The value to put into the node.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Reference to the newly-created node.</dd>
</dl>
</td></tr></table>
</div>
<a name="_translateCDATAAttr"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_translateCDATAAttr</span>(<span class="sig-arg">characters</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#_translateCDATAAttr">source code</a></span>
</td>
</tr></table>
<p>Handles normalization and some intelligence about quoting.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Copyright:</strong>
This code, prior to customization, was part of the PyXML codebase,
and before that was part of the 4DOM suite developed by
Fourthought, Inc. It its original form, it was Copyright (c) 2000
Fourthought Inc, USA; All Rights Reserved.
</p>
</div></td></tr></table>
</div>
<a name="_translateCDATA"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_translateCDATA</span>(<span class="sig-arg">characters</span>,
<span class="sig-arg">encoding</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">UTF-8</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">prev_chars</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="sig-arg">markupSafe</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.xmlutil-pysrc.html#_translateCDATA">source code</a></span>
</td>
</tr></table>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Copyright:</strong>
This code, prior to customization, was part of the PyXML codebase,
and before that was part of the 4DOM suite developed by
Fourthought, Inc. It its original form, it was Copyright (c) 2000
Fourthought Inc, USA; All Rights Reserved.
</p>
</div></td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup3-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/cedarsolutions/cedar-backup3">CedarBackup3</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|