|
525
|
1 |
<!DOCTYPE html> |
|
|
2 |
<html lang="en"> |
|
|
3 |
<head> |
|
|
4 |
<meta charset="utf-8"> |
|
|
5 |
<title>Example: DataSource with Caching</title> |
|
|
6 |
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic"> |
|
|
7 |
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css"> |
|
|
8 |
<link rel="stylesheet" href="../assets/css/main.css"> |
|
|
9 |
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> |
|
|
10 |
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> |
|
|
11 |
<script src="../../build/yui/yui-min.js"></script> |
|
|
12 |
|
|
|
13 |
</head> |
|
|
14 |
<body> |
|
|
15 |
<!-- |
|
|
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> |
|
|
17 |
--> |
|
|
18 |
<div id="doc"> |
|
|
19 |
<div id="hd"> |
|
|
20 |
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1> |
|
|
21 |
</div> |
|
|
22 |
|
|
|
23 |
|
|
|
24 |
<h1>Example: DataSource with Caching</h1> |
|
|
25 |
<div class="yui3-g"> |
|
|
26 |
<div class="yui3-u-3-4"> |
|
|
27 |
<div id="main"> |
|
|
28 |
<div class="content"><style scoped> |
|
|
29 |
/* custom styles for this example */ |
|
|
30 |
#demo .output { |
|
|
31 |
margin-bottom:1em; |
|
|
32 |
padding:10px; |
|
|
33 |
border:1px solid #D9D9D9; |
|
|
34 |
} |
|
|
35 |
#demo .output pre { |
|
|
36 |
font-size: 11px; |
|
|
37 |
} |
|
|
38 |
#demo .output strong { |
|
|
39 |
padding: .25em .4em; |
|
|
40 |
background: #333; |
|
|
41 |
color: #fff; |
|
|
42 |
text-shadow: -1px -1px 1px #000; |
|
|
43 |
border-radius: 5px; |
|
|
44 |
} |
|
|
45 |
</style> |
|
|
46 |
|
|
|
47 |
<div class="intro"> |
|
|
48 |
<p>The DataSourceCache plugin enables caching on any DataSource to reduce high-latency calls to remote sources and to reduce server load. In this example, the Cache's <code>max</code> value has been set to <code>3</code>. |
|
|
49 |
|
|
|
50 |
</div> |
|
|
51 |
|
|
|
52 |
<div class="example yui3-skin-sam"> |
|
|
53 |
<form id="demo" action="http://search.yahoo.com/search"> |
|
|
54 |
<h6>Look up github repositories by username (e.g., davglass, lsmith or rgrove):</h6> |
|
|
55 |
<input type="input" id="demo_input_query" name="p"> |
|
|
56 |
<input type="submit" id="demo_query_retrieve" value="Retrieve data"> |
|
|
57 |
<input type="button" id="demo_cache_clear" value="Clear cache"> |
|
|
58 |
<div id="demo_output_response" class="output"></div> |
|
|
59 |
</form> |
|
|
60 |
|
|
|
61 |
<script type="text/javascript"> |
|
|
62 |
YUI().use("json-stringify","node", "datasource-get", "datasource-jsonschema", "datasource-cache", "datatype-date", function (Y) { |
|
|
63 |
var output = Y.one("#demo_output_response"), |
|
|
64 |
source = "remote source", |
|
|
65 |
|
|
|
66 |
myDataSource = new Y.DataSource.Get({ |
|
|
67 |
source:"https://api.github.com/users/", |
|
|
68 |
generateRequestCallback: function (guid) { |
|
|
69 |
return '/repos?callback=YUI.Env.DataSource.callbacks.' + guid; |
|
|
70 |
} |
|
|
71 |
}), |
|
|
72 |
|
|
|
73 |
callback = { |
|
|
74 |
success: function(e){ |
|
|
75 |
var when = Y.DataType.Date.format(new Date(), {format:"%F %r"}), |
|
|
76 |
data = Y.JSON.stringify(e.response, null, 2); |
|
|
77 |
|
|
|
78 |
output.setHTML( |
|
|
79 |
"<p>[" + when + "] Retrieved from " + |
|
|
80 |
"<strong>" + source + "</strong></p>" + |
|
|
81 |
"<pre>" + |
|
|
82 |
data.replace(/&/g,"&") |
|
|
83 |
.replace(/</g,"<") |
|
|
84 |
.replace(/>/g,">") + |
|
|
85 |
"</pre>"); |
|
|
86 |
}, |
|
|
87 |
failure: function(e){ |
|
|
88 |
var when = Y.DataType.Date.format(new Date(), {format:"%F %r"}), |
|
|
89 |
message = /fields retrieval/.test(e.error.message) ? |
|
|
90 |
"User not found" : e.error.message; |
|
|
91 |
|
|
|
92 |
output.setHTML( |
|
|
93 |
"<p>[" + when + "] Could not retrieve data: " + |
|
|
94 |
"<em>" + message + "</em>" + |
|
|
95 |
"</p>"); |
|
|
96 |
} |
|
|
97 |
}; |
|
|
98 |
|
|
|
99 |
myDataSource.plug(Y.Plugin.DataSourceJSONSchema, { |
|
|
100 |
schema: { |
|
|
101 |
resultListLocator: "data", |
|
|
102 |
resultFields: ["name"] |
|
|
103 |
} |
|
|
104 |
}); |
|
|
105 |
|
|
|
106 |
myDataSource.plug(Y.Plugin.DataSourceCache, { max: 3 }); |
|
|
107 |
myDataSource.cache.on("retrieve", function(){ |
|
|
108 |
source = "cache"; |
|
|
109 |
}); |
|
|
110 |
|
|
|
111 |
Y.one("#demo_cache_clear").on("click", function(){ |
|
|
112 |
var when = Y.DataType.Date.format(new Date(), {format:"%F %r"}); |
|
|
113 |
|
|
|
114 |
myDataSource.cache.flush(); |
|
|
115 |
output.setHTML("<p>[" + when + "] Cache cleared.</p>"); |
|
|
116 |
}); |
|
|
117 |
|
|
|
118 |
Y.on("submit", function(e){ |
|
|
119 |
e.halt(); |
|
|
120 |
var query = encodeURIComponent( |
|
|
121 |
Y.one("#demo_input_query") |
|
|
122 |
.get("value") |
|
|
123 |
.replace(/"/g,'\\"') |
|
|
124 |
.replace(/\W/g, '')); |
|
|
125 |
|
|
|
126 |
if(query) { |
|
|
127 |
source = "remote source"; |
|
|
128 |
myDataSource.sendRequest({ |
|
|
129 |
request:query, |
|
|
130 |
callback:callback |
|
|
131 |
}); |
|
|
132 |
} else { |
|
|
133 |
output.setHTML("<p>Please enter a query.</p>"); |
|
|
134 |
} |
|
|
135 |
}, "#demo"); |
|
|
136 |
}); |
|
|
137 |
</script> |
|
|
138 |
|
|
|
139 |
</div> |
|
|
140 |
|
|
|
141 |
<p>Use the <code>plug()</code> method to initialize the |
|
|
142 |
<code>DataSourceCache</code> plugin and pass in the configuration value |
|
|
143 |
<code>max</code> to set the maximum size.</p> |
|
|
144 |
|
|
|
145 |
<pre class="code prettyprint">YUI().use("datasource", "dataschema", "cache", function (Y) { |
|
|
146 |
var callback = { |
|
|
147 |
success: function (e) { /* output to screen */ }, |
|
|
148 |
failure: function (e) { /* output to screen */ } |
|
|
149 |
}, |
|
|
150 |
|
|
|
151 |
myDataSource = new Y.DataSource.Get({ |
|
|
152 |
source: "https://api.github.com/users/", |
|
|
153 |
|
|
|
154 |
// this is only needed because the query appends the url |
|
|
155 |
// rather than the url's query params |
|
|
156 |
generateRequestCallback: function (guid) { |
|
|
157 |
return '/repos?callback=YUI.Env.DataSource.callbacks.' + guid; |
|
|
158 |
} |
|
|
159 |
}), |
|
|
160 |
|
|
|
161 |
myDataSource.plug(Y.Plugin.DataSourceJSONSchema, { |
|
|
162 |
schema: { |
|
|
163 |
resultListLocator: "data", |
|
|
164 |
resultFields: ["name"] |
|
|
165 |
} |
|
|
166 |
}); |
|
|
167 |
|
|
|
168 |
myDataSource.plug(Y.Plugin.DataSourceCache, { max: 3 }); |
|
|
169 |
|
|
|
170 |
// Adds to cache |
|
|
171 |
myDataSource.sendRequest({ |
|
|
172 |
request : "lsmith", |
|
|
173 |
callback: callback |
|
|
174 |
}); |
|
|
175 |
|
|
|
176 |
// Adds to cache |
|
|
177 |
myDataSource.sendRequest({ |
|
|
178 |
request : "davglass", |
|
|
179 |
callback: callback |
|
|
180 |
}); |
|
|
181 |
|
|
|
182 |
// Retrieves from cache |
|
|
183 |
myDataSource.sendRequest({ |
|
|
184 |
request : "lsmith", |
|
|
185 |
callback: callback |
|
|
186 |
}); |
|
|
187 |
});</pre> |
|
|
188 |
|
|
|
189 |
|
|
|
190 |
<h3 id="fullsource">Full Example Source Listing</h3> |
|
|
191 |
|
|
|
192 |
<pre class="code prettyprint"><form id="demo" action="http://search.yahoo.com/search"> |
|
|
193 |
<h6>Look up github repositories by username (e.g., davglass, lsmith or rgrove):</h6> |
|
|
194 |
<input type="input" id="demo_input_query" name="p"> |
|
|
195 |
<input type="submit" id="demo_query_retrieve" value="Retrieve data"> |
|
|
196 |
<input type="button" id="demo_cache_clear" value="Clear cache"> |
|
|
197 |
<div id="demo_output_response" class="output"></div> |
|
|
198 |
</form> |
|
|
199 |
|
|
|
200 |
<script type="text/javascript"> |
|
|
201 |
YUI().use("json-stringify","node", "datasource-get", "datasource-jsonschema", "datasource-cache", "datatype-date", function (Y) { |
|
|
202 |
var output = Y.one("#demo_output_response"), |
|
|
203 |
source = "remote source", |
|
|
204 |
|
|
|
205 |
myDataSource = new Y.DataSource.Get({ |
|
|
206 |
source:"https://api.github.com/users/", |
|
|
207 |
generateRequestCallback: function (guid) { |
|
|
208 |
return '/repos?callback=YUI.Env.DataSource.callbacks.' + guid; |
|
|
209 |
} |
|
|
210 |
}), |
|
|
211 |
|
|
|
212 |
callback = { |
|
|
213 |
success: function(e){ |
|
|
214 |
var when = Y.DataType.Date.format(new Date(), {format:"%F %r"}), |
|
|
215 |
data = Y.JSON.stringify(e.response, null, 2); |
|
|
216 |
|
|
|
217 |
output.setHTML( |
|
|
218 |
"<p>[" + when + "] Retrieved from " + |
|
|
219 |
"<strong>" + source + "</strong></p>" + |
|
|
220 |
"<pre>" + |
|
|
221 |
data.replace(/&/g,"&amp;") |
|
|
222 |
.replace(/</g,"&lt;") |
|
|
223 |
.replace(/>/g,"&gt;") + |
|
|
224 |
"</pre>"); |
|
|
225 |
}, |
|
|
226 |
failure: function(e){ |
|
|
227 |
var when = Y.DataType.Date.format(new Date(), {format:"%F %r"}), |
|
|
228 |
message = /fields retrieval/.test(e.error.message) ? |
|
|
229 |
"User not found" : e.error.message; |
|
|
230 |
|
|
|
231 |
output.setHTML( |
|
|
232 |
"<p>[" + when + "] Could not retrieve data: " + |
|
|
233 |
"<em>" + message + "</em>" + |
|
|
234 |
"</p>"); |
|
|
235 |
} |
|
|
236 |
}; |
|
|
237 |
|
|
|
238 |
myDataSource.plug(Y.Plugin.DataSourceJSONSchema, { |
|
|
239 |
schema: { |
|
|
240 |
resultListLocator: "data", |
|
|
241 |
resultFields: ["name"] |
|
|
242 |
} |
|
|
243 |
}); |
|
|
244 |
|
|
|
245 |
myDataSource.plug(Y.Plugin.DataSourceCache, { max: 3 }); |
|
|
246 |
myDataSource.cache.on("retrieve", function(){ |
|
|
247 |
source = "cache"; |
|
|
248 |
}); |
|
|
249 |
|
|
|
250 |
Y.one("#demo_cache_clear").on("click", function(){ |
|
|
251 |
var when = Y.DataType.Date.format(new Date(), {format:"%F %r"}); |
|
|
252 |
|
|
|
253 |
myDataSource.cache.flush(); |
|
|
254 |
output.setHTML("<p>[" + when + "] Cache cleared.</p>"); |
|
|
255 |
}); |
|
|
256 |
|
|
|
257 |
Y.on("submit", function(e){ |
|
|
258 |
e.halt(); |
|
|
259 |
var query = encodeURIComponent( |
|
|
260 |
Y.one("#demo_input_query") |
|
|
261 |
.get("value") |
|
|
262 |
.replace(/"/g,'\\"') |
|
|
263 |
.replace(/\W/g, '')); |
|
|
264 |
|
|
|
265 |
if(query) { |
|
|
266 |
source = "remote source"; |
|
|
267 |
myDataSource.sendRequest({ |
|
|
268 |
request:query, |
|
|
269 |
callback:callback |
|
|
270 |
}); |
|
|
271 |
} else { |
|
|
272 |
output.setHTML("<p>Please enter a query.</p>"); |
|
|
273 |
} |
|
|
274 |
}, "#demo"); |
|
|
275 |
}); |
|
|
276 |
</script></pre> |
|
|
277 |
|
|
|
278 |
</div> |
|
|
279 |
</div> |
|
|
280 |
</div> |
|
|
281 |
|
|
|
282 |
<div class="yui3-u-1-4"> |
|
|
283 |
<div class="sidebar"> |
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
<div class="sidebox"> |
|
|
288 |
<div class="hd"> |
|
|
289 |
<h2 class="no-toc">Examples</h2> |
|
|
290 |
</div> |
|
|
291 |
|
|
|
292 |
<div class="bd"> |
|
|
293 |
<ul class="examples"> |
|
|
294 |
|
|
|
295 |
|
|
|
296 |
<li data-description="The Local DataSource manages retrieval of in-page data, from JavaScript arrays and objects to DOM elements."> |
|
|
297 |
<a href="datasource-local.html">DataSource.Local</a> |
|
|
298 |
</li> |
|
|
299 |
|
|
|
300 |
|
|
|
301 |
|
|
|
302 |
<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."> |
|
|
303 |
<a href="datasource-get.html">DataSource.Get</a> |
|
|
304 |
</li> |
|
|
305 |
|
|
|
306 |
|
|
|
307 |
|
|
|
308 |
<li data-description="The IO DataSource manages retrieval of data from remote sources, via the IO Utility."> |
|
|
309 |
<a href="datasource-io.html">DataSource.IO</a> |
|
|
310 |
</li> |
|
|
311 |
|
|
|
312 |
|
|
|
313 |
|
|
|
314 |
<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"> |
|
|
315 |
<a href="datasource-function.html">DataSource.Function</a> |
|
|
316 |
</li> |
|
|
317 |
|
|
|
318 |
|
|
|
319 |
|
|
|
320 |
<li data-description="Use the DataSourceCache plugin to enable caching and reduce server calls to remote sources."> |
|
|
321 |
<a href="datasource-caching.html">DataSource with Caching</a> |
|
|
322 |
</li> |
|
|
323 |
|
|
|
324 |
|
|
|
325 |
|
|
|
326 |
<li data-description="The DataSourceCache plugin supports offline caching so that cached data persists across browser sessions."> |
|
|
327 |
<a href="datasource-offlinecache.html">DataSource with Offline Cache</a> |
|
|
328 |
</li> |
|
|
329 |
|
|
|
330 |
|
|
|
331 |
|
|
|
332 |
<li data-description="Use the Pollable extension to enable polling in your DataSource."> |
|
|
333 |
<a href="datasource-polling.html">DataSource with Polling</a> |
|
|
334 |
</li> |
|
|
335 |
|
|
|
336 |
|
|
|
337 |
|
|
|
338 |
|
|
|
339 |
</ul> |
|
|
340 |
</div> |
|
|
341 |
</div> |
|
|
342 |
|
|
|
343 |
|
|
|
344 |
|
|
|
345 |
<div class="sidebox"> |
|
|
346 |
<div class="hd"> |
|
|
347 |
<h2 class="no-toc">Examples That Use This Component</h2> |
|
|
348 |
</div> |
|
|
349 |
|
|
|
350 |
<div class="bd"> |
|
|
351 |
<ul class="examples"> |
|
|
352 |
|
|
|
353 |
|
|
|
354 |
|
|
|
355 |
|
|
|
356 |
|
|
|
357 |
|
|
|
358 |
|
|
|
359 |
|
|
|
360 |
|
|
|
361 |
|
|
|
362 |
|
|
|
363 |
|
|
|
364 |
|
|
|
365 |
|
|
|
366 |
|
|
|
367 |
|
|
|
368 |
<li data-description="How to provide autocomplete suggestions using a DataSource instance."> |
|
|
369 |
<a href="../autocomplete/ac-datasource.html">Remote Data via DataSource</a> |
|
|
370 |
</li> |
|
|
371 |
|
|
|
372 |
|
|
|
373 |
</ul> |
|
|
374 |
</div> |
|
|
375 |
</div> |
|
|
376 |
|
|
|
377 |
</div> |
|
|
378 |
</div> |
|
|
379 |
</div> |
|
|
380 |
</div> |
|
|
381 |
|
|
|
382 |
<script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
|
383 |
<script>prettyPrint();</script> |
|
|
384 |
|
|
|
385 |
<script> |
|
|
386 |
YUI.Env.Tests = { |
|
|
387 |
examples: [], |
|
|
388 |
project: '../assets', |
|
|
389 |
assets: '../assets/datasource', |
|
|
390 |
name: 'datasource-caching', |
|
|
391 |
title: 'DataSource with Caching', |
|
|
392 |
newWindow: '', |
|
|
393 |
auto: false |
|
|
394 |
}; |
|
|
395 |
YUI.Env.Tests.examples.push('datasource-local'); |
|
|
396 |
YUI.Env.Tests.examples.push('datasource-get'); |
|
|
397 |
YUI.Env.Tests.examples.push('datasource-io'); |
|
|
398 |
YUI.Env.Tests.examples.push('datasource-function'); |
|
|
399 |
YUI.Env.Tests.examples.push('datasource-caching'); |
|
|
400 |
YUI.Env.Tests.examples.push('datasource-offlinecache'); |
|
|
401 |
YUI.Env.Tests.examples.push('datasource-polling'); |
|
|
402 |
YUI.Env.Tests.examples.push('ac-datasource'); |
|
|
403 |
|
|
|
404 |
</script> |
|
|
405 |
<script src="../assets/yui/test-runner.js"></script> |
|
|
406 |
|
|
|
407 |
|
|
|
408 |
|
|
|
409 |
</body> |
|
|
410 |
</html> |