|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: dataschema DataSchema.XML (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>dataschema <span class="subtitle">3.0.0</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_dataschema.html" title="dataschema">dataschema</a> |
|
22 > DataSchema.XML |
|
23 |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <h2> |
|
47 |
|
48 |
|
49 <code>static</code> |
|
50 |
|
51 Class <b property="yui:name">DataSchema.XML</b> |
|
52 <span class="extends"> |
|
53 - extends <a href="DataSchema.Base.html" title="DataSchema.Base">DataSchema.Base</a> |
|
54 </span> |
|
55 |
|
56 </h2> |
|
57 <!-- class tree goes here --> |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 <div class="summary description" property="yui:description"> |
|
63 XML subclass for the DataSchema Utility. |
|
64 </div> |
|
65 |
|
66 |
|
67 <div rel="yui:properties" resource="#properties"> |
|
68 |
|
69 </div> |
|
70 |
|
71 <div rel="yui:methods" resource="#methods"> |
|
72 <div class="section method details"> |
|
73 <h3 id="methods">Methods</h3> |
|
74 <div class="content"> |
|
75 <div class="protected" rel="yui:method" resource="#method__getLocationValue"> |
|
76 <h4> |
|
77 <a name="method__getLocationValue">_getLocationValue</a></h4> |
|
78 <div class="detail" > |
|
79 <code> |
|
80 protected |
|
81 static |
|
82 |
|
83 Object |
|
84 <strong property="yui:name">_getLocationValue</strong> |
|
85 ( |
|
86 |
|
87 |
|
88 field |
|
89 |
|
90 |
|
91 , |
|
92 context |
|
93 |
|
94 |
|
95 ) |
|
96 </code> |
|
97 |
|
98 <div class="description" property="yui:description"> |
|
99 Get an XPath-specified value for a given field from an XML node or document. |
|
100 </div> |
|
101 |
|
102 <div class="description"> |
|
103 |
|
104 <dl rel="yui:parameters"> |
|
105 <dt>Parameters:</dt> |
|
106 <dd rel="yui:parameter"> |
|
107 <code><span property="yui:name">field</span> |
|
108 <<span property="yui:type">String | Object</span>> |
|
109 </code> |
|
110 <span property="yui:description"> Field definition.</span> |
|
111 </dd> |
|
112 <dd rel="yui:parameter"> |
|
113 <code><span property="yui:name">context</span> |
|
114 <<span property="yui:type">Object</span>> |
|
115 </code> |
|
116 <span property="yui:description"> XML node or document to search within.</span> |
|
117 </dd> |
|
118 </dl> |
|
119 |
|
120 <dl> |
|
121 <dt>Returns: |
|
122 <code property="yui:return"> |
|
123 Object |
|
124 </code></dt> |
|
125 <dd property="yui:returnInfo">Data value or null.</dd> |
|
126 </dl> |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 </div> |
|
132 |
|
133 </div> |
|
134 <hr /> |
|
135 </div> |
|
136 <div class="protected" rel="yui:method" resource="#method__parseMeta"> |
|
137 <h4> |
|
138 <a name="method__parseMeta">_parseMeta</a></h4> |
|
139 <div class="detail" > |
|
140 <code> |
|
141 protected |
|
142 static |
|
143 |
|
144 Object |
|
145 <strong property="yui:name">_parseMeta</strong> |
|
146 ( |
|
147 |
|
148 |
|
149 xmldoc_in |
|
150 |
|
151 |
|
152 , |
|
153 data_out |
|
154 |
|
155 |
|
156 ) |
|
157 </code> |
|
158 |
|
159 <div class="description" property="yui:description"> |
|
160 Parses results data according to schema |
|
161 </div> |
|
162 |
|
163 <div class="description"> |
|
164 |
|
165 <dl rel="yui:parameters"> |
|
166 <dt>Parameters:</dt> |
|
167 <dd rel="yui:parameter"> |
|
168 <code><span property="yui:name">xmldoc_in</span> |
|
169 <<span property="yui:type">Object</span>> |
|
170 </code> |
|
171 <span property="yui:description"> XML document parse.</span> |
|
172 </dd> |
|
173 <dd rel="yui:parameter"> |
|
174 <code><span property="yui:name">data_out</span> |
|
175 <<span property="yui:type">Object</span>> |
|
176 </code> |
|
177 <span property="yui:description"> In-progress schema-parsed data to update.</span> |
|
178 </dd> |
|
179 </dl> |
|
180 |
|
181 <dl> |
|
182 <dt>Returns: |
|
183 <code property="yui:return"> |
|
184 Object |
|
185 </code></dt> |
|
186 <dd property="yui:returnInfo">Schema-parsed data.</dd> |
|
187 </dl> |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 </div> |
|
193 |
|
194 </div> |
|
195 <hr /> |
|
196 </div> |
|
197 <div class="protected" rel="yui:method" resource="#method__parseResults"> |
|
198 <h4> |
|
199 <a name="method__parseResults">_parseResults</a></h4> |
|
200 <div class="detail" > |
|
201 <code> |
|
202 protected |
|
203 static |
|
204 |
|
205 Object |
|
206 <strong property="yui:name">_parseResults</strong> |
|
207 ( |
|
208 |
|
209 |
|
210 schema |
|
211 |
|
212 |
|
213 , |
|
214 xmldoc_in |
|
215 |
|
216 |
|
217 , |
|
218 data_out |
|
219 |
|
220 |
|
221 ) |
|
222 </code> |
|
223 |
|
224 <div class="description" property="yui:description"> |
|
225 Schema-parsed list of results from full data |
|
226 </div> |
|
227 |
|
228 <div class="description"> |
|
229 |
|
230 <dl rel="yui:parameters"> |
|
231 <dt>Parameters:</dt> |
|
232 <dd rel="yui:parameter"> |
|
233 <code><span property="yui:name">schema</span> |
|
234 <<span property="yui:type">Object</span>> |
|
235 </code> |
|
236 <span property="yui:description"> Schema to parse against.</span> |
|
237 </dd> |
|
238 <dd rel="yui:parameter"> |
|
239 <code><span property="yui:name">xmldoc_in</span> |
|
240 <<span property="yui:type">Object</span>> |
|
241 </code> |
|
242 <span property="yui:description"> XML document parse.</span> |
|
243 </dd> |
|
244 <dd rel="yui:parameter"> |
|
245 <code><span property="yui:name">data_out</span> |
|
246 <<span property="yui:type">Object</span>> |
|
247 </code> |
|
248 <span property="yui:description"> In-progress schema-parsed data to update.</span> |
|
249 </dd> |
|
250 </dl> |
|
251 |
|
252 <dl> |
|
253 <dt>Returns: |
|
254 <code property="yui:return"> |
|
255 Object |
|
256 </code></dt> |
|
257 <dd property="yui:returnInfo">Schema-parsed data.</dd> |
|
258 </dl> |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 </div> |
|
264 |
|
265 </div> |
|
266 <hr /> |
|
267 </div> |
|
268 <div class="" rel="yui:method" resource="#method_apply"> |
|
269 <h4> |
|
270 <a name="method_apply">apply</a></h4> |
|
271 <div class="detail" > |
|
272 <code> |
|
273 |
|
274 static |
|
275 |
|
276 Object |
|
277 <strong property="yui:name">apply</strong> |
|
278 ( |
|
279 |
|
280 |
|
281 schema |
|
282 |
|
283 |
|
284 , |
|
285 data |
|
286 |
|
287 |
|
288 ) |
|
289 </code> |
|
290 |
|
291 <div class="description" property="yui:description"> |
|
292 Applies a given schema to given XML data. |
|
293 </div> |
|
294 |
|
295 <div class="description"> |
|
296 |
|
297 <dl rel="yui:parameters"> |
|
298 <dt>Parameters:</dt> |
|
299 <dd rel="yui:parameter"> |
|
300 <code><span property="yui:name">schema</span> |
|
301 <<span property="yui:type">Object</span>> |
|
302 </code> |
|
303 <span property="yui:description"> Schema to apply.</span> |
|
304 </dd> |
|
305 <dd rel="yui:parameter"> |
|
306 <code><span property="yui:name">data</span> |
|
307 <<span property="yui:type">XMLDoc</span>> |
|
308 </code> |
|
309 <span property="yui:description"> XML document.</span> |
|
310 </dd> |
|
311 </dl> |
|
312 |
|
313 <dl> |
|
314 <dt>Returns: |
|
315 <code property="yui:return"> |
|
316 Object |
|
317 </code></dt> |
|
318 <dd property="yui:returnInfo">Schema-parsed data.</dd> |
|
319 </dl> |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 </div> |
|
325 |
|
326 </div> |
|
327 <hr /> |
|
328 </div> |
|
329 </div> |
|
330 </div> |
|
331 |
|
332 <div rel="yui:inheritance"> |
|
333 <div class="section field inheritance" rel="yui:superclass" resource="DataSchema.Base.html"> |
|
334 <h4>Methods inherited from <a href="DataSchema.Base.html" property="yui:name" title="DataSchema.Base">DataSchema.Base</a>:</h4> |
|
335 <div class="content" rel="yui:methods"> |
|
336 <code> |
|
337 <span rel="yui:method" resource="DataSchema.Base.html#method_parse"> |
|
338 <a class="" href="DataSchema.Base.html#method_parse" property="yui:name" title="parse">parse</a> |
|
339 </span> |
|
340 </code> |
|
341 </div> |
|
342 </div> |
|
343 </div> |
|
344 </div> |
|
345 |
|
346 <div rel="yui:events" resource="#events"> |
|
347 |
|
348 |
|
349 </div> |
|
350 |
|
351 <div rel="yui:attributes" resource="#configattributes"> |
|
352 |
|
353 </div> |
|
354 |
|
355 </div> |
|
356 </div> |
|
357 <div class="yui-b"> |
|
358 <div class="nav"> |
|
359 |
|
360 <div id="moduleList" class="module"> |
|
361 <h4>Modules</h4> |
|
362 <ul class="content"> |
|
363 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
364 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
365 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
366 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
367 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
368 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
369 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
370 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
371 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
372 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
373 <li class="selected"><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
374 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
375 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
376 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
377 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
378 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
379 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
380 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
381 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
382 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
383 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
384 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
385 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
386 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
387 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
388 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
389 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
390 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
391 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
392 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
393 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
394 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
395 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
396 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
397 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
398 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
399 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
400 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
401 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
402 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
403 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
404 </ul> |
|
405 </div> |
|
406 |
|
407 <div id="classList" class="module"> |
|
408 <h4>Classes</h4> |
|
409 <ul class="content"> |
|
410 <li class=""><a href="DataSchema.Array.html" title="DataSchema.Array">DataSchema.Array</a></li> |
|
411 <li class=""><a href="DataSchema.Base.html" title="DataSchema.Base">DataSchema.Base</a></li> |
|
412 <li class=""><a href="DataSchema.JSON.html" title="DataSchema.JSON">DataSchema.JSON</a></li> |
|
413 <li class=""><a href="DataSchema.Text.html" title="DataSchema.Text">DataSchema.Text</a></li> |
|
414 <li class="selected"><a href="DataSchema.XML.html" title="DataSchema.XML">DataSchema.XML</a></li> |
|
415 </ul> |
|
416 </div> |
|
417 |
|
418 <div id="fileList" class="module"> |
|
419 <h4>Files</h4> |
|
420 <ul class="content"> |
|
421 <li class=""><a href="dataschema-array.js.html" title="dataschema-array.js">dataschema-array.js</a></li> |
|
422 <li class=""><a href="dataschema-base.js.html" title="dataschema-base.js">dataschema-base.js</a></li> |
|
423 <li class=""><a href="dataschema-json.js.html" title="dataschema-json.js">dataschema-json.js</a></li> |
|
424 <li class=""><a href="dataschema-text.js.html" title="dataschema-text.js">dataschema-text.js</a></li> |
|
425 <li class=""><a href="dataschema-xml.js.html" title="dataschema-xml.js">dataschema-xml.js</a></li> |
|
426 </ul> |
|
427 </div> |
|
428 |
|
429 |
|
430 <div id="methodsList" class="module"> |
|
431 <h4>Methods</h4> |
|
432 <ul class="content"> |
|
433 <li class="protected"><a href="#method__getLocationValue" title="_getLocationValue">_getLocationValue</a></li> |
|
434 <li class="protected"><a href="#method__parseMeta" title="_parseMeta">_parseMeta</a></li> |
|
435 <li class="protected"><a href="#method__parseResults" title="_parseResults">_parseResults</a></li> |
|
436 <li class=""><a href="#method_apply" title="apply">apply</a></li> |
|
437 </ul> |
|
438 </div> |
|
439 |
|
440 |
|
441 |
|
442 </div> |
|
443 </div> |
|
444 </div> |
|
445 <div id="ft"> |
|
446 <hr /> |
|
447 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
448 </div> |
|
449 </div> |
|
450 <script type="text/javascript"> |
|
451 ALL_YUI_PROPS = [{"access": "", "host": "DataSchema.Text", "name": "apply", "url": "DataSchema.Text.html#method_apply", "type": "method"}, {"access": "", "host": "DataSchema.XML", "name": "apply", "url": "DataSchema.XML.html#method_apply", "type": "method"}, {"access": "protected", "host": "DataSchema.XML", "name": "_getLocationValue", "url": "DataSchema.XML.html#method__getLocationValue", "type": "method"}, {"access": "protected", "host": "DataSchema.XML", "name": "_parseMeta", "url": "DataSchema.XML.html#method__parseMeta", "type": "method"}, {"access": "protected", "host": "DataSchema.Text", "name": "_parseResults", "url": "DataSchema.Text.html#method__parseResults", "type": "method"}, {"access": "protected", "host": "DataSchema.XML", "name": "_parseResults", "url": "DataSchema.XML.html#method__parseResults", "type": "method"}]; |
|
452 </script> |
|
453 </body> |
|
454 </html> |