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
|
<?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_XMLType.XMLType">
<refmeta>
<refentrytitle>XMLType.XMLType</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>XMLType.XMLType</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_XMLType.XMLType">
<funcprototype id="fproto_XMLType.XMLType">
<funcdef>constructor method <function>XMLType.XMLType</function></funcdef>
<paramdef>in <parameter>src</parameter> any</paramdef>
<paramdef><optional>in <parameter>schema_uri</parameter> any</optional></paramdef>
<paramdef><optional>in <parameter>validated</parameter> any</optional></paramdef>
<paramdef><optional>in <parameter>wellformed</parameter> any</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_XMLType.XMLType">
<title>Description</title>
<para>The method creates an XMLType instance from <parameter>src</parameter> XML entity.
If parameter <parameter>src</parameter> is not an XML entity then it is converted to it
via internal call of <function>xtree_doc()</function> or <function>xml_tree_doc()</function>.
A schema may be associated with an XML entity
by passing its URI as <parameter>schema_uri</parameter>; this schema can be used later to
validate the structure of the document.</para>
</refsect1>
<refsect1 id="params_XMLType.XMLType">
<title>Parameters</title>
<refsect2><title>src</title>
<para>An XML entity or a value that can be converted to an XML entity.</para>
</refsect2>
<refsect2><title>schema_uri</title>
<para>An URI of the schema of the document. The default is NULL to make result non-schema based.</para>
</refsect2>
<refsect2><title>validated</title>
<para>An integer flag that indicates if the document is already validated against the
schema of the document (this is to avoid redundant validations). The default is 0.</para>
</refsect2>
<refsect2><title>wellformed</title>
<para>This parameter is unused and is listed solely for compatibility.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_XMLType.XMLType"><title>Return Types</title>
<para>The method returns a new instance of XMLType.</para>
</refsect1>
<refsect1 id="examples_XMLType.XMLType">
<title>Examples</title>
<example id="ex_XMLType.XMLType"><title>Simple Use</title>
<screen><![CDATA[
create table XMLTYPE_TEST (I integer primary key, XMLVAL long xml)
Done. -- 00000 msec.
insert into XMLTYPE_TEST values (1, XMLType('<emp><empno>221</empno><ename>John</ename></emp>'))
Done. -- 00000 msec.
insert into XMLTYPE_TEST values (2, XMLType('<po><pono>331</pono><poname>PO_1</poname></po>'))
Done. -- 00000 msec.
select e.XMLVAL.extract ('//empno/text()').getNumVal() as EMPNO
from XMLTYPE_TEST as e
where e.XMLVAL.existsNode('/emp/empno') = 1
EMPNO
DECIMAL
_______________________________________________________________________________
221
1 Rows. -- 00000 msec.
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_XMLType.XMLType">
<title>See Also</title>
<para><link linkend="fn_xtree_doc"><function>xtree_doc()</function></link></para>
<para><link linkend="fn_xper_doc"><function>xper_doc()</function></link></para>
</refsect1>
</refentry>
|
