<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: datasource datasource-local.js (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>datasource <span class="subtitle">3.0.0b1</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_datasource.html" title="datasource">datasource</a>
> datasource-local.js (source view)
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<div id="srcout">
<style>
#doc3 .classopts { display:none; }
</style>
<div class="highlight" ><pre><span class="c">/**</span>
<span class="c"> * The DataSource utility provides a common configurable interface for widgets to</span>
<span class="c"> * access a variety of data, from JavaScript arrays to online database servers.</span>
<span class="c"> *</span>
<span class="c"> * @module datasource</span>
<span class="c"> */</span>
<span class="c">/**</span>
<span class="c"> * Provides the base DataSource implementation, which can be extended to</span>
<span class="c"> * create DataSources for specific data protocols, such as the IO Utility, the</span>
<span class="c"> * Get Utility, or custom functions.</span>
<span class="c"> *</span>
<span class="c"> * @module datasource</span>
<span class="c"> * @submodule datasource-local</span>
<span class="c"> */</span>
<span class="c">/**</span>
<span class="c"> * Base class for the DataSource Utility.</span>
<span class="c"> * @class DataSource.Local</span>
<span class="c"> * @extends Base</span>
<span class="c"> * @constructor</span>
<span class="c"> */</span>
<span class="k">var</span> <span class="nx">LANG</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span>
<span class="nx">DSLocal</span> <span class="o">=</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="nx">DSLocal</span><span class="o">.</span><span class="nx">superclass</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">arguments</span><span class="o">);</span>
<span class="o">};</span>
<span class="c">/////////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span> <span class="c">//</span>
<span class="c"></span> <span class="c">// DataSource static properties</span>
<span class="c"></span> <span class="c">//</span>
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span><span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">DSLocal</span><span class="o">,</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Class name.</span>
<span class="c"> *</span>
<span class="c"> * @property NAME</span>
<span class="c"> * @type String</span>
<span class="c"> * @static </span>
<span class="c"> * @final</span>
<span class="c"> * @value "dataSourceLocal"</span>
<span class="c"> */</span>
<span class="nx">NAME</span><span class="o">:</span> <span class="s2">"dataSourceLocal"</span><span class="o">,</span>
<span class="c">/////////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span> <span class="c">//</span>
<span class="c"></span> <span class="c">// DataSource Attributes</span>
<span class="c"></span> <span class="c">//</span>
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span>
<span class="nx">ATTRS</span><span class="o">:</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * @attribute source</span>
<span class="c"> * @description Pointer to live data.</span>
<span class="c"> * @type MIXED</span>
<span class="c"> * @default null </span>
<span class="c"> */</span>
<span class="nx">source</span><span class="o">:</span> <span class="o">{</span>
<span class="nx">value</span><span class="o">:</span> <span class="kc">null</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Global transaction counter.</span>
<span class="c"> *</span>
<span class="c"> * @property DataSource._tId</span>
<span class="c"> * @type Number</span>
<span class="c"> * @static</span>
<span class="c"> * @private</span>
<span class="c"> * @default 0</span>
<span class="c"> */</span>
<span class="nx">_tId</span><span class="o">:</span> <span class="m">0</span><span class="o">,</span>
<span class="c">/**</span>
<span class="c"> * Executes a given callback. The third param determines whether to execute</span>
<span class="c"> *</span>
<span class="c"> * @method DataSource.issueCallback</span>
<span class="c"> * @param callback {Object} The callback object.</span>
<span class="c"> * @param params {Array} params to be passed to the callback method</span>
<span class="c"> * @param error {Boolean} whether an error occurred</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">issueCallback</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">callbackFunc</span> <span class="o">=</span> <span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">error</span> <span class="o">&&</span> <span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">.</span><span class="nx">failure</span><span class="o">)</span> <span class="o">||</span> <span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">.</span><span class="nx">success</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">callbackFunc</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">callbackFunc</span><span class="o">(</span><span class="nx">e</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">});</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">extend</span><span class="o">(</span><span class="nx">DSLocal</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Base</span><span class="o">,</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Internal init() handler.</span>
<span class="c"> *</span>
<span class="c"> * @method initializer</span>
<span class="c"> * @param config {Object} Config object.</span>
<span class="c"> * @private </span>
<span class="c"> */</span>
<span class="nx">initializer</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">_initEvents</span><span class="o">();</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * This method creates all the events for this module.</span>
<span class="c"> * @method _initEvents</span>
<span class="c"> * @private </span>
<span class="c"> */</span>
<span class="nx">_initEvents</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Fired when a data request is received.</span>
<span class="c"> *</span>
<span class="c"> * @event request</span>
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span>
<span class="c"> * <dl> </span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object.</dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @preventable _defRequestFn</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s2">"request"</span><span class="o">,</span> <span class="o">{</span><span class="nx">defaultFn</span><span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">bind</span><span class="o">(</span><span class="s2">"_defRequestFn"</span><span class="o">,</span> <span class="k">this</span><span class="o">),</span> <span class="nx">queuable</span><span class="o">:</span><span class="kc">true</span><span class="o">});</span>
<span class="c">/**</span>
<span class="c"> * Fired when raw data is received.</span>
<span class="c"> *</span>
<span class="c"> * @event data</span>
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>success (Function)</dt> <dd>Success handler.</dd></span>
<span class="c"> * <dt>failure (Function)</dt> <dd>Failure handler.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * <dt>data (Object)</dt> <dd>Raw data.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @preventable _defDataFn</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s2">"data"</span><span class="o">,</span> <span class="o">{</span><span class="nx">defaultFn</span><span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">bind</span><span class="o">(</span><span class="s2">"_defDataFn"</span><span class="o">,</span> <span class="k">this</span><span class="o">),</span> <span class="nx">queuable</span><span class="o">:</span><span class="kc">true</span><span class="o">});</span>
<span class="c">/**</span>
<span class="c"> * Fired when response is returned.</span>
<span class="c"> *</span>
<span class="c"> * @event response</span>
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>success (Function)</dt> <dd>Success handler.</dd></span>
<span class="c"> * <dt>failure (Function)</dt> <dd>Failure handler.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * <dt>data (Object)</dt> <dd>Raw data.</dd></span>
<span class="c"> * <dt>response (Object)</dt> <dd>Normalized response object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>results (Object)</dt> <dd>Parsed results.</dd></span>
<span class="c"> * <dt>meta (Object)</dt> <dd>Parsed meta data.</dd></span>
<span class="c"> * <dt>error (Boolean)</dt> <dd>Error flag.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @preventable _defResponseFn</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s2">"response"</span><span class="o">,</span> <span class="o">{</span><span class="nx">defaultFn</span><span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">bind</span><span class="o">(</span><span class="s2">"_defResponseFn"</span><span class="o">,</span> <span class="k">this</span><span class="o">),</span> <span class="nx">queuable</span><span class="o">:</span><span class="kc">true</span><span class="o">});</span>
<span class="c">/**</span>
<span class="c"> * Fired when an error is encountered.</span>
<span class="c"> *</span>
<span class="c"> * @event error</span>
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>success (Function)</dt> <dd>Success handler.</dd></span>
<span class="c"> * <dt>failure (Function)</dt> <dd>Failure handler.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * <dt>data (Object)</dt> <dd>Raw data.</dd></span>
<span class="c"> * <dt>response (Object)</dt> <dd>Normalized response object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>results (Object)</dt> <dd>Parsed results.</dd></span>
<span class="c"> * <dt>meta (Object)</dt> <dd>Parsed meta data.</dd></span>
<span class="c"> * <dt>error (Object)</dt> <dd>Error object.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * </dl></span>
<span class="c"> */</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Manages request/response transaction. Must fire <code>response</code></span>
<span class="c"> * event when response is received. This method should be implemented by</span>
<span class="c"> * subclasses to achieve more complex behavior such as accessing remote data.</span>
<span class="c"> *</span>
<span class="c"> * @method _defRequestFn</span>
<span class="c"> * @param e {Event.Facade} Event Facadewith the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>success (Function)</dt> <dd>Success handler.</dd></span>
<span class="c"> * <dt>failure (Function)</dt> <dd>Failure handler.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @protected</span>
<span class="c"> */</span>
<span class="nx">_defRequestFn</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"source"</span><span class="o">);</span>
<span class="c">// Problematic data</span>
<span class="c"></span> <span class="k">if</span><span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">data</span><span class="o">))</span> <span class="o">{</span>
<span class="nx">e</span><span class="o">.</span><span class="nx">error</span> <span class="o">=</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="s2">"Local source undefined"</span><span class="o">);</span>
<span class="o">}</span>
<span class="k">if</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">error</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"error"</span><span class="o">,</span> <span class="nx">e</span><span class="o">);</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Error in response"</span><span class="o">,</span> <span class="s2">"error"</span><span class="o">,</span> <span class="s2">"datasource-local"</span><span class="o">);</span>
<span class="o">}</span>
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"data"</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">({</span><span class="nx">data</span><span class="o">:</span><span class="nx">data</span><span class="o">},</span> <span class="nx">e</span><span class="o">));</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Transaction "</span> <span class="o">+</span> <span class="nx">e</span><span class="o">.</span><span class="nx">tId</span> <span class="o">+</span> <span class="s2">" complete. Request: "</span> <span class="o">+</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">request</span><span class="o">)</span> <span class="o">+</span> <span class="s2">" . Response: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">response</span><span class="o">),</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"datasource-local"</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Normalizes raw data into a response that includes results and meta properties.</span>
<span class="c"> *</span>
<span class="c"> * @method _defDataFn</span>
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>success (Function)</dt> <dd>Success handler.</dd></span>
<span class="c"> * <dt>failure (Function)</dt> <dd>Failure handler.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * <dt>data (Object)</dt> <dd>Raw data.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @protected</span>
<span class="c"> */</span>
<span class="nx">_defDataFn</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="nx">e</span><span class="o">.</span><span class="nx">data</span><span class="o">,</span>
<span class="nx">meta</span> <span class="o">=</span> <span class="nx">e</span><span class="o">.</span><span class="nx">meta</span><span class="o">,</span>
<span class="nx">response</span> <span class="o">=</span> <span class="o">{</span>
<span class="nx">results</span><span class="o">:</span> <span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isArray</span><span class="o">(</span><span class="nx">data</span><span class="o">))</span> <span class="o">?</span> <span class="nx">data</span> <span class="o">:</span> <span class="o">[</span><span class="nx">data</span><span class="o">],</span>
<span class="nx">meta</span><span class="o">:</span> <span class="o">(</span><span class="nx">meta</span><span class="o">)</span> <span class="o">?</span> <span class="nx">meta</span> <span class="o">:</span> <span class="o">{}</span>
<span class="o">};</span>
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"response"</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">({</span><span class="nx">response</span><span class="o">:</span> <span class="nx">response</span><span class="o">},</span> <span class="nx">e</span><span class="o">));</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Sends data as a normalized response to callback.</span>
<span class="c"> *</span>
<span class="c"> * @method _defResponseFn</span>
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd></span>
<span class="c"> * <dt>request (Object)</dt> <dd>The request.</dd></span>
<span class="c"> * <dt>callback (Object)</dt> <dd>The callback object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>success (Function)</dt> <dd>Success handler.</dd></span>
<span class="c"> * <dt>failure (Function)</dt> <dd>Failure handler.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>cfg (Object)</dt> <dd>Configuration object.</dd></span>
<span class="c"> * <dt>data (Object)</dt> <dd>Raw data.</dd></span>
<span class="c"> * <dt>response (Object)</dt> <dd>Normalized response object with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>results (Object)</dt> <dd>Parsed results.</dd></span>
<span class="c"> * <dt>meta (Object)</dt> <dd>Parsed meta data.</dd></span>
<span class="c"> * <dt>error (Boolean)</dt> <dd>Error flag.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * </dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @protected</span>
<span class="c"> */</span>
<span class="nx">_defResponseFn</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// Send the response back to the callback</span>
<span class="c"></span> <span class="nx">DSLocal</span><span class="o">.</span><span class="nx">issueCallback</span><span class="o">(</span><span class="nx">e</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Generates a unique transaction ID and fires <code>request</code> event.</span>
<span class="c"> *</span>
<span class="c"> * @method sendRequest</span>
<span class="c"> * @param request {Object} Request.</span>
<span class="c"> * @param callback {Object} An object literal with the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt><code>success</code></dt></span>
<span class="c"> * <dd>The function to call when the data is ready.</dd></span>
<span class="c"> * <dt><code>failure</code></dt></span>
<span class="c"> * <dd>The function to call upon a response failure condition.</dd></span>
<span class="c"> * <dt><code>argument</code></dt></span>
<span class="c"> * <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd></span>
<span class="c"> * </dl></span>
<span class="c"> * @param cfg {Object} Configuration object</span>
<span class="c"> * @return {Number} Transaction ID.</span>
<span class="c"> */</span>
<span class="nx">sendRequest</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">request</span><span class="o">,</span> <span class="nx">callback</span><span class="o">,</span> <span class="nx">cfg</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">tId</span> <span class="o">=</span> <span class="nx">DSLocal</span><span class="o">.</span><span class="nx">_tId</span><span class="o">++;</span>
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"request"</span><span class="o">,</span> <span class="o">{</span><span class="nx">tId</span><span class="o">:</span><span class="nx">tId</span><span class="o">,</span> <span class="nx">request</span><span class="o">:</span><span class="nx">request</span><span class="o">,</span> <span class="nx">callback</span><span class="o">:</span><span class="nx">callback</span><span class="o">,</span> <span class="nx">cfg</span><span class="o">:</span><span class="nx">cfg</span> <span class="o">||</span> <span class="o">{}});</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Transaction "</span> <span class="o">+</span> <span class="nx">tId</span> <span class="o">+</span> <span class="s2">" sent request: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">request</span><span class="o">),</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"datasource-local"</span><span class="o">);</span>
<span class="k">return</span> <span class="nx">tId</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">});</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">namespace</span><span class="o">(</span><span class="s2">"DataSource"</span><span class="o">).</span><span class="nx">Local</span> <span class="o">=</span> <span class="nx">DSLocal</span><span class="o">;</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class="selected"><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_queue.html" title="queue">queue</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="DataSource.Function.html" title="DataSource.Function">DataSource.Function</a></li>
<li class=""><a href="DataSource.Get.html" title="DataSource.Get">DataSource.Get</a></li>
<li class=""><a href="DataSource.IO.html" title="DataSource.IO">DataSource.IO</a></li>
<li class=""><a href="DataSource.Local.html" title="DataSource.Local">DataSource.Local</a></li>
<li class=""><a href="DataSourceArraySchema.html" title="DataSourceArraySchema">DataSourceArraySchema</a></li>
<li class=""><a href="DataSourceCache.html" title="DataSourceCache">DataSourceCache</a></li>
<li class=""><a href="DataSourceJSONSchema.html" title="DataSourceJSONSchema">DataSourceJSONSchema</a></li>
<li class=""><a href="DataSourceTextSchema.html" title="DataSourceTextSchema">DataSourceTextSchema</a></li>
<li class=""><a href="DataSourceXMLSchema.html" title="DataSourceXMLSchema">DataSourceXMLSchema</a></li>
<li class=""><a href="Pollable.html" title="Pollable">Pollable</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="datasource-arrayschema.js.html" title="datasource-arrayschema.js">datasource-arrayschema.js</a></li>
<li class=""><a href="datasource-cache.js.html" title="datasource-cache.js">datasource-cache.js</a></li>
<li class=""><a href="datasource-function.js.html" title="datasource-function.js">datasource-function.js</a></li>
<li class=""><a href="datasource-get.js.html" title="datasource-get.js">datasource-get.js</a></li>
<li class=""><a href="datasource-io.js.html" title="datasource-io.js">datasource-io.js</a></li>
<li class=""><a href="datasource-jsonschema.js.html" title="datasource-jsonschema.js">datasource-jsonschema.js</a></li>
<li class="selected"><a href="datasource-local.js.html" title="datasource-local.js">datasource-local.js</a></li>
<li class=""><a href="datasource-polling.js.html" title="datasource-polling.js">datasource-polling.js</a></li>
<li class=""><a href="datasource-textschema.js.html" title="datasource-textschema.js">datasource-textschema.js</a></li>
<li class=""><a href="datasource-xmlschema.js.html" title="datasource-xmlschema.js">datasource-xmlschema.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "", "host": "DataSource.Get", "name": "asyncMode", "url": "DataSource.Get.html#config_asyncMode", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "asyncModeChange", "url": "DataSource.Get.html#event_asyncModeChange", "type": "event"}, {"access": "protected", "host": "DataSourceArraySchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceArraySchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "protected", "host": "DataSourceXMLSchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceXMLSchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "protected", "host": "DataSourceJSONSchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceJSONSchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "protected", "host": "DataSourceTextSchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceTextSchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "protected", "host": "DataSourceCache", "name": "_beforeDefRequestFn", "url": "DataSourceCache.html#method__beforeDefRequestFn", "type": "method"}, {"access": "protected", "host": "DataSourceCache", "name": "_beforeDefResponseFn", "url": "DataSourceCache.html#method__beforeDefResponseFn", "type": "method"}, {"access": "", "host": "DataSource.Get", "name": "callbacks", "url": "DataSource.Get.html#property_callbacks", "type": "property"}, {"access": "", "host": "Pollable", "name": "clearAllIntervals", "url": "Pollable.html#method_clearAllIntervals", "type": "method"}, {"access": "", "host": "Pollable", "name": "clearInterval", "url": "Pollable.html#method_clearInterval", "type": "method"}, {"access": "", "host": "DataSource.Local", "name": "data", "url": "DataSource.Local.html#event_data", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "DataSource.issueCallback", "url": "DataSource.Local.html#method_DataSource.issueCallback", "type": "method"}, {"access": "private", "host": "DataSource.Local", "name": "DataSource._tId", "url": "DataSource.Local.html#property_DataSource._tId", "type": "property"}, {"access": "protected", "host": "DataSource.Local", "name": "_defDataFn", "url": "DataSource.Local.html#method__defDataFn", "type": "method"}, {"access": "protected", "host": "DataSource.Get", "name": "_defRequestFn", "url": "DataSource.Get.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.Function", "name": "_defRequestFn", "url": "DataSource.Function.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.IO", "name": "_defRequestFn", "url": "DataSource.IO.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.Local", "name": "_defRequestFn", "url": "DataSource.Local.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.Local", "name": "_defResponseFn", "url": "DataSource.Local.html#method__defResponseFn", "type": "method"}, {"access": "", "host": "DataSource.Local", "name": "error", "url": "DataSource.Local.html#event_error", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "generateRequestCallback", "url": "DataSource.Get.html#config_generateRequestCallback", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "generateRequestCallbackChange", "url": "DataSource.Get.html#event_generateRequestCallbackChange", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "get", "url": "DataSource.Get.html#config_get", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "getChange", "url": "DataSource.Get.html#event_getChange", "type": "event"}, {"access": "private", "host": "DataSource.Local", "name": "_initEvents", "url": "DataSource.Local.html#method__initEvents", "type": "method"}, {"access": "private", "host": "DataSourceArraySchema", "name": "initializer", "url": "DataSourceArraySchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSourceXMLSchema", "name": "initializer", "url": "DataSourceXMLSchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSourceJSONSchema", "name": "initializer", "url": "DataSourceJSONSchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSource.IO", "name": "initializer", "url": "DataSource.IO.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSource.Local", "name": "initializer", "url": "DataSource.Local.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSourceCache", "name": "initializer", "url": "DataSourceCache.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSourceTextSchema", "name": "initializer", "url": "DataSourceTextSchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "Pollable", "name": "_intervals", "url": "Pollable.html#property__intervals", "type": "property"}, {"access": "", "host": "DataSource.IO", "name": "io", "url": "DataSource.IO.html#config_io", "type": "config"}, {"access": "", "host": "DataSource.IO", "name": "ioChange", "url": "DataSource.IO.html#event_ioChange", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "NAME", "url": "DataSource.Get.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.Function", "name": "NAME", "url": "DataSource.Function.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceArraySchema", "name": "NAME", "url": "DataSourceArraySchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceXMLSchema", "name": "NAME", "url": "DataSourceXMLSchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceJSONSchema", "name": "NAME", "url": "DataSourceJSONSchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.IO", "name": "NAME", "url": "DataSource.IO.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.Local", "name": "NAME", "url": "DataSource.Local.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceCache", "name": "NAME", "url": "DataSourceCache.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceTextSchema", "name": "NAME", "url": "DataSourceTextSchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceArraySchema", "name": "NS", "url": "DataSourceArraySchema.html#property_NS", "type": "property"}, {"access": "", "host": "DataSourceXMLSchema", "name": "NS", "url": "DataSourceXMLSchema.html#property_NS", "type": "property"}, {"access": "", "host": "DataSourceJSONSchema", "name": "NS", "url": "DataSourceJSONSchema.html#property_NS", "type": "property"}, {"access": "", "host": "DataSourceCache", "name": "NS", "url": "DataSourceCache.html#property_NS", "type": "property"}, {"access": "", "host": "DataSourceTextSchema", "name": "NS", "url": "DataSourceTextSchema.html#property_NS", "type": "property"}, {"access": "private", "host": "DataSource.IO", "name": "_queue", "url": "DataSource.IO.html#property__queue", "type": "property"}, {"access": "", "host": "DataSource.Local", "name": "request", "url": "DataSource.Local.html#event_request", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "response", "url": "DataSource.Local.html#event_response", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "scriptCallbackParam", "url": "DataSource.Get.html#config_scriptCallbackParam", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "scriptCallbackParamChange", "url": "DataSource.Get.html#event_scriptCallbackParamChange", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "sendRequest", "url": "DataSource.Local.html#method_sendRequest", "type": "method"}, {"access": "", "host": "Pollable", "name": "setInterval", "url": "Pollable.html#method_setInterval", "type": "method"}, {"access": "", "host": "DataSource.Function", "name": "source", "url": "DataSource.Function.html#config_source", "type": "config"}, {"access": "", "host": "DataSource.Local", "name": "source", "url": "DataSource.Local.html#config_source", "type": "config"}, {"access": "", "host": "DataSource.Function", "name": "sourceChange", "url": "DataSource.Function.html#event_sourceChange", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "sourceChange", "url": "DataSource.Local.html#event_sourceChange", "type": "event"}, {"access": "private", "host": "DataSource.Get", "name": "_tId", "url": "DataSource.Get.html#property__tId", "type": "property"}];
</script>
</body>
</html>