|
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 (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.0b1</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 > DataSchema.Base |
|
23 |
|
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 <h2> |
|
47 |
|
48 |
|
49 <code>static</code> |
|
50 |
|
51 Class <b property="yui:name">DataSchema.Base</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 </h2> |
|
56 <!-- class tree goes here --> |
|
57 |
|
58 <dl class="subclasses" rel="yui:subclasses"> |
|
59 <dt>Known Subclasses:</dt> |
|
60 <dd> |
|
61 <span rel="yui:subclass" resource="DataSchema.XML.html"> |
|
62 <a href="DataSchema.XML.html" property="yui:name" title="DataSchema.XML">DataSchema.XML</a> |
|
63 </span> |
|
64 <span rel="yui:subclass" resource="DataSchema.Array.html"> |
|
65 <a href="DataSchema.Array.html" property="yui:name" title="DataSchema.Array">DataSchema.Array</a> |
|
66 </span> |
|
67 <span rel="yui:subclass" resource="DataSchema.JSON.html"> |
|
68 <a href="DataSchema.JSON.html" property="yui:name" title="DataSchema.JSON">DataSchema.JSON</a> |
|
69 </span> |
|
70 <span rel="yui:subclass" resource="DataSchema.Text.html"> |
|
71 <a href="DataSchema.Text.html" property="yui:name" title="DataSchema.Text">DataSchema.Text</a> |
|
72 </span> |
|
73 </dd> |
|
74 </dl> |
|
75 |
|
76 |
|
77 |
|
78 <div class="summary description" property="yui:description"> |
|
79 Base class for the YUI DataSchema Utility. |
|
80 </div> |
|
81 |
|
82 |
|
83 <div rel="yui:properties" resource="#properties"> |
|
84 |
|
85 </div> |
|
86 |
|
87 <div rel="yui:methods" resource="#methods"> |
|
88 <div class="section method details"> |
|
89 <h3 id="methods">Methods</h3> |
|
90 <div class="content"> |
|
91 <div class="" rel="yui:method" resource="#method_apply"> |
|
92 <h4> |
|
93 <a name="method_apply">apply</a></h4> |
|
94 <div class="detail" > |
|
95 <code> |
|
96 |
|
97 static |
|
98 |
|
99 Object |
|
100 <strong property="yui:name">apply</strong> |
|
101 ( |
|
102 |
|
103 |
|
104 schema |
|
105 |
|
106 |
|
107 , |
|
108 data |
|
109 |
|
110 |
|
111 ) |
|
112 </code> |
|
113 |
|
114 <div class="description" property="yui:description"> |
|
115 Overridable method returns data as-is. |
|
116 </div> |
|
117 |
|
118 <div class="description"> |
|
119 |
|
120 <dl rel="yui:parameters"> |
|
121 <dt>Parameters:</dt> |
|
122 <dd rel="yui:parameter"> |
|
123 <code><span property="yui:name">schema</span> |
|
124 <<span property="yui:type">Object</span>> |
|
125 </code> |
|
126 <span property="yui:description"> Schema to apply.</span> |
|
127 </dd> |
|
128 <dd rel="yui:parameter"> |
|
129 <code><span property="yui:name">data</span> |
|
130 <<span property="yui:type">Object</span>> |
|
131 </code> |
|
132 <span property="yui:description"> Data.</span> |
|
133 </dd> |
|
134 </dl> |
|
135 |
|
136 <dl> |
|
137 <dt>Returns: |
|
138 <code property="yui:return"> |
|
139 Object |
|
140 </code></dt> |
|
141 <dd property="yui:returnInfo">Schema-parsed data.</dd> |
|
142 </dl> |
|
143 |
|
144 |
|
145 |
|
146 |
|
147 </div> |
|
148 |
|
149 </div> |
|
150 <hr /> |
|
151 </div> |
|
152 <div class="" rel="yui:method" resource="#method_parse"> |
|
153 <h4> |
|
154 <a name="method_parse">parse</a></h4> |
|
155 <div class="detail" > |
|
156 <code> |
|
157 |
|
158 |
|
159 |
|
160 Object |
|
161 <strong property="yui:name">parse</strong> |
|
162 ( |
|
163 |
|
164 |
|
165 value |
|
166 |
|
167 |
|
168 , |
|
169 field |
|
170 |
|
171 |
|
172 ) |
|
173 </code> |
|
174 |
|
175 <div class="description" property="yui:description"> |
|
176 Applies field parser, if defined |
|
177 </div> |
|
178 |
|
179 <div class="description"> |
|
180 |
|
181 <dl rel="yui:parameters"> |
|
182 <dt>Parameters:</dt> |
|
183 <dd rel="yui:parameter"> |
|
184 <code><span property="yui:name">value</span> |
|
185 <<span property="yui:type">Object</span>> |
|
186 </code> |
|
187 <span property="yui:description"> Original value.</span> |
|
188 </dd> |
|
189 <dd rel="yui:parameter"> |
|
190 <code><span property="yui:name">field</span> |
|
191 <<span property="yui:type">Object</span>> |
|
192 </code> |
|
193 <span property="yui:description"> Field.</span> |
|
194 </dd> |
|
195 </dl> |
|
196 |
|
197 <dl> |
|
198 <dt>Returns: |
|
199 <code property="yui:return"> |
|
200 Object |
|
201 </code></dt> |
|
202 <dd property="yui:returnInfo">Type-converted value.</dd> |
|
203 </dl> |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 </div> |
|
209 |
|
210 </div> |
|
211 <hr /> |
|
212 </div> |
|
213 </div> |
|
214 </div> |
|
215 |
|
216 </div> |
|
217 |
|
218 <div rel="yui:events" resource="#events"> |
|
219 |
|
220 |
|
221 </div> |
|
222 |
|
223 <div rel="yui:attributes" resource="#configattributes"> |
|
224 |
|
225 </div> |
|
226 |
|
227 </div> |
|
228 </div> |
|
229 <div class="yui-b"> |
|
230 <div class="nav"> |
|
231 |
|
232 <div id="moduleList" class="module"> |
|
233 <h4>Modules</h4> |
|
234 <ul class="content"> |
|
235 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
236 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
237 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
238 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
239 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
240 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
241 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
242 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
243 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
244 <li class="selected"><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
245 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
246 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
247 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
248 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
249 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
250 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
251 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
252 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
253 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
254 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
255 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
256 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
257 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
258 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
259 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
260 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
261 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
262 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
263 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
264 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
265 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
266 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
267 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
268 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
269 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
270 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
271 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
272 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
273 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
274 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
275 </ul> |
|
276 </div> |
|
277 |
|
278 <div id="classList" class="module"> |
|
279 <h4>Classes</h4> |
|
280 <ul class="content"> |
|
281 <li class=""><a href="DataSchema.Array.html" title="DataSchema.Array">DataSchema.Array</a></li> |
|
282 <li class="selected"><a href="DataSchema.Base.html" title="DataSchema.Base">DataSchema.Base</a></li> |
|
283 <li class=""><a href="DataSchema.JSON.html" title="DataSchema.JSON">DataSchema.JSON</a></li> |
|
284 <li class=""><a href="DataSchema.Text.html" title="DataSchema.Text">DataSchema.Text</a></li> |
|
285 <li class=""><a href="DataSchema.XML.html" title="DataSchema.XML">DataSchema.XML</a></li> |
|
286 </ul> |
|
287 </div> |
|
288 |
|
289 <div id="fileList" class="module"> |
|
290 <h4>Files</h4> |
|
291 <ul class="content"> |
|
292 <li class=""><a href="dataschema-array.js.html" title="dataschema-array.js">dataschema-array.js</a></li> |
|
293 <li class=""><a href="dataschema-base.js.html" title="dataschema-base.js">dataschema-base.js</a></li> |
|
294 <li class=""><a href="dataschema-json.js.html" title="dataschema-json.js">dataschema-json.js</a></li> |
|
295 <li class=""><a href="dataschema-text.js.html" title="dataschema-text.js">dataschema-text.js</a></li> |
|
296 <li class=""><a href="dataschema-xml.js.html" title="dataschema-xml.js">dataschema-xml.js</a></li> |
|
297 </ul> |
|
298 </div> |
|
299 |
|
300 |
|
301 <div id="methodsList" class="module"> |
|
302 <h4>Methods</h4> |
|
303 <ul class="content"> |
|
304 <li class=""><a href="#method_apply" title="apply">apply</a></li> |
|
305 <li class=""><a href="#method_parse" title="parse">parse</a></li> |
|
306 </ul> |
|
307 </div> |
|
308 |
|
309 |
|
310 |
|
311 </div> |
|
312 </div> |
|
313 </div> |
|
314 <div id="ft"> |
|
315 <hr /> |
|
316 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
317 </div> |
|
318 </div> |
|
319 <script type="text/javascript"> |
|
320 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.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"}]; |
|
321 </script> |
|
322 </body> |
|
323 </html> |