src/cm/media/js/lib/yui/yui3-3.15.0/build/datasource-local/datasource-local-debug.js
author gibus
Mon, 10 Mar 2014 15:19:48 +0100
changeset 602 e16a97fb364a
permissions -rw-r--r--
Use YUI 3.15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('datasource-local', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
 * The DataSource utility provides a common configurable interface for widgets to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
 * access a variety of data, from JavaScript arrays to online database servers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
 * @module datasource
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
 * @main datasource
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
 * Provides the base DataSource implementation, which can be extended to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
 * create DataSources for specific data protocols, such as the IO Utility, the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
 * Get Utility, or custom functions.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
 * @module datasource
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
 * @submodule datasource-local
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
 * Base class for the DataSource Utility.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
 * @class DataSource.Local
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
 * @extends Base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
var LANG = Y.Lang,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
DSLocal = function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
    DSLocal.superclass.constructor.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
    // DataSource static properties
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
Y.mix(DSLocal, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
     * Class name.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
     * @property NAME
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
     * @final
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
     * @value "dataSourceLocal"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
    NAME: "dataSourceLocal",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
    // DataSource Attributes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
    ATTRS: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
        * @attribute source
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
        * @description Pointer to live data.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
        * @type MIXED
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
        * @default null
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
        */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
        source: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
            value: null
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
     * Global transaction counter.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
     * @property _tId
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
     * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
     * @default 0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
    _tId: 0,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
     * Global in-progress transaction objects.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
     * @property transactions
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
     * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
    transactions: {},
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
     * Returns data to callback.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
     * @method issueCallback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
     * @param e {EventFacade} Event Facade.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
     * @param caller {DataSource} Calling DataSource instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
    issueCallback: function (e, caller) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
        var callbacks = e.on || e.callback,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
            callback = callbacks && callbacks.success,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
            payload = e.details[0];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
        payload.error = (e.error || e.response.error);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
        if (payload.error) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
            caller.fire("error", payload);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
            callback = callbacks && callbacks.failure;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
        if (callback) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
            //TODO: this should be executed from a specific context
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
            callback(payload);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
Y.extend(DSLocal, Y.Base, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
    * Internal init() handler.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
    *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
    * @method initializer
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
    * @param config {Object} Config object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
    initializer: function(config) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
        this._initEvents();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
    * This method creates all the events for this module.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
    * @method _initEvents
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
    _initEvents: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
         * Fired when a data request is received.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
         * @event request
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
         * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
         * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
         * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
         * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
         * <dt>callback (Object)</dt> <dd>The callback object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
         *   (deprecated, refer to <strong>on</strong></dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
         * <dt>on (Object)</dt> <dd>The map of configured callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
         *   functions.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
         * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
         * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
         * @preventable _defRequestFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
        this.publish("request", {defaultFn: Y.bind("_defRequestFn", this), queuable:true});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
         * Fired when raw data is received.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
         * @event data
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
         * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
         * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
         * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
         * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
         * <dt>callback (Object)</dt> <dd>Deprecated alias for the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
         *   <strong>on</strong> property</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
         * <dt>on (Object)</dt> <dd>The map of configured transaction
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
         *   callbacks.  An object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
         *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
         *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
         *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
         *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
         * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
         * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
         * <dt>data (Object)</dt> <dd>Raw data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
         * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
         * @preventable _defDataFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
        this.publish("data", {defaultFn: Y.bind("_defDataFn", this), queuable:true});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
         * Fired when response is returned.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
         * @event response
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
         * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
         * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
         * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
         * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
         * <dt>callback (Object)</dt> <dd>Deprecated alias for the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
         *   <strong>on</strong> property</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
         * <dt>on (Object)</dt> <dd>The map of configured transaction
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
         *   callbacks.  An object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
         *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
         *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
         *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
         *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
         * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
         * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
         * <dt>data (Object)</dt> <dd>Raw data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
         * <dt>response (Object)</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
         *     <dd>Normalized response object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
         *         <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
         *             <dt>results (Object)</dt> <dd>Parsed results.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
         *             <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
         *             <dt>error (Boolean)</dt> <dd>Error flag.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
         *         </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   200
         *     </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   201
         * <dt>error</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   202
         *     <dd>Any error that occurred along the transaction lifecycle.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   203
         * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   204
         * @preventable _defResponseFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   205
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   206
         this.publish("response", {defaultFn: Y.bind("_defResponseFn", this), queuable:true});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   207
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   208
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   209
         * Fired when an error is encountered.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   210
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   211
         * @event error
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   212
         * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   213
         * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   214
         * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   215
         * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   216
         * <dt>callback (Object)</dt> <dd>Deprecated alias for the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   217
         *   <strong>on</strong> property</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   218
         * <dt>on (Object)</dt> <dd>The map of configured transaction
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   219
         *   callbacks.  An object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   220
         *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   221
         *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   222
         *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   223
         *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   224
         * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   225
         * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   226
         * <dt>data (Object)</dt> <dd>Raw data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   227
         * <dt>response (Object)</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   228
         *     <dd>Normalized response object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   229
         *         <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   230
         *             <dt>results (Object)</dt> <dd>Parsed results.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   231
         *             <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   232
         *             <dt>error (Object)</dt> <dd>Error object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   233
         *         </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   234
         *     </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   235
         * <dt>error</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   236
         *     <dd>Any error that occurred along the transaction lifecycle.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   237
         * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   238
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   239
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   240
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   241
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   242
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   243
     * Manages request/response transaction. Must fire <code>response</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   244
     * event when response is received. This method should be implemented by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   245
     * subclasses to achieve more complex behavior such as accessing remote data.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   246
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   247
     * @method _defRequestFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   248
     * @param e {EventFacade} Event Facadewith the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   249
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   250
     * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   251
     * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   252
     * <dt>callback (Object)</dt> <dd>Deprecated alias for the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   253
     *   <strong>on</strong> property</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   254
     * <dt>on (Object)</dt> <dd>The map of configured transaction
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   255
     *   callbacks.  An object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   256
     *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   257
     *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   258
     *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   259
     *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   260
     * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   261
     * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   262
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   263
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   264
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   265
    _defRequestFn: function(e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   266
        var data = this.get("source"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   267
            payload = e.details[0];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   268
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   269
        // Problematic data
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   270
        if(LANG.isUndefined(data)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   271
            payload.error = new Error("Local source undefined");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   272
            Y.log("Local source undefined", "error", "datasource-local");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   273
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   274
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   275
        payload.data = data;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   276
        this.fire("data", payload);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   277
        Y.log("Transaction " + e.tId + " complete. Request: " +
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   278
                Y.dump(e.request) + " . Response: " + Y.dump(e.response), "info", "datasource-local");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   279
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   280
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   281
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   282
     * Normalizes raw data into a response that includes results and meta properties.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   283
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   284
     * @method _defDataFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   285
     * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   286
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   287
     * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   288
     * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   289
     * <dt>callback (Object)</dt> <dd>Deprecated alias for the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   290
     *   <strong>on</strong> property</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   291
     * <dt>on (Object)</dt> <dd>The map of configured transaction
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   292
     *   callbacks.  An object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   293
     *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   294
     *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   295
     *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   296
     *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   297
     * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   298
     * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   299
     * <dt>data (Object)</dt> <dd>Raw data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   300
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   301
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   302
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   303
    _defDataFn: function(e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   304
        var data = e.data,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   305
            meta = e.meta,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   306
            response = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   307
                results: (LANG.isArray(data)) ? data : [data],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   308
                meta: (meta) ? meta : {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   309
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   310
            payload = e.details[0];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   311
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   312
        payload.response = response;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   313
        this.fire("response", payload);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   314
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   315
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   316
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   317
     * Sends data as a normalized response to callback.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   318
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   319
     * @method _defResponseFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   320
     * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   321
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   322
     * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   323
     * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   324
     * <dt>callback (Object)</dt> <dd>Deprecated alias for the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   325
     *   <strong>on</strong> property</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   326
     * <dt>on (Object)</dt> <dd>The map of configured transaction
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   327
     *   callbacks.  An object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   328
     *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   329
     *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   330
     *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   331
     *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   332
     * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   333
     * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   334
     * <dt>data (Object)</dt> <dd>Raw data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   335
     * <dt>response (Object)</dt> <dd>Normalized response object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   336
     *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   337
     *         <dt>results (Object)</dt> <dd>Parsed results.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   338
     *         <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   339
     *         <dt>error (Boolean)</dt> <dd>Error flag.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   340
     *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   341
     * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   342
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   343
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   344
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   345
    _defResponseFn: function(e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   346
        // Send the response back to the callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   347
        DSLocal.issueCallback(e, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   348
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   349
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   350
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   351
     * Generates a unique transaction ID and fires <code>request</code> event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   352
     * <strong>Note</strong>: the property <code>callback</code> is a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   353
     * deprecated alias for the <code>on</code> transaction configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   354
     * property described below.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   355
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   356
     * @method sendRequest
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   357
     * @param [request] {Object} An object literal with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   358
     *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   359
     *     <dt><code>request</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   360
     *     <dd>The request to send to the live data source, if any.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   361
     *     <dt><code>on</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   362
     *     <dd>An object literal with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   363
     *         <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   364
     *         <dt><code>success</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   365
     *         <dd>The function to call when the data is ready.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   366
     *         <dt><code>failure</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   367
     *         <dd>The function to call upon a response failure condition.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   368
     *         <dt><code>argument</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   369
     *         <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   370
     *         </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   371
     *     </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   372
     *     <dt><code>cfg</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   373
     *     <dd>Configuration object, if any.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   374
     *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   375
     * @return {Number} Transaction ID.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   376
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   377
    sendRequest: function(request) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   378
        var tId = DSLocal._tId++,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   379
            callbacks;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   380
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   381
        request = request || {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   382
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   383
        callbacks = request.on || request.callback;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   384
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   385
        this.fire("request", {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   386
            tId: tId,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   387
            request: request.request,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   388
            on: callbacks,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   389
            callback: callbacks,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   390
            cfg: request.cfg || {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   391
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   392
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   393
        Y.log("Transaction " + tId + " sent request: " + Y.dump(request.request), "info", "datasource-local");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   394
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   395
        return tId;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   396
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   397
});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   398
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   399
Y.namespace("DataSource").Local = DSLocal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   400
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   401
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   402
}, '@VERSION@', {"requires": ["base"]});