doc/entitybase.js.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: entitybase.js</title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Source: entitybase.js</h1>
    
    
    <section>
        <article>
            <pre class="prettyprint source"><code>/**
 * Represents base query-building logic
 * @namespace LGI.Guide
 * @class EntityBase
 * @extends Collection
 */

function EntityBase() {
    Collection.call(this);

    this.filters = [];
    this._queryModificationActions = [];
    this._requestURL = '';
    this._request = new Request();
}

EntityBase.prototype = Object.create(Collection.prototype);

/**
 * Adds limitation to response data length. For example "a.limit(10);"
 * @method EntityBase#limit
 * @param {number} limitTo Number of maximum data elements in response.
 */
EntityBase.prototype.limit = function (limitTo) {
    this._addURLModification('maxBatchSize=' + limitTo);

    return this;
};

/**
 * Determines list of fields to be retrieved from server. For example by "a.shows(LGI.Guide.channel.id, LGI.Guide.channel.name);"
 * @method EntityBase#fields
 * @param {string} multipleArgs You can add unlimited number of strings as multiple parameters.
 */
EntityBase.prototype.fields = function (multipleArgs) {
    this._addURLModification('show=' + Array.prototype.slice.call(arguments).join(','));

    return this;
};

/**
 * Sets sorting field and order. For example "a.sort(LGI.Guide.broadcast.startTime);"
 * @order EntityBase#sort
 * @param {string} field Field to sort records by.
 * @param {string} [order="asc"] Determines order we want to sort records with - ascendant (asc) or descendant (desc).
 */
EntityBase.prototype.sort = function (field, order) {
    if (typeof order === 'undefined' || order === null) {
        order = 'asc';
    }

    if (order === 'asc' || order === 'desc') {
        this._addURLModification('sort=' + field + '(' + order + ')');
    } else {
        throw new Error('Invalid sort option, expecting "asc" or "desc"');
    }

    return this;
};

/**
 * Filters data by some of entity properties. For example "a.filter(LGI.Guide.channel.id.equalTo(1));"
 * @method EntityBase#filter
 * @param {string} multipleArgs You can add unlimited number of strings as multiple parameters.
 */
EntityBase.prototype.filter = function (multipleArgs) {
    for (var i = 0; i &lt; arguments.length; i++) {
        this._addURLModification(arguments[i]);
        this.filters.push(arguments[i]);
    }

    return this;
};

/**
 * Retrieves one page of data.
 * @method EntityBase#findOne
 * @param {Function} callback Callback to execute and pass response to.
 */
EntityBase.prototype.findOne = function (callback) {
    this._buildURLFromElements();
    this._request.execute(this._requestURL, this._createScopedCallback(callback), 1);
    return this;
};

/**
 * Retrieves next page of data.
 * @method EntityBase#findNext
 * @param {Function} callback Callback to execute and pass response to.
 */
EntityBase.prototype.findNext = function (callback) {
    this._request.execute(this._request.nextBatchLink || this._buildURLFromElements(), this._createScopedCallback(callback), 1);
    return this;
};

/**
 * Retrieves all pages of data one by one and then executes callback.
 * @method EntityBase#findAll
 * @param {Function} callback Callback to execute and pass response to.
 */
EntityBase.prototype.findAll = function (callback) {
    this._buildURLFromElements();
    this._request.execute(this._requestURL, this._createScopedCallback(callback));
    return this;
};

EntityBase.prototype._addURLModification = function (modificationObject) {
    this._queryModificationActions.push(modificationObject);
};

EntityBase.prototype._buildURLFromElements = function () {
    this._requestURL = LGI.Guide.config.APIURL;

    if (this._URLprefix !== undefined) {
        this._requestURL += this._URLprefix;
    }

    if (LGI.Guide.config.region !== '') {
        this._requestURL += LGI.Guide.config.region + '/';
    }

    this._requestURL += this._baseURL;

    for (var i = 0; i &lt; this._queryModificationActions.length; i++) {
        //If processing is an action object - execute actionFunction on current URL
        if (this._queryModificationActions[i].actionFunction) {
            this._requestURL = this._executeModificationAction(this._queryModificationActions[i]);
        } else {
            //If this is just a string - concat
            var joinSymbol = '&';
            if (i === 0) {
                joinSymbol = '';
            }
            this._requestURL += joinSymbol + this._queryModificationActions[i];
        }
    }

    return this._requestURL;
};

EntityBase.prototype._executeModificationAction = function (actionObject) {
    return actionObject.actionFunction.apply(actionObject.context, [this._requestURL, actionObject.stringValue]);
}

EntityBase.prototype._processData = function (data) {
    this.add(data);
};

EntityBase.prototype._processResponse = function (response) {
    this.filters = response.filter || this.filters;
    this.sortings = response.order || this.sortings;
};

EntityBase.prototype._createScopedCallback = function (callback) {

    var scopedCallback = function (data, response) {
        this._processData(data);
        this._processResponse(response);

        if (callback !== undefined) {
            callback.bind(this)(data);
        }
    };

    return scopedCallback.bind(this);
};</code></pre>
        </article>
    </section>


</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-utils.html">utils</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractField.html">AbstractField</a></li><li><a href="Broadcast.html">Broadcast</a></li><li><a href="Channel.html">Channel</a></li><li><a href="Collection.html">Collection</a></li><li><a href="EntityBase.html">EntityBase</a></li><li><a href="NumericField.html">NumericField</a></li><li><a href="PrependField.html">PrependField</a></li><li><a href="Region.html">Region</a></li><li><a href="Request.html">Request</a></li><li><a href="TextField.html">TextField</a></li><li><a href="Video.html">Video</a></li></ul><h3>Namespaces</h3><ul><li><a href="LGI.Guide.config.html">config</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon Aug 25 2014 16:57:51 GMT+0200 (CEST)
</footer>

<script> prettyPrint(); </script>
</body>
</html>