Newer
Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
*
* @method _onFormSubmit
* @param v {HTMLEvent} The submit event.
* @param oSelf {YAHOO.widget.AutoComplete} The AutoComplete instance.
* @private
*/
YAHOO.widget.AutoComplete.prototype._onFormSubmit = function(v,oSelf) {
if(oSelf.allowBrowserAutocomplete) {
oSelf._oTextbox.setAttribute("autocomplete","on");
}
else {
oSelf._oTextbox.setAttribute("autocomplete","off");
}
};
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/**
* The DataSource classes manages sending a request and returning response from a live
* database. Supported data include local JavaScript arrays and objects and databases
* accessible via XHR connections. Supported response formats include JavaScript arrays,
* JSON, XML, and flat-file textual data.
*
* @class DataSource
* @constructor
*/
YAHOO.widget.DataSource = function() {
/* abstract class */
};
/////////////////////////////////////////////////////////////////////////////
//
// Public constants
//
/////////////////////////////////////////////////////////////////////////////
/**
* Error message for null data responses.
*
* @property ERROR_DATANULL
* @type String
* @static
* @final
*/
YAHOO.widget.DataSource.ERROR_DATANULL = "Response data was null";
/**
* Error message for data responses with parsing errors.
*
* @property ERROR_DATAPARSE
* @type String
* @static
* @final
*/
YAHOO.widget.DataSource.ERROR_DATAPARSE = "Response data could not be parsed";
/////////////////////////////////////////////////////////////////////////////
//
// Public member variables
//
/////////////////////////////////////////////////////////////////////////////
/**
* Max size of the local cache. Set to 0 to turn off caching. Caching is
* useful to reduce the number of server connections. Recommended only for data
* sources that return comprehensive results for queries or when stale data is
* not an issue.
*
* @property maxCacheEntries
* @type Number
* @default 15
*/
YAHOO.widget.DataSource.prototype.maxCacheEntries = 15;
/**
* Use this to equate cache matching with the type of matching done by your live
* data source. If caching is on and queryMatchContains is true, the cache
* returns results that "contain" the query string. By default,
* queryMatchContains is set to false, meaning the cache only returns results
* that "start with" the query string.
*
* @property queryMatchContains
* @type Boolean
* @default false
*/
YAHOO.widget.DataSource.prototype.queryMatchContains = false;
/**
* Enables query subset matching. If caching is on and queryMatchSubset is
* true, substrings of queries will return matching cached results. For
* instance, if the first query is for "abc" susequent queries that start with
* "abc", like "abcd", will be queried against the cache, and not the live data
* source. Recommended only for DataSources that return comprehensive results
* for queries with very few characters.
*
* @property queryMatchSubset
* @type Boolean
* @default false
*
*/
YAHOO.widget.DataSource.prototype.queryMatchSubset = false;
/**
* Enables query case-sensitivity matching. If caching is on and
* queryMatchCase is true, queries will only return results for case-sensitive
* matches.
*
* @property queryMatchCase
* @type Boolean
* @default false
*/
YAHOO.widget.DataSource.prototype.queryMatchCase = false;
/////////////////////////////////////////////////////////////////////////////
//
// Public methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Public accessor to the unique name of the DataSource instance.
*
* @method toString
* @return {String} Unique name of the DataSource instance
*/
YAHOO.widget.DataSource.prototype.toString = function() {
return "DataSource " + this._sName;
};
/**
* Retrieves query results, first checking the local cache, then making the
* query request to the live data source as defined by the function doQuery.
*
* @method getResults
* @param oCallbackFn {HTMLFunction} Callback function defined by oParent object to which to return results.
* @param sQuery {String} Query string.
* @param oParent {Object} The object instance that has requested data.
*/
YAHOO.widget.DataSource.prototype.getResults = function(oCallbackFn, sQuery, oParent) {
// First look in cache
var aResults = this._doQueryCache(oCallbackFn,sQuery,oParent);
// Not in cache, so get results from server
if(aResults.length === 0) {
this.queryEvent.fire(this, oParent, sQuery);
this.doQuery(oCallbackFn, sQuery, oParent);
}
};
/**
* Abstract method implemented by subclasses to make a query to the live data
* source. Must call the callback function with the response returned from the
* query. Populates cache (if enabled).
*
* @method doQuery
* @param oCallbackFn {HTMLFunction} Callback function implemented by oParent to which to return results.
* @param sQuery {String} Query string.
* @param oParent {Object} The object instance that has requested data.
*/
YAHOO.widget.DataSource.prototype.doQuery = function(oCallbackFn, sQuery, oParent) {
/* override this */
};
/**
* Flushes cache.
*
* @method flushCache
*/
YAHOO.widget.DataSource.prototype.flushCache = function() {
if(this._aCache) {
this._aCache = [];
}
if(this._aCacheHelper) {
this._aCacheHelper = [];
}
this.cacheFlushEvent.fire(this);
};
/////////////////////////////////////////////////////////////////////////////
//
// Public events
//
/////////////////////////////////////////////////////////////////////////////
/**
* Fired when a query is made to the live data source.
*
* @event queryEvent
* @param oSelf {Object} The DataSource instance.
* @param oParent {Object} The requesting object.
* @param sQuery {String} The query string.
*/
YAHOO.widget.DataSource.prototype.queryEvent = null;
/**
* Fired when a query is made to the local cache.
*
* @event cacheQueryEvent
* @param oSelf {Object} The DataSource instance.
* @param oParent {Object} The requesting object.
* @param sQuery {String} The query string.
*/
YAHOO.widget.DataSource.prototype.cacheQueryEvent = null;
/**
* Fired when data is retrieved from the live data source.
*
* @event getResultsEvent
* @param oSelf {Object} The DataSource instance.
* @param oParent {Object} The requesting object.
* @param sQuery {String} The query string.
* @param aResults {Object[]} Array of result objects.
*/
YAHOO.widget.DataSource.prototype.getResultsEvent = null;
/**
* Fired when data is retrieved from the local cache.
*
* @event getCachedResultsEvent
* @param oSelf {Object} The DataSource instance.
* @param oParent {Object} The requesting object.
* @param sQuery {String} The query string.
* @param aResults {Object[]} Array of result objects.
*/
YAHOO.widget.DataSource.prototype.getCachedResultsEvent = null;
/**
* Fired when an error is encountered with the live data source.
*
* @event dataErrorEvent
* @param oSelf {Object} The DataSource instance.
* @param oParent {Object} The requesting object.
* @param sQuery {String} The query string.
* @param sMsg {String} Error message string
*/
YAHOO.widget.DataSource.prototype.dataErrorEvent = null;
/**
* Fired when the local cache is flushed.
*
* @event cacheFlushEvent
* @param oSelf {Object} The DataSource instance
*/
YAHOO.widget.DataSource.prototype.cacheFlushEvent = null;
/////////////////////////////////////////////////////////////////////////////
//
// Private member variables
//
/////////////////////////////////////////////////////////////////////////////
/**
* Internal class variable to index multiple DataSource instances.
*
* @property _nIndex
* @type Number
* @private
* @static
*/
YAHOO.widget.DataSource._nIndex = 0;
/**
* Name of DataSource instance.
*
* @property _sName
* @type String
* @private
*/
YAHOO.widget.DataSource.prototype._sName = null;
/**
* Local cache of data result objects indexed chronologically.
*
* @property _aCache
* @type Object[]
* @private
*/
YAHOO.widget.DataSource.prototype._aCache = null;
/////////////////////////////////////////////////////////////////////////////
//
// Private methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes DataSource instance.
*
* @method _init
* @private
*/
YAHOO.widget.DataSource.prototype._init = function() {
// Validate and initialize public configs
var maxCacheEntries = this.maxCacheEntries;
if(isNaN(maxCacheEntries) || (maxCacheEntries < 0)) {
maxCacheEntries = 0;
}
// Initialize local cache
if(maxCacheEntries > 0 && !this._aCache) {
this._aCache = [];
}
this._sName = "instance" + YAHOO.widget.DataSource._nIndex;
YAHOO.widget.DataSource._nIndex++;
this.queryEvent = new YAHOO.util.CustomEvent("query", this);
this.cacheQueryEvent = new YAHOO.util.CustomEvent("cacheQuery", this);
this.getResultsEvent = new YAHOO.util.CustomEvent("getResults", this);
this.getCachedResultsEvent = new YAHOO.util.CustomEvent("getCachedResults", this);
this.dataErrorEvent = new YAHOO.util.CustomEvent("dataError", this);
this.cacheFlushEvent = new YAHOO.util.CustomEvent("cacheFlush", this);
};
/**
* Adds a result object to the local cache, evicting the oldest element if the
* cache is full. Newer items will have higher indexes, the oldest item will have
* index of 0.
*
* @method _addCacheElem
* @param oResult {Object} Data result object, including array of results.
* @private
*/
YAHOO.widget.DataSource.prototype._addCacheElem = function(oResult) {
var aCache = this._aCache;
// Don't add if anything important is missing.
if(!aCache || !oResult || !oResult.query || !oResult.results) {
return;
}
// If the cache is full, make room by removing from index=0
if(aCache.length >= this.maxCacheEntries) {
aCache.shift();
}
// Add to cache, at the end of the array
aCache.push(oResult);
};
/**
* Queries the local cache for results. If query has been cached, the callback
* function is called with the results, and the cached is refreshed so that it
* is now the newest element.
*
* @method _doQueryCache
* @param oCallbackFn {HTMLFunction} Callback function defined by oParent object to which to return results.
* @param sQuery {String} Query string.
* @param oParent {Object} The object instance that has requested data.
* @return aResults {Object[]} Array of results from local cache if found, otherwise null.
* @private
*/
YAHOO.widget.DataSource.prototype._doQueryCache = function(oCallbackFn, sQuery, oParent) {
var aResults = [];
var bMatchFound = false;
var aCache = this._aCache;
var nCacheLength = (aCache) ? aCache.length : 0;
var bMatchContains = this.queryMatchContains;
// If cache is enabled...
if((this.maxCacheEntries > 0) && aCache && (nCacheLength > 0)) {
this.cacheQueryEvent.fire(this, oParent, sQuery);
// If case is unimportant, normalize query now instead of in loops
if(!this.queryMatchCase) {
var sOrigQuery = sQuery;
sQuery = sQuery.toLowerCase();
}
// Loop through each cached element's query property...
for(var i = nCacheLength-1; i >= 0; i--) {
var resultObj = aCache[i];
var aAllResultItems = resultObj.results;
// If case is unimportant, normalize match key for comparison
var matchKey = (!this.queryMatchCase) ?
encodeURIComponent(resultObj.query).toLowerCase():
encodeURIComponent(resultObj.query);
// If a cached match key exactly matches the query...
if(matchKey == sQuery) {
// Stash all result objects into aResult[] and stop looping through the cache.
bMatchFound = true;
aResults = aAllResultItems;
// The matching cache element was not the most recent,
// so now we need to refresh the cache.
if(i != nCacheLength-1) {
// Remove element from its original location
aCache.splice(i,1);
// Add element as newest
this._addCacheElem(resultObj);
}
break;
}
// Else if this query is not an exact match and subset matching is enabled...
else if(this.queryMatchSubset) {
// Loop through substrings of each cached element's query property...
for(var j = sQuery.length-1; j >= 0 ; j--) {
var subQuery = sQuery.substr(0,j);
// If a substring of a cached sQuery exactly matches the query...
if(matchKey == subQuery) {
bMatchFound = true;
// Go through each cached result object to match against the query...
for(var k = aAllResultItems.length-1; k >= 0; k--) {
var aRecord = aAllResultItems[k];
var sKeyIndex = (this.queryMatchCase) ?
encodeURIComponent(aRecord[0]).indexOf(sQuery):
encodeURIComponent(aRecord[0]).toLowerCase().indexOf(sQuery);
// A STARTSWITH match is when the query is found at the beginning of the key string...
if((!bMatchContains && (sKeyIndex === 0)) ||
// A CONTAINS match is when the query is found anywhere within the key string...
(bMatchContains && (sKeyIndex > -1))) {
// Stash a match into aResults[].
aResults.unshift(aRecord);
}
}
// Add the subset match result set object as the newest element to cache,
// and stop looping through the cache.
resultObj = {};
resultObj.query = sQuery;
resultObj.results = aResults;
this._addCacheElem(resultObj);
break;
}
}
if(bMatchFound) {
break;
}
}
}
// If there was a match, send along the results.
if(bMatchFound) {
this.getCachedResultsEvent.fire(this, oParent, sOrigQuery, aResults);
oCallbackFn(sOrigQuery, aResults, oParent);
}
}
return aResults;
};
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/**
* Implementation of YAHOO.widget.DataSource using XML HTTP requests that return
* query results.
*
* @class DS_XHR
* @extends YAHOO.widget.DataSource
* @requires connection
* @constructor
* @param sScriptURI {String} Absolute or relative URI to script that returns query
* results as JSON, XML, or delimited flat-file data.
* @param aSchema {String[]} Data schema definition of results.
* @param oConfigs {Object} (optional) Object literal of config params.
*/
YAHOO.widget.DS_XHR = function(sScriptURI, aSchema, oConfigs) {
// Set any config params passed in to override defaults
if(typeof oConfigs == "object") {
for(var sConfig in oConfigs) {
this[sConfig] = oConfigs[sConfig];
}
}
// Initialization sequence
if(!aSchema || (aSchema.constructor != Array)) {
YAHOO.log("Could not instantiate XHR DataSource due to invalid arguments", "error", this.toString());
return;
}
else {
this.schema = aSchema;
}
this.scriptURI = sScriptURI;
this._init();
YAHOO.log("XHR DataSource initialized","info",this.toString());
};
YAHOO.widget.DS_XHR.prototype = new YAHOO.widget.DataSource();
/////////////////////////////////////////////////////////////////////////////
//
// Public constants
//
/////////////////////////////////////////////////////////////////////////////
/**
* JSON data type.
*
* @property TYPE_JSON
* @type Number
* @static
* @final
*/
YAHOO.widget.DS_XHR.TYPE_JSON = 0;
/**
* XML data type.
*
* @property TYPE_XML
* @type Number
* @static
* @final
*/
YAHOO.widget.DS_XHR.TYPE_XML = 1;
/**
* Flat-file data type.
*
* @property TYPE_FLAT
* @type Number
* @static
* @final
*/
YAHOO.widget.DS_XHR.TYPE_FLAT = 2;
/**
* Error message for XHR failure.
*
* @property ERROR_DATAXHR
* @type String
* @static
* @final
*/
YAHOO.widget.DS_XHR.ERROR_DATAXHR = "XHR response failed";
/////////////////////////////////////////////////////////////////////////////
//
// Public member variables
//
/////////////////////////////////////////////////////////////////////////////
/**
* Alias to YUI Connection Manager. Allows implementers to specify their own
* subclasses of the YUI Connection Manager utility.
*
* @property connMgr
* @type Object
* @default YAHOO.util.Connect
*/
YAHOO.widget.DS_XHR.prototype.connMgr = YAHOO.util.Connect;
/**
* Number of milliseconds the XHR connection will wait for a server response. A
* a value of zero indicates the XHR connection will wait forever. Any value
* greater than zero will use the Connection utility's Auto-Abort feature.
*
* @property connTimeout
* @type Number
* @default 0
*/
YAHOO.widget.DS_XHR.prototype.connTimeout = 0;
/**
* Absolute or relative URI to script that returns query results. For instance,
* queries will be sent to <scriptURI>?<scriptQueryParam>=userinput
*
* @property scriptURI
* @type String
*/
YAHOO.widget.DS_XHR.prototype.scriptURI = null;
/**
* Query string parameter name sent to scriptURI. For instance, queries will be
* sent to <scriptURI>?<scriptQueryParam>=userinput
*
* @property scriptQueryParam
* @type String
* @default "query"
*/
YAHOO.widget.DS_XHR.prototype.scriptQueryParam = "query";
/**
* String of key/value pairs to append to requests made to scriptURI. Define
* this string when you want to send additional query parameters to your script.
* When defined, queries will be sent to
* <scriptURI>?<scriptQueryParam>=userinput&<scriptQueryAppend>
*
* @property scriptQueryAppend
* @type String
* @default ""
*/
YAHOO.widget.DS_XHR.prototype.scriptQueryAppend = "";
/**
* XHR response data type. Other types that may be defined are YAHOO.widget.DS_XHR.TYPE_XML
* and YAHOO.widget.DS_XHR.TYPE_FLAT.
*
* @property responseType
* @type String
* @default YAHOO.widget.DS_XHR.TYPE_JSON
*/
YAHOO.widget.DS_XHR.prototype.responseType = YAHOO.widget.DS_XHR.TYPE_JSON;
/**
* String after which to strip results. If the results from the XHR are sent
* back as HTML, the gzip HTML comment appears at the end of the data and should
* be ignored.
*
* @property responseStripAfter
* @type String
* @default "\n<!-"
*/
YAHOO.widget.DS_XHR.prototype.responseStripAfter = "\n<!-";
/////////////////////////////////////////////////////////////////////////////
//
// Public methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Queries the live data source defined by scriptURI for results. Results are
* passed back to a callback function.
*
* @method doQuery
* @param oCallbackFn {HTMLFunction} Callback function defined by oParent object to which to return results.
* @param sQuery {String} Query string.
* @param oParent {Object} The object instance that has requested data.
*/
YAHOO.widget.DS_XHR.prototype.doQuery = function(oCallbackFn, sQuery, oParent) {
var isXML = (this.responseType == YAHOO.widget.DS_XHR.TYPE_XML);
var sUri = this.scriptURI+"?"+this.scriptQueryParam+"="+sQuery;
if(this.scriptQueryAppend.length > 0) {
sUri += "&" + this.scriptQueryAppend;
}
YAHOO.log("DataSource is querying URL " + sUri, "info", this.toString());
var oResponse = null;
var oSelf = this;
/*
* Sets up ajax request callback
*
* @param {object} oReq HTTPXMLRequest object
* @private
*/
var responseSuccess = function(oResp) {
// Response ID does not match last made request ID.
if(!oSelf._oConn || (oResp.tId != oSelf._oConn.tId)) {
oSelf.dataErrorEvent.fire(oSelf, oParent, sQuery, YAHOO.widget.DataSource.ERROR_DATANULL);
YAHOO.log(YAHOO.widget.DataSource.ERROR_DATANULL, "error", this.toString());
return;
}
//DEBUG
/*YAHOO.log(oResp.responseXML.getElementsByTagName("Result"),'warn');
for(var foo in oResp) {
YAHOO.log(foo + ": "+oResp[foo],'warn');
}
YAHOO.log('responseXML.xml: '+oResp.responseXML.xml,'warn');*/
if(!isXML) {
oResp = oResp.responseText;
}
else {
oResp = oResp.responseXML;
}
if(oResp === null) {
oSelf.dataErrorEvent.fire(oSelf, oParent, sQuery, YAHOO.widget.DataSource.ERROR_DATANULL);
YAHOO.log(YAHOO.widget.DataSource.ERROR_DATANULL, "error", oSelf.toString());
return;
}
var aResults = oSelf.parseResponse(sQuery, oResp, oParent);
var resultObj = {};
resultObj.query = decodeURIComponent(sQuery);
resultObj.results = aResults;
if(aResults === null) {
oSelf.dataErrorEvent.fire(oSelf, oParent, sQuery, YAHOO.widget.DataSource.ERROR_DATAPARSE);
YAHOO.log(YAHOO.widget.DataSource.ERROR_DATAPARSE, "error", oSelf.toString());
aResults = [];
}
else {
oSelf.getResultsEvent.fire(oSelf, oParent, sQuery, aResults);
oSelf._addCacheElem(resultObj);
}
oCallbackFn(sQuery, aResults, oParent);
};
var responseFailure = function(oResp) {
oSelf.dataErrorEvent.fire(oSelf, oParent, sQuery, YAHOO.widget.DS_XHR.ERROR_DATAXHR);
YAHOO.log(YAHOO.widget.DS_XHR.ERROR_DATAXHR + ": " + oResp.statusText, "error", oSelf.toString());
return;
};
var oCallback = {
success:responseSuccess,
failure:responseFailure
};
if(!isNaN(this.connTimeout) && this.connTimeout > 0) {
oCallback.timeout = this.connTimeout;
}
if(this._oConn) {
this.connMgr.abort(this._oConn);
}
oSelf._oConn = this.connMgr.asyncRequest("GET", sUri, oCallback, null);
};
/**
* Parses raw response data into an array of result objects. The result data key
* is always stashed in the [0] element of each result object.
*
* @method parseResponse
* @param sQuery {String} Query string.
* @param oResponse {Object} The raw response data to parse.
* @param oParent {Object} The object instance that has requested data.
* @returns {Object[]} Array of result objects.
*/
YAHOO.widget.DS_XHR.prototype.parseResponse = function(sQuery, oResponse, oParent) {
var aSchema = this.schema;
var aResults = [];
var bError = false;
// Strip out comment at the end of results
var nEnd = ((this.responseStripAfter !== "") && (oResponse.indexOf)) ?
oResponse.indexOf(this.responseStripAfter) : -1;
if(nEnd != -1) {
oResponse = oResponse.substring(0,nEnd);
}
switch (this.responseType) {
case YAHOO.widget.DS_XHR.TYPE_JSON:
var jsonList;
// Divert KHTML clients from JSON lib
if(window.JSON && (navigator.userAgent.toLowerCase().indexOf('khtml')== -1)) {
// Use the JSON utility if available
var jsonObjParsed = JSON.parse(oResponse);
if(!jsonObjParsed) {
bError = true;
break;
}
else {
try {
// eval is necessary here since aSchema[0] is of unknown depth
jsonList = eval("jsonObjParsed." + aSchema[0]);
}
catch(e) {
bError = true;
break;
}
}
}
else {
// Parse the JSON response as a string
try {
// Trim leading spaces
while (oResponse.substring(0,1) == " ") {
oResponse = oResponse.substring(1, oResponse.length);
}
// Invalid JSON response
if(oResponse.indexOf("{") < 0) {
bError = true;
break;
}
// Empty (but not invalid) JSON response
if(oResponse.indexOf("{}") === 0) {
break;
}
// Turn the string into an object literal...
// ...eval is necessary here
var jsonObjRaw = eval("(" + oResponse + ")");
if(!jsonObjRaw) {
bError = true;
break;
}
// Grab the object member that contains an array of all reponses...
// ...eval is necessary here since aSchema[0] is of unknown depth
jsonList = eval("(jsonObjRaw." + aSchema[0]+")");
}
catch(e) {
bError = true;
break;
}
}
if(!jsonList) {
bError = true;
break;
}
if(jsonList.constructor != Array) {
jsonList = [jsonList];
}
// Loop through the array of all responses...
for(var i = jsonList.length-1; i >= 0 ; i--) {
var aResultItem = [];
var jsonResult = jsonList[i];
// ...and loop through each data field value of each response
for(var j = aSchema.length-1; j >= 1 ; j--) {
// ...and capture data into an array mapped according to the schema...
var dataFieldValue = jsonResult[aSchema[j]];
if(!dataFieldValue) {
dataFieldValue = "";
}
//YAHOO.log("data: " + i + " value:" +j+" = "+dataFieldValue,"debug",this.toString());
aResultItem.unshift(dataFieldValue);
}
// If schema isn't well defined, pass along the entire result object
if(aResultItem.length == 1) {
aResultItem.push(jsonResult);
}
// Capture the array of data field values in an array of results
aResults.unshift(aResultItem);
}
break;
case YAHOO.widget.DS_XHR.TYPE_XML:
// Get the collection of results
var xmlList = oResponse.getElementsByTagName(aSchema[0]);
if(!xmlList) {
bError = true;
break;
}
// Loop through each result
for(var k = xmlList.length-1; k >= 0 ; k--) {
var result = xmlList.item(k);
//YAHOO.log("Result"+k+" is "+result.attributes.item(0).firstChild.nodeValue,"debug",this.toString());
var aFieldSet = [];
// Loop through each data field in each result using the schema
for(var m = aSchema.length-1; m >= 1 ; m--) {
//YAHOO.log(aSchema[m]+" is "+result.attributes.getNamedItem(aSchema[m]).firstChild.nodeValue);
var sValue = null;
// Values may be held in an attribute...
var xmlAttr = result.attributes.getNamedItem(aSchema[m]);
if(xmlAttr) {
sValue = xmlAttr.value;
//YAHOO.log("Attr value is "+sValue,"debug",this.toString());
}
// ...or in a node
else{
var xmlNode = result.getElementsByTagName(aSchema[m]);
if(xmlNode && xmlNode.item(0) && xmlNode.item(0).firstChild) {
sValue = xmlNode.item(0).firstChild.nodeValue;
//YAHOO.log("Node value is "+sValue,"debug",this.toString());
}
else {
sValue = "";
//YAHOO.log("Value not found","debug",this.toString());
}
}
// Capture the schema-mapped data field values into an array
aFieldSet.unshift(sValue);
}
// Capture each array of values into an array of results
aResults.unshift(aFieldSet);
}
break;
case YAHOO.widget.DS_XHR.TYPE_FLAT:
if(oResponse.length > 0) {
// Delete the last line delimiter at the end of the data if it exists
var newLength = oResponse.length-aSchema[0].length;
if(oResponse.substr(newLength) == aSchema[0]) {
oResponse = oResponse.substr(0, newLength);
}
var aRecords = oResponse.split(aSchema[0]);
for(var n = aRecords.length-1; n >= 0; n--) {
aResults[n] = aRecords[n].split(aSchema[1]);
}
}
break;
default:
break;
}
sQuery = null;
oResponse = null;
oParent = null;
if(bError) {
return null;
}
else {
return aResults;
}
};
/////////////////////////////////////////////////////////////////////////////
//
// Private member variables
//
/////////////////////////////////////////////////////////////////////////////
/**
* XHR connection object.
*
* @property _oConn
* @type Object
* @private
*/
YAHOO.widget.DS_XHR.prototype._oConn = null;
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/**
* Implementation of YAHOO.widget.DataSource using a native Javascript function as
* its live data source.
*
* @class DS_JSFunction
* @constructor
* @extends YAHOO.widget.DataSource
* @param oFunction {HTMLFunction} In-memory Javascript function that returns query results as an array of objects.
* @param oConfigs {Object} (optional) Object literal of config params.
*/
YAHOO.widget.DS_JSFunction = function(oFunction, oConfigs) {
// Set any config params passed in to override defaults
if(typeof oConfigs == "object") {
for(var sConfig in oConfigs) {
this[sConfig] = oConfigs[sConfig];
}
}
// Initialization sequence
if(!oFunction || (oFunction.constructor != Function)) {
YAHOO.log("Could not instantiate JSFunction DataSource due to invalid arguments", "error", this.toString());
return;
}
else {
this.dataFunction = oFunction;
this._init();
YAHOO.log("JS Function DataSource initialized","info",this.toString());
}
};
YAHOO.widget.DS_JSFunction.prototype = new YAHOO.widget.DataSource();
/////////////////////////////////////////////////////////////////////////////
//
// Public member variables
//
/////////////////////////////////////////////////////////////////////////////
/**
* In-memory Javascript function that returns query results.
*
* @property dataFunction
* @type HTMLFunction
*/
YAHOO.widget.DS_JSFunction.prototype.dataFunction = null;
/////////////////////////////////////////////////////////////////////////////
//
// Public methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Queries the live data source defined by function for results. Results are
* passed back to a callback function.
*
* @method doQuery
* @param oCallbackFn {HTMLFunction} Callback function defined by oParent object to which to return results.
* @param sQuery {String} Query string.
* @param oParent {Object} The object instance that has requested data.
*/
YAHOO.widget.DS_JSFunction.prototype.doQuery = function(oCallbackFn, sQuery, oParent) {
var oFunction = this.dataFunction;
var aResults = [];
aResults = oFunction(sQuery);
if(aResults === null) {
this.dataErrorEvent.fire(this, oParent, sQuery, YAHOO.widget.DataSource.ERROR_DATANULL);
YAHOO.log(YAHOO.widget.DataSource.ERROR_DATANULL, "error", this.toString());
return;
}
var resultObj = {};
resultObj.query = decodeURIComponent(sQuery);
resultObj.results = aResults;
this._addCacheElem(resultObj);
this.getResultsEvent.fire(this, oParent, sQuery, aResults);
oCallbackFn(sQuery, aResults, oParent);
return;
};
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/**
* Implementation of YAHOO.widget.DataSource using a native Javascript array as
* its live data source.
*
* @class DS_JSArray
* @constructor