src/cm/media/js/lib/yui/yui_3.10.3/docs/dataschema/dataschema-text.html
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Example: DataSchema.Text</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.Text</h1>
    <div class="yui3-g">
        <div class="yui3-u-3-4">
            <div id="main">
                <div class="content"><div class="intro">
    <p>DataSource.Text normalizes delimited text data against a given schema into an object with known properties.</p>
</div>

<div class="example yui3-skin-sam">
    <style scope>
/* custom styles for this example */
#demo .output {margin-bottom:1em; padding:10px; border:1px solid #D9D9D9;}
</style>

<form id="demo">
    <h6>Data</h6>
    <pre>
notebooks, 100, spiral-bound
pencils, 300, #2 with erasers
pens, 500, blue ink
    </pre>
    
    <h6>Schema</h6>
    <pre>
{
    resultDelimiter: "\n",
    fieldDelimiter: ",",
    resultFields: [{key:"product"}, {key:"quantity"}, {key:"detail"}]
}
    </pre>

    <h6>Normalized data</h6>
    <input type="button" id="demo_apply" value="Apply schema =>">
    <div id="demo_output" class="output"></div>
</form>

<script>
YUI().use("dump", "node", "dataschema-text", function (Y) {
    Y.on("click", function(e){
        var data_in = "notebooks, 100, spiral-bound\npencils, 300, #2 with erasers\npens, 500, blue ink\n",
            schema = {
                resultDelimiter: "\n",
                fieldDelimiter: ",",
                resultFields: [{key:"product"}, {key:"quantity"}, {key:"detail"}] // Or simply: ["product", "quantity", "detail"]
            };
        Y.one("#demo_output").setHTML(Y.dump(Y.DataSchema.Text.apply(schema, data_in)));
    }, "#demo_apply");
});
</script>

</div>

<p>In order to use DataSchema.Text, input data must be delimited text. Define as your schema's <code>resultDelimiter</code> property the string that separates each result, and define as your schema's <code>fieldDelimiter</code> property the string that separates each field of each result.</p>

<pre class="code prettyprint">YUI().use(&quot;dataschema-text&quot;, function(Y) {
    var data_in = &quot;notebooks, 100, spiral-bound\\npencils, 300, #2 with erasers\\npens, 500, blue ink&quot;,
        schema = {
            resultDelimiter: &quot;\\n&quot;,
            fieldDelimiter: &quot;,&quot;,
            &#x2F;&#x2F; Or simply: [&quot;product&quot;, &quot;quantity&quot;, &quot;detail&quot;]
            resultFields: [{key:&quot;product&quot;}, {key:&quot;quantity&quot;}, {key:&quot;detail&quot;}]
        },
        data_out = Y.DataSchema.Text.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-text',
    title: 'DataSchema.Text',
    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>