<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example: DataSchema.XML for XML Data</title>
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="../../build/yui/yui-min.js"></script>
</head>
<body>
<!--
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
-->
<div id="doc">
<div id="hd">
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
</div>
<h1>Example: DataSchema.XML for XML Data</h1>
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
<div class="content"><div class="intro">
<p>DataSchema.XML normalizes arbitrary XML data against a given schema into an object with known properties.</p>
<p><strong>Note:</strong> XML parsing currently has known issues on the Android WebKit browser.</p>
</div>
<div class="example yui3-skin-sam">
<style scoped>
/* custom styles for this example */
#demo .output {margin-bottom:1em; padding:10px; border:1px solid #D9D9D9;}
</style>
<form id="demo">
<h4>Basic example</h4>
<h6>Data</h6>
<pre>
<root>
<session>34637542</session>
<category name="music" id="5"><results>
<song id="59672468">
<title>I Kissed A Girl</title>
<rank>1</rank>
<artist id="30326214">Katy Perry</artist>
</song>
<song id="47973564">
<title>Shake It</title>
<rank>2</rank>
<artist id="45575683">Metro Station</artist>
</song>
<song id="52207363">
<title>Bleeding Love</title>
<rank>3</rank>
<artist id="37956508">Leona Lewis</artist>
</song>
</results></category>
</root>
</pre>
<h6>Schema</h6>
<pre>
{
resultListLocator: "song",
resultFields: [{key:"title"}, {key:"artist"}, {key:"rank"}]
}
</pre>
<h6>Normalized data</h6>
<input type="button" id="demo_apply_basic" value="Apply schema =>">
<div id="demo_output_basic" class="output"></div>
<h4>Complex example</h4>
<h6>Data</h6>
<pre>
<Response>
<Session>542235629</Session>
<Tracks start="1" count="10" total="98" errorCount="0"
defaultSort="popularity+" description="Top 100 Tracks"
name="Top 100 Tracks">
<Track id="59672468" rating="-1" title="I Kissed A Girl">
<Artist id="30326214" rating="-1">Katy Perry</Artist>
<ItemInfo><ChartPosition last="26" this="1"/></ItemInfo>
</Track>
<Track id="47973564" rating="-1" title="Shake It">
<Artist id="45575683" rating="-1">Metro Station</Artist>
<ItemInfo><ChartPosition last="27" this="2"/></ItemInfo>
</Track>
<Track id="52207363" rating="-1" title="Bleeding Love">
<Artist id="37956508" rating="-1">Leona Lewis</Artist>
<ItemInfo><ChartPosition last="28" this="3"/></ItemInfo>
</Track>
</Tracks>
</Response>
</pre>
<h6>Schema</h6>
<pre>
{
metaFields: {session:"//Session", total:"//Tracks/@total"},
resultListLocator: "//Track",
resultFields: [{key:"song", locator:"@title"},
{key:"artist", locator:"Artist"},
{key:"rank", locator:"ItemInfo/ChartPosition/@this"}]
}
</pre>
<h6>Normalized data</h6>
<input type="button" id="demo_apply_complex" value="Apply schema =>">
<div id="demo_output_complex" class="output"></div>
<h4>Nested example</h4>
<h6>Data</h6>
<pre>
<desserts>
<dessert type="treat">
<name>cupcake</name>
<flavors>
<flavor name="chocolate"/>
<flavor name="red velvet"/>
</flavors>
</dessert>
<dessert type="treat">
<name>ice cream</name>
<flavors>
<flavor name="chocolate"/>
<flavor name="strawberry"/>
<flavor name="vanilla"/>
</flavors>
</dessert>
<dessert type="treat">
<name>pie</name>
<flavors>
<flavor name="banana cream"/>
<flavor name="blueberry"/>
<flavor name="cherry"/>
</flavors>
</dessert>
<dessert type="beverage">
<name>hot chocolate</name>>
</dessert>
<dessert type="beverage">
<name>port wine</name>
</dessert>
</desserts>
</pre>
<h6>Schema</h6>
<pre>
{
resultListLocator: "dessert",
resultFields: [
{key:"type", locator:"@type"},
{key:"name", locator:"name"},
{key:"flavors", schema: {
resultListLocator: "flavor",
resultFields: [
{key:"flavor", locator:"@name"}
]
}}
]
}
</pre>
<h6>Normalized data</h6>
<input type="button" id="demo_apply_nested" value="Apply schema =>">
<div id="demo_output_nested" class="output"></div>
</form>
<script>
YUI().use("dump", "node", "datatype-xml", "dataschema-xml", function (Y) {
Y.on("click", function(e){
var data_in = Y.DataType.XML.parse('<root><session>34637542</session><category name="music" id="5"><results><song id="59672468"><title>I Kissed A Girl</title><rank>1</rank><artist id="30326214">Katy Perry</artist></song><song id="47973564"><title>Shake It</title><rank>2</rank><artist id="45575683">Metro Station</artist></song><song id="52207363"><title>Bleeding Love</title><rank>3</rank><artist id="37956508">Leona Lewis</artist></song></results></category></root>'),
schema = {
resultListLocator: "song",
resultFields: [{key:"title"}, {key:"artist"}, {key:"rank"}] // Or simply ["title", "artist", "rank"]
};
Y.one("#demo_output_basic").setHTML(Y.dump(Y.DataSchema.XML.apply(schema, data_in)));
}, "#demo_apply_basic");
Y.on("click", function(e){
var data_in = Y.DataType.XML.parse('<Response><Session>542235629</Session><Tracks start="1" count="10" total="98" errorCount="0" defaultSort="popularity+" description="Top 100 Tracks" name="Top 100 Tracks" ><Track id="59672468" rating="-1" title="I Kissed A Girl"><Artist id="30326214" rating="-1">Katy Perry</Artist><ItemInfo><ChartPosition last="26" this="1"/></ItemInfo></Track><Track id="47973564" rating="-1" title="Shake It"><Artist id="45575683" rating="-1">Metro Station</Artist><ItemInfo><ChartPosition last="27" this="2"/></ItemInfo></Track><Track id="52207363" rating="-1" title="Bleeding Love"><Artist id="37956508" rating="-1">Leona Lewis</Artist><ItemInfo><ChartPosition last="28" this="3"/></ItemInfo></Track></Tracks></Response>'),
schema = {
metaFields: {session:"//Session", total:"//Tracks/@total"},
resultListLocator: "//Track",
resultFields: [{key:"song", locator:"@title"}, {key:"artist", locator:"Artist"}, {key:"rank", locator:"ItemInfo/ChartPosition/@this"}]
};
Y.one("#demo_output_complex").setHTML(Y.dump(Y.DataSchema.XML.apply(schema, data_in)));
}, "#demo_apply_complex");
Y.on("click", function(e){
var data_in = Y.DataType.XML.parse('<desserts><dessert type="treat"><name>cupcake</name><flavors><flavor name="chocolate"/><flavor name="red velvet"/></flavors></dessert><dessert type="treat"><name>ice cream</name><flavors><flavor name="chocolate"/><flavor name="strawberry"/><flavor name="vanilla"/></flavors></dessert><dessert type="treat"><name>pie</name><flavors><flavor name="banana cream"/><flavor name="blueberry"/><flavor name="cherry"/></flavors></dessert><dessert type="beverage"><name>hot chocolate</name></dessert><dessert type="beverage"><name>port wine</name></dessert></desserts>'),
schema = {
resultListLocator: "dessert",
resultFields: [
{key:"type", locator:"@type"},
{key:"name", locator:"name"},
{key:"flavors", schema: {
resultListLocator: "flavor",
resultFields: [
{key:"flavor", locator:"@name"}
]
}}
]
};
Y.one("#demo_output_nested").setHTML(Y.dump(Y.DataSchema.XML.apply(schema, data_in)));
}, "#demo_apply_nested");
});
</script>
</div>
<p>In order to use DataSchema.XML, input data must be an XML document.</p>
<pre class="code prettyprint">YUI().use("datatype-xml", "dataschema-xml", function(Y) {
var data_in = Y.DataType.XML.parse('<root><session>34637542</session><category name="music" id="5"><results><song id="59672468"><title>I Kissed A Girl</title><rank>1</rank><artist id="30326214">Katy Perry</artist></song><song id="47973564"><title>Shake It</title><rank>2</rank><artist id="45575683">Metro Station</artist></song><song id="52207363"><title>Bleeding Love</title><rank>3</rank><artist id="37956508">Leona Lewis</artist></song></results></category></root>'),
schema = {
resultListLocator: "song",
// Or simply ["title", "artist", "rank"]
resultFields: [{key:"title"}, {key:"artist"}, {key:"rank"}]
},
data_out = Y.DataSchema.XML.apply(schema, data_in));
alert(data_out);
});</pre>
<p>The data itself can get fairly complex, with deeply nested nodes and values held in attributes. In your schema, you can use XPath notation to define these locations.</p>
<pre class="code prettyprint">YUI().use("datatype-xml", "dataschema-xml", function(Y) {
var data_in = Y.DataType.XML.parse('<Response><Session>542235629</Session><Tracks start="1" count="10" total="98" errorCount="0" defaultSort="popularity+" description="Top 100 Tracks" name="Top 100 Tracks" ><Track id="59672468" rating="-1" title="I Kissed A Girl"><Artist id="30326214" rating="-1">Katy Perry</Artist><ItemInfo><ChartPosition last="26" this="1"/></ItemInfo></Track><Track id="47973564" rating="-1" title="Shake It"><Artist id="45575683" rating="-1">Metro Station</Artist><ItemInfo><ChartPosition last="27" this="2"/></ItemInfo></Track><Track id="52207363" rating="-1" title="Bleeding Love"><Artist id="37956508" rating="-1">Leona Lewis</Artist><ItemInfo><ChartPosition last="28" this="3"/></ItemInfo></Track></Tracks></Response>'),
schema = {
metaFields: {session:"//Session", total:"//Tracks/@total"},
resultListLocator: "//Track",
resultFields: [
{key:"song", locator:"@title"},
{key:"artist", locator:"Artist"},
{key:"rank", locator:"ItemInfo/ChartPosition/@this"}
]
},
data_out = Y.DataSchema.XML.apply(schema, data_in));
alert(data_out);
});</pre>
<p>Nested schemas are supported as of version 3.1:</p>
<pre class="code prettyprint">YUI().use("datatype-xml", "dataschema-xml", function(Y) {
var data_in = Y.DataType.XML.parse('<desserts><dessert type="treat"><name>cupcake</name><flavors><flavor name="chocolate"/><flavor name="red velvet"/></flavors></dessert><dessert type="treat"><name>ice cream</name><flavors><flavor name="chocolate"/><flavor name="strawberry"/><flavor name="vanilla"/></flavors></dessert><dessert type="treat"><name>pie</name><flavors><flavor name="banana cream"/><flavor name="blueberry"/><flavor name="cherry"/></flavors></dessert><dessert type="beverage"><name>hot chocolate</name></dessert><dessert type="beverage"><name>port wine</name></dessert></desserts>'),
schema = {
resultListLocator: "dessert",
resultFields: [
{key:"type", locator:"@type"},
{key:"name", locator:"name"},
{key:"flavors", schema: {
resultListLocator: "flavor",
resultFields: [
{key:"flavor", locator:"@name"}
]
}}
]
},
data_out = Y.DataSchema.XML.apply(schema, data_in));
alert(data_out);
});</pre>
</div>
</div>
</div>
<div class="yui3-u-1-4">
<div class="sidebar">
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Schema parsing a JavaScript array.">
<a href="dataschema-array.html">DataSchema.Array</a>
</li>
<li data-description="Schema parsing JSON data.">
<a href="dataschema-json.html">DataSchema.JSON</a>
</li>
<li data-description="Schema parsing XML data.">
<a href="dataschema-xml.html">DataSchema.XML for XML Data</a>
</li>
<li data-description="Schema parsing data held in TABLE elements.">
<a href="dataschema-table.html">DataSchema.XML for HTML Tables</a>
</li>
<li data-description="Schema parsing delimited plain-text data.">
<a href="dataschema-text.html">DataSchema.Text</a>
</li>
<li data-description="Parsing data into specified types as the schema is being applied.">
<a href="dataschema-parsing.html">Enforcing DataTypes</a>
</li>
</ul>
</div>
</div>
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples That Use This Component</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="The Local DataSource manages retrieval of in-page data, from JavaScript arrays and objects to DOM elements.">
<a href="../datasource/datasource-local.html">DataSource.Local</a>
</li>
<li data-description="The Get DataSource, which manages retrieval of data from remote sources via the Get Utility, can be useful for accessing data from cross-domain servers without the need for a proxy.">
<a href="../datasource/datasource-get.html">DataSource.Get</a>
</li>
<li data-description="The IO DataSource manages retrieval of data from remote sources, via the IO Utility.">
<a href="../datasource/datasource-io.html">DataSource.IO</a>
</li>
<li data-description="The Function DataSource, which manages retrieval of data from a JavaScript function, provides a highly customizeable mechanism for implementer-defined data retrieval algorithms">
<a href="../datasource/datasource-function.html">DataSource.Function</a>
</li>
<li data-description="Use the DataSourceCache plugin to enable caching and reduce server calls to remote sources.">
<a href="../datasource/datasource-caching.html">DataSource with Caching</a>
</li>
<li data-description="The DataSourceCache plugin supports offline caching so that cached data persists across browser sessions.">
<a href="../datasource/datasource-offlinecache.html">DataSource with Offline Cache</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script>
YUI.Env.Tests = {
examples: [],
project: '../assets',
assets: '../assets/dataschema',
name: 'dataschema-xml',
title: 'DataSchema.XML for XML Data',
newWindow: '',
auto: false
};
YUI.Env.Tests.examples.push('dataschema-array');
YUI.Env.Tests.examples.push('dataschema-json');
YUI.Env.Tests.examples.push('dataschema-xml');
YUI.Env.Tests.examples.push('dataschema-table');
YUI.Env.Tests.examples.push('dataschema-text');
YUI.Env.Tests.examples.push('dataschema-parsing');
YUI.Env.Tests.examples.push('datasource-local');
YUI.Env.Tests.examples.push('datasource-get');
YUI.Env.Tests.examples.push('datasource-io');
YUI.Env.Tests.examples.push('datasource-function');
YUI.Env.Tests.examples.push('datasource-caching');
YUI.Env.Tests.examples.push('datasource-offlinecache');
</script>
<script src="../assets/yui/test-runner.js"></script>
</body>
</html>