|
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-json.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.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 |
|
23 > dataschema-json.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"> * Provides a DataSchema implementation which can be used to work with JSON data.</span> |
|
52 <span class="c"> *</span> |
|
53 <span class="c"> * @module dataschema</span> |
|
54 <span class="c"> * @submodule dataschema-json</span> |
|
55 <span class="c"> */</span> |
|
56 |
|
57 <span class="c">/**</span> |
|
58 <span class="c"> * JSON subclass for the DataSchema Utility.</span> |
|
59 <span class="c"> * @class DataSchema.JSON</span> |
|
60 <span class="c"> * @extends DataSchema.Base</span> |
|
61 <span class="c"> * @static</span> |
|
62 <span class="c"> */</span> |
|
63 <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> |
|
64 |
|
65 <span class="nx">SchemaJSON</span> <span class="o">=</span> <span class="o">{</span> |
|
66 |
|
67 <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
68 <span class="c"></span> <span class="c">//</span> |
|
69 <span class="c"></span> <span class="c">// DataSchema.JSON static methods</span> |
|
70 <span class="c"></span> <span class="c">//</span> |
|
71 <span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
72 <span class="c"></span> <span class="c">/**</span> |
|
73 <span class="c"> * Utility function converts JSON locator strings into walkable paths</span> |
|
74 <span class="c"> *</span> |
|
75 <span class="c"> * @method DataSchema.JSON.getPath</span> |
|
76 <span class="c"> * @param locator {String} JSON value locator.</span> |
|
77 <span class="c"> * @return {String[]} Walkable path to data value.</span> |
|
78 <span class="c"> * @static</span> |
|
79 <span class="c"> */</span> |
|
80 <span class="nx">getPath</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">locator</span><span class="o">)</span> <span class="o">{</span> |
|
81 <span class="k">var</span> <span class="nx">path</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span> |
|
82 <span class="nx">keys</span> <span class="o">=</span> <span class="o">[],</span> |
|
83 <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> |
|
84 |
|
85 <span class="k">if</span> <span class="o">(</span><span class="nx">locator</span><span class="o">)</span> <span class="o">{</span> |
|
86 <span class="c">// Strip the ["string keys"] and [1] array indexes</span> |
|
87 <span class="c"></span> <span class="nx">locator</span> <span class="o">=</span> <span class="nx">locator</span><span class="o">.</span> |
|
88 <span class="nx">replace</span><span class="o">(</span><span class="sr">/\[(['"])(.*?)\1\]/g</span><span class="o">,</span> |
|
89 <span class="k">function</span> <span class="o">(</span><span class="nx">x</span><span class="o">,</span><span class="nx">$1</span><span class="o">,</span><span class="nx">$2</span><span class="o">)</span> <span class="o">{</span><span class="nx">keys</span><span class="o">[</span><span class="nx">i</span><span class="o">]=</span><span class="nx">$2</span><span class="o">;</span><span class="k">return</span> <span class="s1">'.@'</span><span class="o">+(</span><span class="nx">i</span><span class="o">++);}).</span> |
|
90 <span class="nx">replace</span><span class="o">(</span><span class="sr">/\[(\d+)\]/g</span><span class="o">,</span> |
|
91 <span class="k">function</span> <span class="o">(</span><span class="nx">x</span><span class="o">,</span><span class="nx">$1</span><span class="o">)</span> <span class="o">{</span><span class="nx">keys</span><span class="o">[</span><span class="nx">i</span><span class="o">]=</span><span class="nb">parseInt</span><span class="o">(</span><span class="nx">$1</span><span class="o">,</span><span class="m">10</span><span class="o">)|</span><span class="m">0</span><span class="o">;</span><span class="k">return</span> <span class="s1">'.@'</span><span class="o">+(</span><span class="nx">i</span><span class="o">++);}).</span> |
|
92 <span class="nx">replace</span><span class="o">(</span><span class="sr">/^\./</span><span class="o">,</span><span class="s1">''</span><span class="o">);</span> <span class="c">// remove leading dot</span> |
|
93 <span class="c"></span> |
|
94 <span class="c">// Validate against problematic characters.</span> |
|
95 <span class="c"></span> <span class="k">if</span> <span class="o">(!</span><span class="sr">/[^\w\.\$@]/</span><span class="o">.</span><span class="nx">test</span><span class="o">(</span><span class="nx">locator</span><span class="o">))</span> <span class="o">{</span> |
|
96 <span class="nx">path</span> <span class="o">=</span> <span class="nx">locator</span><span class="o">.</span><span class="nx">split</span><span class="o">(</span><span class="s1">'.'</span><span class="o">);</span> |
|
97 <span class="k">for</span> <span class="o">(</span><span class="nx">i</span><span class="o">=</span><span class="nx">path</span><span class="o">.</span><span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> <span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">i</span><span class="o">)</span> <span class="o">{</span> |
|
98 <span class="k">if</span> <span class="o">(</span><span class="nx">path</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">charAt</span><span class="o">(</span><span class="m">0</span><span class="o">)</span> <span class="o">===</span> <span class="s1">'@'</span><span class="o">)</span> <span class="o">{</span> |
|
99 <span class="nx">path</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">=</span> <span class="nx">keys</span><span class="o">[</span><span class="nb">parseInt</span><span class="o">(</span><span class="nx">path</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">substr</span><span class="o">(</span><span class="m">1</span><span class="o">),</span><span class="m">10</span><span class="o">)];</span> |
|
100 <span class="o">}</span> |
|
101 <span class="o">}</span> |
|
102 <span class="o">}</span> |
|
103 <span class="k">else</span> <span class="o">{</span> |
|
104 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Invalid locator: "</span> <span class="o">+</span> <span class="nx">locator</span><span class="o">,</span> <span class="s2">"error"</span><span class="o">,</span> <span class="s2">"dataschema-json"</span><span class="o">);</span> |
|
105 <span class="o">}</span> |
|
106 <span class="o">}</span> |
|
107 <span class="k">return</span> <span class="nx">path</span><span class="o">;</span> |
|
108 <span class="o">},</span> |
|
109 |
|
110 <span class="c">/**</span> |
|
111 <span class="c"> * Utility function to walk a path and return the value located there.</span> |
|
112 <span class="c"> *</span> |
|
113 <span class="c"> * @method DataSchema.JSON.getLocationValue</span> |
|
114 <span class="c"> * @param path {String[]} Locator path.</span> |
|
115 <span class="c"> * @param data {String} Data to traverse.</span> |
|
116 <span class="c"> * @return {Object} Data value at location.</span> |
|
117 <span class="c"> * @static</span> |
|
118 <span class="c"> */</span> |
|
119 <span class="nx">getLocationValue</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">path</span><span class="o">,</span> <span class="nx">data</span><span class="o">)</span> <span class="o">{</span> |
|
120 <span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> |
|
121 <span class="nx">len</span> <span class="o">=</span> <span class="nx">path</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
122 <span class="k">for</span> <span class="o">(;</span><span class="nx">i</span><span class="o"><</span><span class="nx">len</span><span class="o">;</span><span class="nx">i</span><span class="o">++)</span> <span class="o">{</span> |
|
123 <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="nx">path</span><span class="o">[</span><span class="nx">i</span><span class="o">]]))</span> <span class="o">{</span> |
|
124 <span class="nx">data</span> <span class="o">=</span> <span class="nx">data</span><span class="o">[</span><span class="nx">path</span><span class="o">[</span><span class="nx">i</span><span class="o">]];</span> |
|
125 <span class="o">}</span> |
|
126 <span class="k">else</span> <span class="o">{</span> |
|
127 <span class="nx">data</span> <span class="o">=</span> <span class="kc">undefined</span><span class="o">;</span> |
|
128 <span class="k">break</span><span class="o">;</span> |
|
129 <span class="o">}</span> |
|
130 <span class="o">}</span> |
|
131 <span class="k">return</span> <span class="nx">data</span><span class="o">;</span> |
|
132 <span class="o">},</span> |
|
133 |
|
134 <span class="c">/**</span> |
|
135 <span class="c"> * Applies a given schema to given JSON data.</span> |
|
136 <span class="c"> *</span> |
|
137 <span class="c"> * @method apply</span> |
|
138 <span class="c"> * @param schema {Object} Schema to apply.</span> |
|
139 <span class="c"> * @param data {Object} JSON data.</span> |
|
140 <span class="c"> * @return {Object} Schema-parsed data.</span> |
|
141 <span class="c"> * @static</span> |
|
142 <span class="c"> */</span> |
|
143 <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> |
|
144 <span class="k">var</span> <span class="nx">data_in</span> <span class="o">=</span> <span class="nx">data</span><span class="o">,</span> |
|
145 <span class="nx">data_out</span> <span class="o">=</span> <span class="o">{</span><span class="nx">results</span><span class="o">:[],</span><span class="nx">meta</span><span class="o">:{}};</span> |
|
146 |
|
147 <span class="c">// Convert incoming JSON strings</span> |
|
148 <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">isObject</span><span class="o">(</span><span class="nx">data</span><span class="o">))</span> <span class="o">{</span> |
|
149 <span class="k">try</span> <span class="o">{</span> |
|
150 <span class="nx">data_in</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span><span class="o">.</span><span class="nx">parse</span><span class="o">(</span><span class="nx">data</span><span class="o">);</span> |
|
151 <span class="o">}</span> |
|
152 <span class="k">catch</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
153 <span class="nx">data_out</span><span class="o">.</span><span class="nx">error</span> <span class="o">=</span> <span class="nx">e</span><span class="o">;</span> |
|
154 <span class="k">return</span> <span class="nx">data_out</span><span class="o">;</span> |
|
155 <span class="o">}</span> |
|
156 <span class="o">}</span> |
|
157 |
|
158 <span class="k">if</span><span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">data_in</span><span class="o">)</span> <span class="o">&&</span> <span class="nx">schema</span><span class="o">)</span> <span class="o">{</span> |
|
159 <span class="c">// Parse results data</span> |
|
160 <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">schema</span><span class="o">.</span><span class="nx">resultListLocator</span><span class="o">))</span> <span class="o">{</span> |
|
161 <span class="nx">data_out</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">_parseResults</span><span class="o">(</span><span class="nx">schema</span><span class="o">,</span> <span class="nx">data_in</span><span class="o">,</span> <span class="nx">data_out</span><span class="o">);</span> |
|
162 <span class="o">}</span> |
|
163 |
|
164 <span class="c">// Parse meta data</span> |
|
165 <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">schema</span><span class="o">.</span><span class="nx">metaFields</span><span class="o">))</span> <span class="o">{</span> |
|
166 <span class="nx">data_out</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">_parseMeta</span><span class="o">(</span><span class="nx">schema</span><span class="o">.</span><span class="nx">metaFields</span><span class="o">,</span> <span class="nx">data_in</span><span class="o">,</span> <span class="nx">data_out</span><span class="o">);</span> |
|
167 <span class="o">}</span> |
|
168 <span class="o">}</span> |
|
169 <span class="k">else</span> <span class="o">{</span> |
|
170 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"JSON data could not be schema-parsed: "</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">data</span><span class="o">)</span> <span class="o">+</span> <span class="s2">" "</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">data</span><span class="o">),</span> <span class="s2">"error"</span><span class="o">,</span> <span class="s2">"dataschema-json"</span><span class="o">);</span> |
|
171 <span class="nx">data_out</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">"JSON schema parse failure"</span><span class="o">);</span> |
|
172 <span class="o">}</span> |
|
173 |
|
174 <span class="k">return</span> <span class="nx">data_out</span><span class="o">;</span> |
|
175 <span class="o">},</span> |
|
176 |
|
177 <span class="c">/**</span> |
|
178 <span class="c"> * Schema-parsed list of results from full data</span> |
|
179 <span class="c"> *</span> |
|
180 <span class="c"> * @method _parseResults</span> |
|
181 <span class="c"> * @param schema {Object} Schema to parse against.</span> |
|
182 <span class="c"> * @param json_in {Object} JSON to parse.</span> |
|
183 <span class="c"> * @param data_out {Object} In-progress parsed data to update.</span> |
|
184 <span class="c"> * @return {Object} Parsed data object.</span> |
|
185 <span class="c"> * @static</span> |
|
186 <span class="c"> * @protected</span> |
|
187 <span class="c"> */</span> |
|
188 <span class="nx">_parseResults</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">json_in</span><span class="o">,</span> <span class="nx">data_out</span><span class="o">)</span> <span class="o">{</span> |
|
189 <span class="k">var</span> <span class="nx">results</span> <span class="o">=</span> <span class="o">[],</span> |
|
190 <span class="nx">path</span><span class="o">,</span> |
|
191 <span class="nx">error</span><span class="o">;</span> |
|
192 |
|
193 <span class="k">if</span><span class="o">(</span><span class="nx">schema</span><span class="o">.</span><span class="nx">resultListLocator</span><span class="o">)</span> <span class="o">{</span> |
|
194 <span class="nx">path</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">getPath</span><span class="o">(</span><span class="nx">schema</span><span class="o">.</span><span class="nx">resultListLocator</span><span class="o">);</span> |
|
195 <span class="k">if</span><span class="o">(</span><span class="nx">path</span><span class="o">)</span> <span class="o">{</span> |
|
196 <span class="nx">results</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">getLocationValue</span><span class="o">(</span><span class="nx">path</span><span class="o">,</span> <span class="nx">json_in</span><span class="o">);</span> |
|
197 <span class="k">if</span> <span class="o">(</span><span class="nx">results</span> <span class="o">===</span> <span class="kc">undefined</span><span class="o">)</span> <span class="o">{</span> |
|
198 <span class="nx">data_out</span><span class="o">.</span><span class="nx">results</span> <span class="o">=</span> <span class="o">[];</span> |
|
199 <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">"JSON results retrieval failure"</span><span class="o">);</span> |
|
200 <span class="o">}</span> |
|
201 <span class="k">else</span> <span class="o">{</span> |
|
202 <span class="k">if</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">schema</span><span class="o">.</span><span class="nx">resultFields</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">results</span><span class="o">))</span> <span class="o">{</span> |
|
203 <span class="nx">data_out</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">_getFieldValues</span><span class="o">(</span><span class="nx">schema</span><span class="o">.</span><span class="nx">resultFields</span><span class="o">,</span> <span class="nx">results</span><span class="o">,</span> <span class="nx">data_out</span><span class="o">);</span> |
|
204 <span class="o">}</span> |
|
205 <span class="k">else</span> <span class="o">{</span> |
|
206 <span class="nx">data_out</span><span class="o">.</span><span class="nx">results</span> <span class="o">=</span> <span class="o">[];</span> |
|
207 <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">"JSON Schema fields retrieval failure"</span><span class="o">);</span> |
|
208 <span class="o">}</span> |
|
209 <span class="o">}</span> |
|
210 <span class="o">}</span> |
|
211 <span class="k">else</span> <span class="o">{</span> |
|
212 <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">"JSON Schema results locator failure"</span><span class="o">);</span> |
|
213 <span class="o">}</span> |
|
214 |
|
215 <span class="k">if</span> <span class="o">(</span><span class="nx">error</span><span class="o">)</span> <span class="o">{</span> |
|
216 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"JSON data could not be parsed: "</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">json_in</span><span class="o">),</span> <span class="s2">"error"</span><span class="o">,</span> <span class="s2">"dataschema-json"</span><span class="o">);</span> |
|
217 <span class="nx">data_out</span><span class="o">.</span><span class="nx">error</span> <span class="o">=</span> <span class="nx">error</span><span class="o">;</span> |
|
218 <span class="o">}</span> |
|
219 |
|
220 <span class="o">}</span> |
|
221 <span class="k">return</span> <span class="nx">data_out</span><span class="o">;</span> |
|
222 <span class="o">},</span> |
|
223 |
|
224 <span class="c">/**</span> |
|
225 <span class="c"> * Get field data values out of list of full results</span> |
|
226 <span class="c"> *</span> |
|
227 <span class="c"> * @method _getFieldValues</span> |
|
228 <span class="c"> * @param fields {Array} Fields to find.</span> |
|
229 <span class="c"> * @param array_in {Array} Results to parse.</span> |
|
230 <span class="c"> * @param data_out {Object} In-progress parsed data to update.</span> |
|
231 <span class="c"> * @return {Object} Parsed data object.</span> |
|
232 <span class="c"> * @static</span> |
|
233 <span class="c"> * @protected</span> |
|
234 <span class="c"> */</span> |
|
235 <span class="nx">_getFieldValues</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">fields</span><span class="o">,</span> <span class="nx">array_in</span><span class="o">,</span> <span class="nx">data_out</span><span class="o">)</span> <span class="o">{</span> |
|
236 <span class="k">var</span> <span class="nx">results</span> <span class="o">=</span> <span class="o">[],</span> |
|
237 <span class="nx">len</span> <span class="o">=</span> <span class="nx">fields</span><span class="o">.</span><span class="nx">length</span><span class="o">,</span> |
|
238 <span class="nx">i</span><span class="o">,</span> <span class="nx">j</span><span class="o">,</span> |
|
239 <span class="nx">field</span><span class="o">,</span> <span class="nx">key</span><span class="o">,</span> <span class="nx">path</span><span class="o">,</span> <span class="nx">parser</span><span class="o">,</span> |
|
240 <span class="nx">simplePaths</span> <span class="o">=</span> <span class="o">[],</span> <span class="nx">complexPaths</span> <span class="o">=</span> <span class="o">[],</span> <span class="nx">fieldParsers</span> <span class="o">=</span> <span class="o">[],</span> |
|
241 <span class="nx">result</span><span class="o">,</span> <span class="nx">record</span><span class="o">;</span> |
|
242 |
|
243 <span class="c">// First collect hashes of simple paths, complex paths, and parsers</span> |
|
244 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span><span class="o">=</span><span class="m">0</span><span class="o">;</span> <span class="nx">i</span><span class="o"><</span><span class="nx">len</span><span class="o">;</span> <span class="nx">i</span><span class="o">++)</span> <span class="o">{</span> |
|
245 <span class="nx">field</span> <span class="o">=</span> <span class="nx">fields</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> <span class="c">// A field can be a simple string or a hash</span> |
|
246 <span class="c"></span> <span class="nx">key</span> <span class="o">=</span> <span class="nx">field</span><span class="o">.</span><span class="nx">key</span> <span class="o">||</span> <span class="nx">field</span><span class="o">;</span> <span class="c">// Find the key</span> |
|
247 <span class="c"></span> |
|
248 <span class="c">// Validate and store locators for later</span> |
|
249 <span class="c"></span> <span class="nx">path</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">getPath</span><span class="o">(</span><span class="nx">key</span><span class="o">);</span> |
|
250 <span class="k">if</span> <span class="o">(</span><span class="nx">path</span><span class="o">)</span> <span class="o">{</span> |
|
251 <span class="k">if</span> <span class="o">(</span><span class="nx">path</span><span class="o">.</span><span class="nx">length</span> <span class="o">===</span> <span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
252 <span class="nx">simplePaths</span><span class="o">[</span><span class="nx">simplePaths</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="o">{</span><span class="nx">key</span><span class="o">:</span><span class="nx">key</span><span class="o">,</span> <span class="nx">path</span><span class="o">:</span><span class="nx">path</span><span class="o">[</span><span class="m">0</span><span class="o">]};</span> |
|
253 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
254 <span class="nx">complexPaths</span><span class="o">[</span><span class="nx">complexPaths</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="o">{</span><span class="nx">key</span><span class="o">:</span><span class="nx">key</span><span class="o">,</span> <span class="nx">path</span><span class="o">:</span><span class="nx">path</span><span class="o">};</span> |
|
255 <span class="o">}</span> |
|
256 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
257 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Invalid key syntax: "</span> <span class="o">+</span> <span class="nx">key</span><span class="o">,</span> <span class="s2">"warn"</span><span class="o">,</span> <span class="s2">"dataschema-json"</span><span class="o">);</span> |
|
258 <span class="o">}</span> |
|
259 |
|
260 <span class="c">// Validate and store parsers for later</span> |
|
261 <span class="c"></span> <span class="c">//TODO: use Y.DataSchema.parse?</span> |
|
262 <span class="c"></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> <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> |
|
263 <span class="k">if</span> <span class="o">(</span><span class="nx">parser</span><span class="o">)</span> <span class="o">{</span> |
|
264 <span class="nx">fieldParsers</span><span class="o">[</span><span class="nx">fieldParsers</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="o">{</span><span class="nx">key</span><span class="o">:</span><span class="nx">key</span><span class="o">,</span> <span class="nx">parser</span><span class="o">:</span><span class="nx">parser</span><span class="o">};</span> |
|
265 <span class="o">}</span> |
|
266 <span class="o">}</span> |
|
267 |
|
268 <span class="c">// Traverse list of array_in, creating records of simple fields,</span> |
|
269 <span class="c"></span> <span class="c">// complex fields, and applying parsers as necessary</span> |
|
270 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span><span class="o">=</span><span class="nx">array_in</span><span class="o">.</span><span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> <span class="nx">i</span><span class="o">>=</span><span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">i</span><span class="o">)</span> <span class="o">{</span> |
|
271 <span class="nx">record</span> <span class="o">=</span> <span class="o">{};</span> |
|
272 <span class="nx">result</span> <span class="o">=</span> <span class="nx">array_in</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
273 <span class="k">if</span><span class="o">(</span><span class="nx">result</span><span class="o">)</span> <span class="o">{</span> |
|
274 <span class="c">// Cycle through simpleLocators</span> |
|
275 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">j</span><span class="o">=</span><span class="nx">simplePaths</span><span class="o">.</span><span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> <span class="nx">j</span><span class="o">>=</span><span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">j</span><span class="o">)</span> <span class="o">{</span> |
|
276 <span class="c">// Bug 1777850: The result might be an array instead of object</span> |
|
277 <span class="c"></span> <span class="nx">record</span><span class="o">[</span><span class="nx">simplePaths</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">key</span><span class="o">]</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DataSchema</span><span class="o">.</span><span class="nx">Base</span><span class="o">.</span><span class="nx">parse</span><span class="o">(</span> |
|
278 <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">result</span><span class="o">[</span><span class="nx">simplePaths</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">path</span><span class="o">])</span> <span class="o">?</span> |
|
279 <span class="nx">result</span><span class="o">[</span><span class="nx">j</span><span class="o">]</span> <span class="o">:</span> <span class="nx">result</span><span class="o">[</span><span class="nx">simplePaths</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">path</span><span class="o">]),</span> <span class="nx">simplePaths</span><span class="o">[</span><span class="nx">j</span><span class="o">]);</span> |
|
280 <span class="o">}</span> |
|
281 |
|
282 <span class="c">// Cycle through complexLocators</span> |
|
283 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">j</span><span class="o">=</span><span class="nx">complexPaths</span><span class="o">.</span><span class="nx">length</span> <span class="o">-</span> <span class="m">1</span><span class="o">;</span> <span class="nx">j</span><span class="o">>=</span><span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">j</span><span class="o">)</span> <span class="o">{</span> |
|
284 <span class="nx">record</span><span class="o">[</span><span class="nx">complexPaths</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">key</span><span class="o">]</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DataSchema</span><span class="o">.</span><span class="nx">Base</span><span class="o">.</span><span class="nx">parse</span><span class="o">(</span> |
|
285 <span class="o">(</span><span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">getLocationValue</span><span class="o">(</span><span class="nx">complexPaths</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">path</span><span class="o">,</span> <span class="nx">result</span><span class="o">)),</span> <span class="nx">complexPaths</span><span class="o">[</span><span class="nx">j</span><span class="o">]</span> <span class="o">);</span> |
|
286 <span class="o">}</span> |
|
287 |
|
288 <span class="c">// Cycle through fieldParsers</span> |
|
289 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">j</span><span class="o">=</span><span class="nx">fieldParsers</span><span class="o">.</span><span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> <span class="nx">j</span><span class="o">>=</span><span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">j</span><span class="o">)</span> <span class="o">{</span> |
|
290 <span class="nx">key</span> <span class="o">=</span> <span class="nx">fieldParsers</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">key</span><span class="o">;</span> |
|
291 <span class="nx">record</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">=</span> <span class="nx">fieldParsers</span><span class="o">[</span><span class="nx">j</span><span class="o">].</span><span class="nx">parser</span><span class="o">(</span><span class="nx">record</span><span class="o">[</span><span class="nx">key</span><span class="o">]);</span> |
|
292 <span class="c">// Safety net</span> |
|
293 <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">record</span><span class="o">[</span><span class="nx">key</span><span class="o">]))</span> <span class="o">{</span> |
|
294 <span class="nx">record</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
295 <span class="o">}</span> |
|
296 <span class="o">}</span> |
|
297 <span class="nx">results</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">=</span> <span class="nx">record</span><span class="o">;</span> |
|
298 <span class="o">}</span> |
|
299 <span class="o">}</span> |
|
300 <span class="nx">data_out</span><span class="o">.</span><span class="nx">results</span> <span class="o">=</span> <span class="nx">results</span><span class="o">;</span> |
|
301 <span class="k">return</span> <span class="nx">data_out</span><span class="o">;</span> |
|
302 <span class="o">},</span> |
|
303 |
|
304 <span class="c">/**</span> |
|
305 <span class="c"> * Parses results data according to schema</span> |
|
306 <span class="c"> *</span> |
|
307 <span class="c"> * @method _parseMeta</span> |
|
308 <span class="c"> * @param metaFields {Object} Metafields definitions.</span> |
|
309 <span class="c"> * @param json_in {Object} JSON to parse.</span> |
|
310 <span class="c"> * @param data_out {Object} In-progress parsed data to update.</span> |
|
311 <span class="c"> * @return {Object} Schema-parsed meta data.</span> |
|
312 <span class="c"> * @static</span> |
|
313 <span class="c"> * @protected</span> |
|
314 <span class="c"> */</span> |
|
315 <span class="nx">_parseMeta</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">metaFields</span><span class="o">,</span> <span class="nx">json_in</span><span class="o">,</span> <span class="nx">data_out</span><span class="o">)</span> <span class="o">{</span> |
|
316 <span class="k">if</span><span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">metaFields</span><span class="o">))</span> <span class="o">{</span> |
|
317 <span class="k">var</span> <span class="nx">key</span><span class="o">,</span> <span class="nx">path</span><span class="o">;</span> |
|
318 <span class="k">for</span><span class="o">(</span><span class="nx">key</span> <span class="k">in</span> <span class="nx">metaFields</span><span class="o">)</span> <span class="o">{</span> |
|
319 <span class="k">if</span> <span class="o">(</span><span class="nx">metaFields</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">key</span><span class="o">))</span> <span class="o">{</span> |
|
320 <span class="nx">path</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">getPath</span><span class="o">(</span><span class="nx">metaFields</span><span class="o">[</span><span class="nx">key</span><span class="o">]);</span> |
|
321 <span class="k">if</span> <span class="o">(</span><span class="nx">path</span> <span class="o">&&</span> <span class="nx">json_in</span><span class="o">)</span> <span class="o">{</span> |
|
322 <span class="nx">data_out</span><span class="o">.</span><span class="nx">meta</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">=</span> <span class="nx">SchemaJSON</span><span class="o">.</span><span class="nx">getLocationValue</span><span class="o">(</span><span class="nx">path</span><span class="o">,</span> <span class="nx">json_in</span><span class="o">);</span> |
|
323 <span class="o">}</span> |
|
324 <span class="o">}</span> |
|
325 <span class="o">}</span> |
|
326 <span class="o">}</span> |
|
327 <span class="k">else</span> <span class="o">{</span> |
|
328 <span class="nx">data_out</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">"JSON meta data retrieval failure"</span><span class="o">);</span> |
|
329 <span class="o">}</span> |
|
330 <span class="k">return</span> <span class="nx">data_out</span><span class="o">;</span> |
|
331 <span class="o">}</span> |
|
332 <span class="o">};</span> |
|
333 |
|
334 <span class="nx">Y</span><span class="o">.</span><span class="nx">DataSchema</span><span class="o">.</span><span class="nx">JSON</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">SchemaJSON</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DataSchema</span><span class="o">.</span><span class="nx">Base</span><span class="o">);</span> |
|
335 </pre></div> |
|
336 </div> |
|
337 </div> |
|
338 </div> |
|
339 <div class="yui-b"> |
|
340 <div class="nav"> |
|
341 |
|
342 <div id="moduleList" class="module"> |
|
343 <h4>Modules</h4> |
|
344 <ul class="content"> |
|
345 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
346 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
347 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
348 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
349 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
350 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
351 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
352 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
353 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
354 <li class="selected"><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
355 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
356 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
357 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
358 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
359 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
360 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
361 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
362 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
363 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
364 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
365 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
366 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
367 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
368 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
369 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
370 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
371 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
372 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
373 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
374 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
375 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
376 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
377 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
378 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
379 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
380 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
381 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
382 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
383 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
384 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
385 </ul> |
|
386 </div> |
|
387 |
|
388 <div id="classList" class="module"> |
|
389 <h4>Classes</h4> |
|
390 <ul class="content"> |
|
391 <li class=""><a href="DataSchema.Array.html" title="DataSchema.Array">DataSchema.Array</a></li> |
|
392 <li class=""><a href="DataSchema.Base.html" title="DataSchema.Base">DataSchema.Base</a></li> |
|
393 <li class=""><a href="DataSchema.JSON.html" title="DataSchema.JSON">DataSchema.JSON</a></li> |
|
394 <li class=""><a href="DataSchema.Text.html" title="DataSchema.Text">DataSchema.Text</a></li> |
|
395 <li class=""><a href="DataSchema.XML.html" title="DataSchema.XML">DataSchema.XML</a></li> |
|
396 </ul> |
|
397 </div> |
|
398 |
|
399 <div id="fileList" class="module"> |
|
400 <h4>Files</h4> |
|
401 <ul class="content"> |
|
402 <li class=""><a href="dataschema-array.js.html" title="dataschema-array.js">dataschema-array.js</a></li> |
|
403 <li class=""><a href="dataschema-base.js.html" title="dataschema-base.js">dataschema-base.js</a></li> |
|
404 <li class="selected"><a href="dataschema-json.js.html" title="dataschema-json.js">dataschema-json.js</a></li> |
|
405 <li class=""><a href="dataschema-text.js.html" title="dataschema-text.js">dataschema-text.js</a></li> |
|
406 <li class=""><a href="dataschema-xml.js.html" title="dataschema-xml.js">dataschema-xml.js</a></li> |
|
407 </ul> |
|
408 </div> |
|
409 |
|
410 |
|
411 |
|
412 |
|
413 |
|
414 </div> |
|
415 </div> |
|
416 </div> |
|
417 <div id="ft"> |
|
418 <hr /> |
|
419 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
420 </div> |
|
421 </div> |
|
422 <script type="text/javascript"> |
|
423 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"}]; |
|
424 </script> |
|
425 </body> |
|
426 </html> |