src/cm/media/js/lib/yui/yui_3.10.3/docs/datasource/index.html
author gibus
Tue, 16 Jul 2013 14:29:46 +0200
changeset 525 89ef5ed3c48b
permissions -rw-r--r--
Upgrades to yui 3.10.3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
<!DOCTYPE html>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
<html lang="en">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
<head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
    <meta charset="utf-8">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
    <title>DataSource</title>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
    <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
    <link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
    <link rel="stylesheet" href="../assets/css/main.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
    <script src="../../build/yui/yui-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
</head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
<body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
<!--
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
<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>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
-->
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
<div id="doc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
    <div id="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
        <h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
        <a href="#toc" class="jump">Jump to Table of Contents</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
            <h1>DataSource</h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
    <div class="yui3-g">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
        <div class="yui3-u-3-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
            <div id="main">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
                <div class="content"><div class="intro component">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
    <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
        The DataSource Utility provides a consistent API for the retrieval of
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
        data from arbitrary sources over a variety of supported protocols.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
        DataSource plugins and extensions enable additional functionality such
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
        as schema normalization, caching, and polling of data.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
				
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
<h2 id="getting-started">Getting Started</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
To include the source files for DataSource and its dependencies, first load
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
the YUI seed file if you haven't already loaded it.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
<pre class="code prettyprint">&lt;script src=&quot;http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.10.3&#x2F;build&#x2F;yui&#x2F;yui-min.js&quot;&gt;&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
Next, create a new YUI instance for your application and populate it with the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
modules you need by specifying them as arguments to the <code>YUI().use()</code> method.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
YUI will automatically load any dependencies required by the modules you
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
specify.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
<pre class="code prettyprint">&lt;script&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
&#x2F;&#x2F; Create a new YUI instance and populate it with the required modules.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
YUI().use(&#x27;datasource&#x27;, function (Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
    &#x2F;&#x2F; DataSource is available and ready for use. Add implementation
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
    &#x2F;&#x2F; code here.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
For more information on creating YUI instances and on the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
<a href="http://yuilibrary.com/yui/docs/api/classes/YUI.html#method_use"><code>use()</code> method</a>, see the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
documentation for the <a href="../yui/index.html">YUI Global Object</a>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
				
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
<h2 id="using">Using DataSources</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
			
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
<h3 id="basics">DataSource basics</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
    The DataSource Utility uses a callback mechanism to manage the data
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
    retrieval process across a wide variety of potential sources. Define your
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
    callback object with custom functions that will execute when the data
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
    returns from your source. The <code>sendRequest()</code> method accepts an
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
    object literal with properties for the request value, a callback object,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
    and/or any configuration values for the request.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
<pre class="code prettyprint">myDataSource.sendRequest({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
    request: myRequest,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
    on: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
        success: function(e){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
            alert(e.response);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
        failure: function(e){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
            alert(e.error.message);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
				
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
    You must instantiate the appropriate DataSource subclass for your source of
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
    data.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
<h4 id="local">Local sources</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
    Use DataSource.Local when you are working with data that is held in local
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
    memory, such as a JavaScript array or object.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
<pre class="code prettyprint">var myDataSource = new Y.DataSource.Local({source:[&quot;a&quot;, &quot;b&quot;, &quot;c&quot;]});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
<h4 id="get">Remote sources with the Get Utility</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
    Use DataSource.Get to access data coming from a server via the Get Utility.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
    The Get Utility supports data retrieval from cross-domain resources without
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
    the need for a proxy, but the server must return JSON data and support a
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
    script callback parameter in order for the response to return properly.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
    This parameter specifies the name of the internally defined function that
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
    the return data will be wrapped in when it returns to the page. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
<pre class="code prettyprint">var myDataSource = new Y.DataSource.Get({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
    source: &quot;http:&#x2F;&#x2F;query.yahooapis.com&#x2F;v1&#x2F;public&#x2F;yql?format=json&amp;&quot;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
    You should not modify the internally assigned value of this script callback
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
    parameter. However, you may need to set the parameter name to a different
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
    value so that your server will accept it. By default, the script callback
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
    parameter name is <code>"callback"</code>, but this value can be changed
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
    via the Attribute <code>scriptCallbackParam</code>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
<pre class="code prettyprint">&#x2F;&#x2F; By default the request is sent to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
&#x2F;&#x2F; &quot;http:&#x2F;&#x2F;query.yahooapis.com&#x2F;v1&#x2F;public&#x2F;yql?format=json&amp;q=foo&amp;callback=YUI.Env.DataSource.callbacks[0]&quot;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
myDataSource.sendRequest({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
    request: &quot;q=foo&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
    callback: myCallback
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
&#x2F;&#x2F; But the parameter name can be customized to match the server requirement
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
myDataSource.set(&quot;scriptCallbackParam&quot;, &quot;cbFunc&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
&#x2F;&#x2F; So now the request is sent to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
&#x2F;&#x2F; &quot;http:&#x2F;&#x2F;query.yahooapis.com&#x2F;v1&#x2F;public&#x2F;yql?format=json&amp;q=foo&amp;cbFunc=YUI.Env.DataSource.callbacks[0]&quot;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
myDataSource.sendRequest({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
    request: &quot;q=foo&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
    callback: myCallback
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
    Use the DataSourceJSONSchema plugin to normalize the data that is sent to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
    your callack.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
<pre class="code prettyprint">&#x2F;&#x2F; Normalize the data sent to myCallback
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
myDataSource.plug({fn: Y.Plugin.DataSourceJSONSchema, cfg: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
    schema: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
        resultListLocator: &quot;myResults&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
        resultFields: [&quot;myField1&quot;, &quot;myField2&quot;]
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
}});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
<h4 id="io">Remote sources with the IO Utility</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
    DataSource.IO is used to access data coming from a server via the IO
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
    Utility. Note that accessing a cross-domain server will require a
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
    same-domain proxy or enabling IO's XDR feature, in order to bypass standard
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
    browser security restrictions.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
<pre class="code prettyprint">var myDataSource = new Y.DataSource.IO({source:&quot;.&#x2F;myScript.php&quot;});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
    The IO Utility supports retrieval of multiple data formats, including JSON,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
    XML, and plain text. Use the appropriate DataSchema plugin to normalize the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
    data that is sent to your callback.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
<pre class="code prettyprint">myDataSource.plug({fn: Y.Plugin.DataSourceXMLSchema, cfg: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
    schema: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
        resultListLocator: &quot;resultNodeName&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
        resultFields: [{key:&quot;myField1&quot;, locator:&quot;xpath&#x2F;to&#x2F;value&quot;}]
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
}});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
<h4 id="function">Sources using custom functions</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
    Defining your own JavaScript function that returns data for a given request
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
    allows full customization of the data retrieval mechanism.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
<pre class="code prettyprint">var myDataSource = new Y.DataSource.Function({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
    source: function (request) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
        return data;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
    Since your data can return data of any format, you may consider ways to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
    taking advantage of the built-in infrastructure, including using a
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
    DataSchema plugin to normalize the data that is sent to your callback.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
<pre class="code prettyprint">var myDataSource = new Y.DataSource.Function({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
    source: function (request) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
        return [[&quot;ann&quot;, 123], [&quot;bill&quot;, 456]];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
myDataSource.plug({fn: Y.Plugin.DataSourceArraySchema, cfg: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
    schema: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
        resultFields: [&quot;name&quot;,&quot;id&quot;]
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
}});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
<h3 id="caching">Caching</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
    The DataSourceCache plugin provides integrated caching functionality to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
    your DataSource instance. Use the DataSource's <code>plug()</code> method
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
    to instantiate a Cache instance. Set the <code>max</code> Attribute value
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
    to the maximum number of entries the Cache should hold.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
<pre class="code prettyprint">myDataSource.plug({fn:Y.Plugin.DataSourceCache, cfg:{max:3}});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
    Once the plugin is enabled, it will handle caching and retrieval of values
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
    seamlessly for you without the need for extra code. However, all the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
    methods and properties of the Cache instance is available on the DataSource
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
    instance's <code>cache</code> namepace.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
<pre class="code prettyprint">&#x2F;&#x2F; Flush myDataSource&#x27;s cache.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
myDataSource.cache.flush();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
&#x2F;&#x2F; Disable myDataSource&#x27;s cache
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
myDataSource.cache.set(&quot;max&quot;, 0);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
<h3 id="polling">Polling</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   257
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   258
    Pollable is a DataSource extension that enhances the class with polling
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   259
    functionality. Once the extension is applied, all instances of DataSource
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   260
    will have available on their prototype the methods that enable and disable
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   261
    requests sent at regular intervals. To apply the extension, simply include
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   262
    the <code>datasource-polling</code> sub-module in your
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   263
    <code>YUI.use()</code> statement.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   264
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   265
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   266
<pre class="code prettyprint">YUI().use(&#x27;datasource-io&#x27;, &#x27;datasource-polling&#x27;, &#x27;json-parse&#x27;, function(Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   267
    var onlineFriends = Y.one(&#x27;#friend-count&#x27;),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   268
        friendData,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   269
        intervalId;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   270
        
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   271
    friendData = new Y.DataSource.IO({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   272
        source: &#x27;&#x2F;services&#x2F;friends&#x2F;&#x27;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   273
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   274
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   275
    &#x2F;&#x2F; Start polling the server every 10 seconds
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   276
    intervalId = friendData.setInterval(10000, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   277
        request : Y.one(&#x27;#user-id&#x27;).get(&#x27;value&#x27;),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   278
        callback: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   279
            success: function (e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   280
                var friends = Y.JSON.parse(e.response.results[0]).friendCount;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   281
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   282
                if (!friends) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   283
                    friends = &#x27;No friends.  You should go outside more.&#x27;;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   284
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   285
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   286
                onlineFriends.set(&#x27;text&#x27;, friends);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   287
            },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   288
            failure: function (e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   289
                onlineFriends.set(&#x27;text&#x27;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   290
                    &#x27;(Bang) Ouch! &#x27; + e.error.message + &#x27; happened!&#x27;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   291
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   292
                &#x2F;&#x2F; Stop polling
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   293
                friendData.clearInterval(intervalId);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   294
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   295
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   296
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   297
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   298
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   299
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   300
<h3 id="events">Events</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   301
<table>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   302
<thead>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   303
    <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   304
        <th>Event</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   305
        <th>When</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   306
        <th>Event properties</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   307
    </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   308
</thead>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   309
<tbody>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   310
    <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   311
        <td><code>request</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   312
        <td>Request is made.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   313
        <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   314
            <dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   315
                <dt><code>tId</code></dt>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   316
                    <dd>Unique transaction ID.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   317
                <dt><code>request</code></dt>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   318
                    <dd>The request value.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   319
                <dt><code>callback</code></dt>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   320
                    <dd>The callback object.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   321
                <dt><code>cfg</code></dt>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   322
                    <dd>The configuration object.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   323
            </dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   324
       </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   325
    </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   326
    <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   327
        <td><code>data</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   328
        <td>Raw data is received from the source.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   329
        <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   330
            All properties from <code>request</code> plus
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   331
            <dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   332
                <dt><code>data</code></dt>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   333
                    <dd>The raw data.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   334
            </dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   335
        </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   336
    </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   337
    <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   338
        <td><code>response</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   339
        <td>Response is returned to a callback function.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   340
        <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   341
            All properties from <code>data</code> plus
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   342
            <dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   343
                <dt><code>response</code></dt>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   344
                    <dd>Data normalized into a response object.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   345
            </dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   346
        </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   347
    </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   348
    <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   349
        <td><code>error</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   350
        <td>After <code>response</code> event, before the configured failure callback is executed.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   351
        <td>Same properties as the <code>response</code> event</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   352
    </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   353
</tbody>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   354
</table>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   355
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   356
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   357
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   358
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   359
        <div class="yui3-u-1-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   360
            <div class="sidebar">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   361
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   362
                    <div id="toc" class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   363
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   364
                            <h2 class="no-toc">Table of Contents</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   365
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   366
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   367
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   368
                            <ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   369
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   370
<a href="#getting-started">Getting Started</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   371
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   372
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   373
<a href="#using">Using DataSources</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   374
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   375
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   376
<a href="#basics">DataSource basics</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   377
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   378
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   379
<a href="#local">Local sources</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   380
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   381
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   382
<a href="#get">Remote sources with the Get Utility</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   383
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   384
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   385
<a href="#io">Remote sources with the IO Utility</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   386
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   387
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   388
<a href="#function">Sources using custom functions</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   389
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   390
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   391
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   392
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   393
<a href="#caching">Caching</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   394
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   395
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   396
<a href="#polling">Polling</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   397
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   398
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   399
<a href="#events">Events</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   400
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   401
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   402
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   403
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   404
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   405
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   406
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   407
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   408
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   409
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   410
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   411
                            <h2 class="no-toc">Examples</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   412
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   413
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   414
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   415
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   416
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   417
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   418
                                        <li data-description="The Local DataSource manages retrieval of in-page data, from JavaScript arrays and objects to DOM elements.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   419
                                            <a href="datasource-local.html">DataSource.Local</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   420
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   421
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   422
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   423
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   424
                                        <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.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   425
                                            <a href="datasource-get.html">DataSource.Get</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   426
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   427
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   428
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   429
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   430
                                        <li data-description="The IO DataSource manages retrieval of data from remote sources, via the IO Utility.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   431
                                            <a href="datasource-io.html">DataSource.IO</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   432
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   433
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   434
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   435
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   436
                                        <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">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   437
                                            <a href="datasource-function.html">DataSource.Function</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   438
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   439
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   440
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   441
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   442
                                        <li data-description="Use the DataSourceCache plugin to enable caching and reduce server calls to remote sources.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   443
                                            <a href="datasource-caching.html">DataSource with Caching</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   444
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   445
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   446
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   447
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   448
                                        <li data-description="The DataSourceCache plugin supports offline caching so that cached data persists across browser sessions.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   449
                                            <a href="datasource-offlinecache.html">DataSource with Offline Cache</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   450
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   451
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   452
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   453
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   454
                                        <li data-description="Use the Pollable extension to enable polling in your DataSource.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   455
                                            <a href="datasource-polling.html">DataSource with Polling</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   456
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   457
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   458
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   459
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   460
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   461
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   462
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   463
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   464
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   465
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   466
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   467
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   468
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   469
                            <h2 class="no-toc">Examples That Use This Component</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   470
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   471
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   472
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   473
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   474
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   475
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   476
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   477
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   478
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   479
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   480
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   481
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   482
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   483
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   484
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   485
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   486
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   487
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   488
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   489
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   490
                                        <li data-description="How to provide autocomplete suggestions using a DataSource instance.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   491
                                            <a href="../autocomplete/ac-datasource.html">Remote Data via DataSource</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   492
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   493
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   494
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   495
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   496
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   497
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   498
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   499
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   500
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   501
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   502
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   503
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   504
<script src="../assets/vendor/prettify/prettify-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   505
<script>prettyPrint();</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   506
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   507
<script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   508
YUI.Env.Tests = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   509
    examples: [],
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   510
    project: '../assets',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   511
    assets: '../assets/datasource',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   512
    name: 'datasource',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   513
    title: 'DataSource',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   514
    newWindow: '',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   515
    auto:  false 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   516
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   517
YUI.Env.Tests.examples.push('datasource-local');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   518
YUI.Env.Tests.examples.push('datasource-get');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   519
YUI.Env.Tests.examples.push('datasource-io');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   520
YUI.Env.Tests.examples.push('datasource-function');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   521
YUI.Env.Tests.examples.push('datasource-caching');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   522
YUI.Env.Tests.examples.push('datasource-offlinecache');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   523
YUI.Env.Tests.examples.push('datasource-polling');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   524
YUI.Env.Tests.examples.push('ac-datasource');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   526
</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   527
<script src="../assets/yui/test-runner.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   528
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   529
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   530
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   531
</body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   532
</html>