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
|
<HTML>
<HEAD>
<TITLE>XMLValidator Class Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1XMLValidator.html">XMLValidator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classOpenMS_1_1XMLValidator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XMLValidator Class Reference<div class="ingroups"><a class="el" href="group__FileIO.html">File IO</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Validator for XML files.
<a href="classOpenMS_1_1XMLValidator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="XMLValidator_8h_source.html">OpenMS/FORMAT/VALIDATORS/XMLValidator.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for XMLValidator:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1XMLValidator.png" usemap="#XMLValidator_map" alt=""/>
<map id="XMLValidator_map" name="XMLValidator_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a82a0ce2008fa9fe9f6fb008f49b99be6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a82a0ce2008fa9fe9f6fb008f49b99be6">XMLValidator</a> ()</td></tr>
<tr class="memdesc:a82a0ce2008fa9fe9f6fb008f49b99be6"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a82a0ce2008fa9fe9f6fb008f49b99be6">More...</a><br/></td></tr>
<tr class="separator:a82a0ce2008fa9fe9f6fb008f49b99be6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acec09d2327d0c77cacb94964a1fb97a5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#acec09d2327d0c77cacb94964a1fb97a5">isValid</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, const <a class="el" href="classOpenMS_1_1String.html">String</a> &schema, std::ostream &os=std::cerr)</td></tr>
<tr class="memdesc:acec09d2327d0c77cacb94964a1fb97a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns if an XML file is valid for given a schema file. <a href="#acec09d2327d0c77cacb94964a1fb97a5">More...</a><br/></td></tr>
<tr class="separator:acec09d2327d0c77cacb94964a1fb97a5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Implementation of Xerces ErrorHandler methods</div></td></tr>
<tr class="memitem:a9e9938a1c5befbbc581730823b74ee8e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a9e9938a1c5befbbc581730823b74ee8e">warning</a> (const xercesc::SAXParseException &exception)</td></tr>
<tr class="separator:a9e9938a1c5befbbc581730823b74ee8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ec9ab194eae1e43acf5496b1e6924cb"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a3ec9ab194eae1e43acf5496b1e6924cb">error</a> (const xercesc::SAXParseException &exception)</td></tr>
<tr class="separator:a3ec9ab194eae1e43acf5496b1e6924cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69671abf648cceb10f4563b4b8cf3af6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a69671abf648cceb10f4563b4b8cf3af6">fatalError</a> (const xercesc::SAXParseException &exception)</td></tr>
<tr class="separator:a69671abf648cceb10f4563b4b8cf3af6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f3f37686a2d32fbf405a7ab3073e2ae"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a3f3f37686a2d32fbf405a7ab3073e2ae">resetErrors</a> ()</td></tr>
<tr class="separator:a3f3f37686a2d32fbf405a7ab3073e2ae"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2dd81c85c0b7f68b59750ae4441f7da4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a2dd81c85c0b7f68b59750ae4441f7da4">valid_</a></td></tr>
<tr class="memdesc:a2dd81c85c0b7f68b59750ae4441f7da4"><td class="mdescLeft"> </td><td class="mdescRight">Flag if the validated file is valid. <a href="#a2dd81c85c0b7f68b59750ae4441f7da4">More...</a><br/></td></tr>
<tr class="separator:a2dd81c85c0b7f68b59750ae4441f7da4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35af743f6aa00deb8287fc7e64993c15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a35af743f6aa00deb8287fc7e64993c15">filename_</a></td></tr>
<tr class="memdesc:a35af743f6aa00deb8287fc7e64993c15"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> name of validated file (for error messages) <a href="#a35af743f6aa00deb8287fc7e64993c15">More...</a><br/></td></tr>
<tr class="separator:a35af743f6aa00deb8287fc7e64993c15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10a999b0e10ad58721256e27e45b9ec8"><td class="memItemLeft" align="right" valign="top">std::ostream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1XMLValidator.html#a10a999b0e10ad58721256e27e45b9ec8">os_</a></td></tr>
<tr class="separator:a10a999b0e10ad58721256e27e45b9ec8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Validator for XML files. </p>
<p>Validates an XML file against a given schema. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a82a0ce2008fa9fe9f6fb008f49b99be6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1XMLValidator.html">XMLValidator</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3ec9ab194eae1e43acf5496b1e6924cb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void error </td>
<td>(</td>
<td class="paramtype">const xercesc::SAXParseException & </td>
<td class="paramname"><em>exception</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a69671abf648cceb10f4563b4b8cf3af6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void fatalError </td>
<td>(</td>
<td class="paramtype">const xercesc::SAXParseException & </td>
<td class="paramname"><em>exception</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acec09d2327d0c77cacb94964a1fb97a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isValid </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em> = <code>std::cerr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if an XML file is valid for given a schema file. </p>
<p>Error messages are printed to the error stream, unless redirected with the attribute <code>os</code> .</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1FileNotFound.html" title="File not found exception. ">Exception::FileNotFound</a></td><td>is thrown if the file cannot be found </td></tr>
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1ParseError.html" title="Parse Error exception. ">Exception::ParseError</a></td><td>is thrown if the parser could not be initialized </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f3f37686a2d32fbf405a7ab3073e2ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void resetErrors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9e9938a1c5befbbc581730823b74ee8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void warning </td>
<td>(</td>
<td class="paramtype">const xercesc::SAXParseException & </td>
<td class="paramname"><em>exception</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a35af743f6aa00deb8287fc7e64993c15"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1String.html">String</a> filename_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> name of validated file (for error messages) </p>
</div>
</div>
<a class="anchor" id="a10a999b0e10ad58721256e27e45b9ec8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream* os_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2dd81c85c0b7f68b59750ae4441f7da4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool valid_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag if the validated file is valid. </p>
</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:31 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
