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
|
<?xml version="1.0" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Untitled</title>
</head>
<body>
<h2><a name="label-0" id="label-0">BDB::XML::Document</a></h2><!-- RDLabel: "BDB::XML::Document" -->
<p>A Document is the unit of storage within a Container. </p>
<p>A Document contains a stream of bytes.</p>
<p>Document supports annotation attributes.</p>
<h3><a name="label-1" id="label-1">Class Methods</a></h3><!-- RDLabel: "Class Methods" -->
<dl>
<dt><a name="label-2" id="label-2"><code>allocate</code></a></dt><!-- RDLabel: "allocate" -->
<dd>
Allocate a new object</dd>
</dl>
<h3><a name="label-3" id="label-3">Methods</a></h3><!-- RDLabel: "Methods" -->
<dl>
<dt><a name="label-4" id="label-4"><code>self[attr]</code></a></dt><!-- RDLabel: "self[attr]" -->
<dd>
Return the value of an attribute</dd>
<dt><a name="label-5" id="label-5"><code>self[attr] = <var>val</var></code></a></dt><!-- RDLabel: "self[attr] = val" -->
<dd>
Set the value of an attribute</dd>
<dt><a name="label-6" id="label-6"><code>content</code></a></dt><!-- RDLabel: "content" -->
<dd>
Return the content of the document</dd>
<dt><a name="label-7" id="label-7"><code>content=(<var>val</var>)</code></a></dt><!-- RDLabel: "content=" -->
<dd>
Set the content of the document</dd>
<dt><a name="label-8" id="label-8"><code>get(<var>uri</var> = "", <var>attr</var> [, <var>class</var>])</code></a></dt><!-- RDLabel: "get" -->
<dd>
<p>Return the value of an attribute. <var>uri</var> specify the namespace
where reside the attribute.</p>
<p>the optional <var>class</var> argument give the type (String, Numeric, ...)</p></dd>
<dt><a name="label-9" id="label-9"><code>id</code></a></dt><!-- RDLabel: "id" -->
<dd>
Return the ID</dd>
<dt><a name="label-10" id="label-10"><code>initialize(<var>content</var> = "")</code></a></dt><!-- RDLabel: "initialize" -->
<dd>
Initialize the document with the content specified</dd>
<dt><a name="label-11" id="label-11"><code>modify(<var>mod</var>)</code></a></dt><!-- RDLabel: "modify" -->
<dd>
Modifies the document contents based on the information contained in the
<var>BDB::XML::Modify</var> object</dd>
<dt><a name="label-12" id="label-12"><code>name</code></a></dt><!-- RDLabel: "name" -->
<dd>
Return the name of the document</dd>
<dt><a name="label-13" id="label-13"><code>name=(<var>val</var>)</code></a></dt><!-- RDLabel: "name=" -->
<dd>
Set the name of the document</dd>
<dt><a name="label-14" id="label-14"><code>prefix</code></a></dt><!-- RDLabel: "prefix" -->
<dd>
Return the default prefix for the namespace</dd>
<dt><a name="label-15" id="label-15"><code>prefix=(<var>val</var>)</code></a></dt><!-- RDLabel: "prefix=" -->
<dd>
Set the default prefix used by <var>set</var></dd>
<dt><a name="label-16" id="label-16"><code>query(<var>xpath</var>, <var>context</var> = <var>nil</var>)</code></a></dt><!-- RDLabel: "query" -->
<dd>
Execute the XPath expression <var>xpath</var> against the document
Return an <var>BDB::XML::Results</var></dd>
<dt><a name="label-17" id="label-17"><code>set(<var>uri</var> = "", <var>prefix</var> = "", <var>attr</var>, <var>value</var>)</code></a></dt><!-- RDLabel: "set" -->
<dd>
Set an attribute in the namespace <var>uri</var>. <var>prefix</var> is the prefix
for the namespace</dd>
<dt><a name="label-18" id="label-18"><code>to_s</code></a></dt><!-- RDLabel: "to_s" -->
<dt><a name="label-19" id="label-19"><code>to_str</code></a></dt><!-- RDLabel: "to_str" -->
<dd>
Return the document as a String object</dd>
<dt><a name="label-20" id="label-20"><code>uri</code></a></dt><!-- RDLabel: "uri" -->
<dd>
Return the default namespace</dd>
<dt><a name="label-21" id="label-21"><code>uri=(<var>val</var>)</code></a></dt><!-- RDLabel: "uri=" -->
<dd>
Set the default namespace used by <var>set</var> and <var>get</var></dd>
</dl>
</body>
</html>
|
