|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: dataschema dataschema-base.js (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>dataschema <span class="subtitle">3.0.0</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_dataschema.html" title="dataschema">dataschema</a> |
|
|
22 |
|
|
|
23 |
> dataschema-base.js (source view) |
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
<div id="srcout"> |
|
|
47 |
<style> |
|
|
48 |
#doc3 .classopts { display:none; } |
|
|
49 |
</style> |
|
|
50 |
<div class="highlight" ><pre><span class="c">/**</span> |
|
|
51 |
<span class="c"> * The DataSchema utility provides a common configurable interface for widgets to</span> |
|
|
52 |
<span class="c"> * apply a given schema to a variety of data.</span> |
|
|
53 |
<span class="c"> *</span> |
|
|
54 |
<span class="c"> * @module dataschema</span> |
|
|
55 |
<span class="c"> */</span> |
|
|
56 |
|
|
|
57 |
<span class="c">/**</span> |
|
|
58 |
<span class="c"> * Provides the base DataSchema implementation, which can be extended to </span> |
|
|
59 |
<span class="c"> * create DataSchemas for specific data formats, such XML, JSON, text and</span> |
|
|
60 |
<span class="c"> * arrays.</span> |
|
|
61 |
<span class="c"> *</span> |
|
|
62 |
<span class="c"> * @module dataschema</span> |
|
|
63 |
<span class="c"> * @submodule dataschema-base</span> |
|
|
64 |
<span class="c"> */</span> |
|
|
65 |
|
|
|
66 |
<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> |
|
|
67 |
<span class="c">/**</span> |
|
|
68 |
<span class="c"> * Base class for the YUI DataSchema Utility.</span> |
|
|
69 |
<span class="c"> * @class DataSchema.Base</span> |
|
|
70 |
<span class="c"> * @static</span> |
|
|
71 |
<span class="c"> */</span> |
|
|
72 |
<span class="nx">SchemaBase</span> <span class="o">=</span> <span class="o">{</span> |
|
|
73 |
<span class="c">/**</span> |
|
|
74 |
<span class="c"> * Overridable method returns data as-is.</span> |
|
|
75 |
<span class="c"> *</span> |
|
|
76 |
<span class="c"> * @method apply</span> |
|
|
77 |
<span class="c"> * @param schema {Object} Schema to apply.</span> |
|
|
78 |
<span class="c"> * @param data {Object} Data.</span> |
|
|
79 |
<span class="c"> * @return {Object} Schema-parsed data.</span> |
|
|
80 |
<span class="c"> * @static</span> |
|
|
81 |
<span class="c"> */</span> |
|
|
82 |
<span class="nx">apply</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">schema</span><span class="o">,</span> <span class="nx">data</span><span class="o">)</span> <span class="o">{</span> |
|
|
83 |
<span class="k">return</span> <span class="nx">data</span><span class="o">;</span> |
|
|
84 |
<span class="o">},</span> |
|
|
85 |
|
|
|
86 |
<span class="c">/**</span> |
|
|
87 |
<span class="c"> * Applies field parser, if defined</span> |
|
|
88 |
<span class="c"> *</span> |
|
|
89 |
<span class="c"> * @method parse</span> |
|
|
90 |
<span class="c"> * @param value {Object} Original value.</span> |
|
|
91 |
<span class="c"> * @param field {Object} Field.</span> |
|
|
92 |
<span class="c"> * @return {Object} Type-converted value.</span> |
|
|
93 |
<span class="c"> */</span> |
|
|
94 |
<span class="nx">parse</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">value</span><span class="o">,</span> <span class="nx">field</span><span class="o">)</span> <span class="o">{</span> |
|
|
95 |
<span class="k">if</span><span class="o">(</span><span class="nx">field</span><span class="o">.</span><span class="nx">parser</span><span class="o">)</span> <span class="o">{</span> |
|
|
96 |
<span class="k">var</span> <span class="nx">parser</span> <span class="o">=</span> <span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">field</span><span class="o">.</span><span class="nx">parser</span><span class="o">))</span> <span class="o">?</span> |
|
|
97 |
<span class="nx">field</span><span class="o">.</span><span class="nx">parser</span> <span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Parsers</span><span class="o">[</span><span class="nx">field</span><span class="o">.</span><span class="nx">parser</span><span class="o">+</span><span class="s1">''</span><span class="o">];</span> |
|
|
98 |
<span class="k">if</span><span class="o">(</span><span class="nx">parser</span><span class="o">)</span> <span class="o">{</span> |
|
|
99 |
<span class="nx">value</span> <span class="o">=</span> <span class="nx">parser</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">value</span><span class="o">);</span> |
|
|
100 |
<span class="o">}</span> |
|
|
101 |
<span class="k">else</span> <span class="o">{</span> |
|
|
102 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Could not find parser for field "</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">field</span><span class="o">),</span> <span class="s2">"warn"</span><span class="o">,</span> <span class="s2">"dataschema-json"</span><span class="o">);</span> |
|
|
103 |
<span class="o">}</span> |
|
|
104 |
<span class="o">}</span> |
|
|
105 |
<span class="k">return</span> <span class="nx">value</span><span class="o">;</span> |
|
|
106 |
<span class="o">}</span> |
|
|
107 |
<span class="o">};</span> |
|
|
108 |
|
|
|
109 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">namespace</span><span class="o">(</span><span class="s2">"DataSchema"</span><span class="o">).</span><span class="nx">Base</span> <span class="o">=</span> <span class="nx">SchemaBase</span><span class="o">;</span> |
|
|
110 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">namespace</span><span class="o">(</span><span class="s2">"Parsers"</span><span class="o">);</span> |
|
|
111 |
</pre></div> |
|
|
112 |
|
|
|
113 |
</div> |
|
|
114 |
</div> |
|
|
115 |
</div> |
|
|
116 |
<div class="yui-b"> |
|
|
117 |
<div class="nav"> |
|
|
118 |
|
|
|
119 |
<div id="moduleList" class="module"> |
|
|
120 |
<h4>Modules</h4> |
|
|
121 |
<ul class="content"> |
|
|
122 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
123 |
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
|
124 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
125 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
126 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
127 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
128 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
129 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
130 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
131 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
132 |
<li class="selected"><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
133 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
134 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
135 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
136 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
137 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
138 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
139 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
140 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
141 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
142 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
143 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
144 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
145 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
146 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
147 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
148 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
149 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
150 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
151 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
152 |
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
|
153 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
154 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
155 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
156 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
157 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
158 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
159 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
160 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
161 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
162 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
163 |
</ul> |
|
|
164 |
</div> |
|
|
165 |
|
|
|
166 |
<div id="classList" class="module"> |
|
|
167 |
<h4>Classes</h4> |
|
|
168 |
<ul class="content"> |
|
|
169 |
<li class=""><a href="DataSchema.Array.html" title="DataSchema.Array">DataSchema.Array</a></li> |
|
|
170 |
<li class=""><a href="DataSchema.Base.html" title="DataSchema.Base">DataSchema.Base</a></li> |
|
|
171 |
<li class=""><a href="DataSchema.JSON.html" title="DataSchema.JSON">DataSchema.JSON</a></li> |
|
|
172 |
<li class=""><a href="DataSchema.Text.html" title="DataSchema.Text">DataSchema.Text</a></li> |
|
|
173 |
<li class=""><a href="DataSchema.XML.html" title="DataSchema.XML">DataSchema.XML</a></li> |
|
|
174 |
</ul> |
|
|
175 |
</div> |
|
|
176 |
|
|
|
177 |
<div id="fileList" class="module"> |
|
|
178 |
<h4>Files</h4> |
|
|
179 |
<ul class="content"> |
|
|
180 |
<li class=""><a href="dataschema-array.js.html" title="dataschema-array.js">dataschema-array.js</a></li> |
|
|
181 |
<li class="selected"><a href="dataschema-base.js.html" title="dataschema-base.js">dataschema-base.js</a></li> |
|
|
182 |
<li class=""><a href="dataschema-json.js.html" title="dataschema-json.js">dataschema-json.js</a></li> |
|
|
183 |
<li class=""><a href="dataschema-text.js.html" title="dataschema-text.js">dataschema-text.js</a></li> |
|
|
184 |
<li class=""><a href="dataschema-xml.js.html" title="dataschema-xml.js">dataschema-xml.js</a></li> |
|
|
185 |
</ul> |
|
|
186 |
</div> |
|
|
187 |
|
|
|
188 |
|
|
|
189 |
|
|
|
190 |
|
|
|
191 |
|
|
|
192 |
</div> |
|
|
193 |
</div> |
|
|
194 |
</div> |
|
|
195 |
<div id="ft"> |
|
|
196 |
<hr /> |
|
|
197 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
198 |
</div> |
|
|
199 |
</div> |
|
|
200 |
<script type="text/javascript"> |
|
|
201 |
ALL_YUI_PROPS = [{"access": "", "host": "DataSchema.Text", "name": "apply", "url": "DataSchema.Text.html#method_apply", "type": "method"}, {"access": "", "host": "DataSchema.XML", "name": "apply", "url": "DataSchema.XML.html#method_apply", "type": "method"}, {"access": "", "host": "DataSchema.JSON", "name": "apply", "url": "DataSchema.JSON.html#method_apply", "type": "method"}, {"access": "", "host": "DataSchema.Base", "name": "apply", "url": "DataSchema.Base.html#method_apply", "type": "method"}, {"access": "", "host": "DataSchema.Array", "name": "apply", "url": "DataSchema.Array.html#method_apply", "type": "method"}, {"access": "", "host": "DataSchema.JSON", "name": "DataSchema.JSON.getLocationValue", "url": "DataSchema.JSON.html#method_DataSchema.JSON.getLocationValue", "type": "method"}, {"access": "", "host": "DataSchema.JSON", "name": "DataSchema.JSON.getPath", "url": "DataSchema.JSON.html#method_DataSchema.JSON.getPath", "type": "method"}, {"access": "protected", "host": "DataSchema.JSON", "name": "_getFieldValues", "url": "DataSchema.JSON.html#method__getFieldValues", "type": "method"}, {"access": "protected", "host": "DataSchema.XML", "name": "_getLocationValue", "url": "DataSchema.XML.html#method__getLocationValue", "type": "method"}, {"access": "", "host": "DataSchema.Base", "name": "parse", "url": "DataSchema.Base.html#method_parse", "type": "method"}, {"access": "protected", "host": "DataSchema.XML", "name": "_parseMeta", "url": "DataSchema.XML.html#method__parseMeta", "type": "method"}, {"access": "protected", "host": "DataSchema.JSON", "name": "_parseMeta", "url": "DataSchema.JSON.html#method__parseMeta", "type": "method"}, {"access": "protected", "host": "DataSchema.Text", "name": "_parseResults", "url": "DataSchema.Text.html#method__parseResults", "type": "method"}, {"access": "protected", "host": "DataSchema.XML", "name": "_parseResults", "url": "DataSchema.XML.html#method__parseResults", "type": "method"}, {"access": "protected", "host": "DataSchema.JSON", "name": "_parseResults", "url": "DataSchema.JSON.html#method__parseResults", "type": "method"}, {"access": "protected", "host": "DataSchema.Array", "name": "_parseResults", "url": "DataSchema.Array.html#method__parseResults", "type": "method"}]; |
|
|
202 |
</script> |
|
|
203 |
</body> |
|
|
204 |
</html> |