<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example: Enforcing DataTypes</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: Enforcing DataTypes</h1>
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
<div class="content"><div class="intro">
<p>DataSchema supports a <code>parser</code> property that enforces type conversion on data as the schema is being applied. The <code>parser</code> property can point to one of the following types of parsing functions:</p>
<ul>
<li>A DataType subclass parse function, like <code>Y.DataType.Number.parse</code></li>
<li>A registered shortcut to a DataType subclass parse function, like <code>"number"</code></li>
<li>A custom function</li>
</ul>
</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>
{
"results":[
{"string":"aardvark", "number":"1", "date":"Jan 1, 2001"},
{"string":"bat", "number":"2", "date":"Feb 2, 2002"},
{"string":"camel", "number":"3", "date":"March 3, 2003"}
]
}
</pre>
<h6>Schema</h6>
<pre>
{
resultListLocator: "results",
resultFields: [
"string", // needs no parsing
{key:"number", parser: "number"}, // point to built-in shortcut
{key:"date", parser: Y.DataType.Date.parse}] // point to function
}
</pre>
<h6>Normalized data</h6>
<input type="button" id="demo_apply_parsing" value="Apply schema =>">
<div id="demo_output_parsing" class="output"></div>
</form>
<script>
YUI().use("dump", "node", "datatype", "dataschema", function (Y) {
Y.on("click", function(e){
var data_in = {
"results":[
{"string":"aardvark", "number":"1", "date":"Jan 1, 2001"},
{"string":"bat", "number":"2", "date":"Feb 2, 2002"},
{"string":"camel", "number":"3", "date":"March 3, 2003"}
]
},
schema = {
resultListLocator: "results",
resultFields: [
"string", // needs no parsing
{key:"number", parser: "number"}, // point parser to built-in function shortcut
{key:"date", parser: Y.DataType.Date.parse}] // point parser to built-in function
},
data_out = Y.DataSchema.JSON.apply(schema, data_in).results,
output = [],
result;
for(var i=0; i<data_out.length; i++) {
result = data_out[i];
output.push("<p>string: " + result.string + " [" + Y.Lang.type(result.string) + "]" +
", number: " + result.number + " [" + Y.Lang.type(result.number) + "]" +
", date: " + result.date + " [" + Y.Lang.type(result.date) + "]</p>");
}
output = output.join("");
Y.one("#demo_output_parsing").setHTML(output);
}, "#demo_apply_parsing");
});
</script>
</div>
<p>Use the <code>parser</code> property in your schema's <code>resultFields</code> definition to point to a parsing function. Parsing your data in this manner is essential if your numerical or date data comes over the wire as JSON, since all the values will be strings.</p>
<pre class="code prettyprint">YUI().use("datatype", "dataschema", function(Y) {
var data_in = {
"results":[
{"string":"aardvark", "number":"1", "date":"Jan 1, 2001"},
{"string":"bat", "number":"2", "date":"Feb 2, 2002"},
{"string":"camel", "number":"3", "date":"March 3, 2003"}
]
},
schema = {
resultListLocator: "results",
resultFields: [
// needs no parsing
"string",
// point parser to built-in function shortcut
{key:"number", parser: "number"},
// point parser to built-in function
{key:"date", parser: Y.DataType.Date.parse}]
},
data_out = Y.DataSchema.JSON.apply(schema, data_in).results;
});</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-parsing',
title: 'Enforcing DataTypes',
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>