src/cm/media/js/lib/yui/yui_3.0.0b1/build/datasource/datasource-function.js
author raph
Mon, 23 Nov 2009 15:14:29 +0100
changeset 0 40c8f766c9b8
permissions -rw-r--r--
import from internal svn r 4007
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     1
/*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     2
Copyright (c) 2009, Yahoo! Inc. All rights reserved.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     3
Code licensed under the BSD License:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     4
http://developer.yahoo.net/yui/license.txt
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     5
version: 3.0.0b1
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     6
build: 1163
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     7
*/
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     8
YUI.add('datasource-function', function(Y) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     9
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    10
/**
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    11
 * Provides a DataSource implementation which can be used to retrieve data from a custom function.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    12
 *
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    13
 * @module datasource
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    14
 * @submodule datasource-function
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    15
 */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    16
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    17
/**
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    18
 * Function subclass for the DataSource Utility.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    19
 * @class DataSource.Function
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    20
 * @extends DataSource.Local
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    21
 * @constructor
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    22
 */    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    23
var LANG = Y.Lang,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    24
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    25
    DSFn = function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    26
        DSFn.superclass.constructor.apply(this, arguments);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    27
    };
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    28
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    29
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    30
    /////////////////////////////////////////////////////////////////////////////
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    31
    //
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    32
    // DataSource.Function static properties
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    33
    //
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    34
    /////////////////////////////////////////////////////////////////////////////
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    35
Y.mix(DSFn, {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    36
    /**
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    37
     * Class name.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    38
     *
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    39
     * @property NAME
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    40
     * @type String
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    41
     * @static     
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    42
     * @final
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    43
     * @value "dataSourceFunction"
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    44
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    45
    NAME: "dataSourceFunction",
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    46
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    47
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    48
    /////////////////////////////////////////////////////////////////////////////
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    49
    //
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    50
    // DataSource.Function Attributes
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    51
    //
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    52
    /////////////////////////////////////////////////////////////////////////////
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    53
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    54
    ATTRS: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    55
        /**
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    56
        * @attribute source
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    57
        * @description Pointer to live data.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    58
        * @type MIXED
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    59
        * @default null
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    60
        */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    61
        source: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    62
            validator: LANG.isFunction
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    63
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    64
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    65
});
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    66
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    67
Y.extend(DSFn, Y.DataSource.Local, {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    68
    /**
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    69
     * Passes query string to IO. Fires <code>response</code> event when
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    70
     * response is received asynchronously.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    71
     *
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    72
     * @method _defRequestFn
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    73
     * @param e {Event.Facade} Event Facade with the following properties:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    74
     * <dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    75
     * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    76
     * <dt>request (Object)</dt> <dd>The request.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    77
     * <dt>callback (Object)</dt> <dd>The callback object with the following properties:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    78
     *     <dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    79
     *         <dt>success (Function)</dt> <dd>Success handler.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    80
     *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    81
     *     </dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    82
     * </dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    83
     * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    84
     * </dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    85
     * @protected
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    86
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    87
    _defRequestFn: function(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    88
        var fn = this.get("source"),
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    89
            response;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    90
            
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    91
            if(fn) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    92
                response = fn(e.request, this, e);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    93
                this.fire("data", Y.mix({data:response}, e));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    94
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    95
            else {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    96
                e.error = new Error("Function data failure");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    97
                this.fire("error", e);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    98
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    99
            
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   100
        return e.tId;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   101
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   102
});
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   103
  
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   104
Y.DataSource.Function = DSFn;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   105
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   106
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   107
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   108
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   109
}, '3.0.0b1' ,{requires:['datasource-local']});