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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_xtree_doc">
<refmeta>
<refentrytitle>xtree_doc</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xtree_doc</refname>
<refpurpose>returns an entity object created from an XML document</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xtree_doc">
<funcprototype id="fproto_xtree_doc">
<funcdef><function>xtree_doc</function></funcdef>
<paramdef>in <parameter>document</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>parser_mode</parameter> integer</optional></paramdef>
<paramdef><optional>in <parameter>base_uri</parameter> varchar</optional></paramdef>
<paramdef><optional>in <parameter>content_encoding</parameter> varchar</optional></paramdef>
<paramdef><optional>in <parameter>content_language</parameter> varchar</optional></paramdef>
<paramdef><optional>in <parameter>dtd_validator_config</parameter> varchar</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>This parses the argument, which is expected to be a well formed XML fragment and returns a
parse tree as a special memory-resident object. While <link linkend="fn_xper_doc">xper_doc</link> creates
some disk-resident data structure, xtree_doc() will work faster but it may require more memory. You may
wish to use xtree_doc for small documents (e.g. less than 5 megabytes and xper_doc for larger documents.
</para>
</refsect1>
<refsect1 id="params"><title>Parameters</title>
<refsect2><title>document</title>
<para>well formed XML or HTML document</para></refsect2>
<refsect2><title>parser_mode</title>
<para>0, 1 or 2; 0 - XML parser mode, 1 - HTML parser mode, 2 - 'dirty HTML'
mode (with quiet recovery after any syntax error)</para></refsect2>
<refsect2><title>base_uri</title>
<para>in HTML parser mode change all absolute references to relative from given
base_uri (http://<host>:<port>/<path>)</para></refsect2>
<refsect2><title>content_encoding</title>
<para>string with content encoding type of <document>; valid are 'ASCII', 'ISO',
'UTF8', 'ISO8859-1', 'LATIN-1' etc., defaults are 'UTF-8' for XML mode and 'LATIN-1' for
HTML mode.</para></refsect2>
<refsect2><title>content_language</title>
<para>string with language tag of content of <document>; valid names are listed in
IETF RFC 1766, default is 'x-any' (it means 'mix of words from various human languages')</para></refsect2>
<refsect2><title>dtd_validator_config</title>
<para>configuration string for DTD validator, default is empty string meaning that DTD
validator should be fully disabled.
See <link linkend="dtd_config">Configuration Options of the DTD Validator</link> for details.</para></refsect2>
</refsect1>
<refsect1 id="ret"><title>Return Types</title><para>XML entity with underlying parse tree
of source document; the tree will be a memory-resident structure of nested heterogeneous
vectors.</para></refsect1>
<!--
<refsect1 id="errors"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
-->
<refsect1 id="examples"><title>Examples</title>
<example id="ex_xtree_doc"><title>xtree_doc</title>
<programlisting>
declare tree any;
tree := xtree_doc (file_to_string ('doc.html'), 1,
'http://localhost.localdomain/', 'ISO');
...
tree := xtree_doc (file_to_string ('doc.xml'));
</programlisting>
</example>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para><link linkend="fn_xml_tree">xml_tree</link></para>
<para><link linkend="fn_xml_tree_doc">xml_tree_doc</link></para>
<para><link linkend="fn_xper_doc">xper_doc</link></para>
</refsect1>
</refentry>
|
