mongo-portable/.c9/metadata/workspace/browser/Cursor.js

Portable Pure JS MongoDB - Based on Monglodb (https://github.com/euforic/monglodb.git) by Christian Sullivan (http://RogueSynaptics.com)

{"filter":false,"title":"Cursor.js","tooltip":"/browser/Cursor.js","undoManager":{"mark":0,"position":0,"stack":[[{"start":{"row":15,"column":0},"end":{"row":545,"column":24},"action":"remove","lines":["var logger = null;","","/**"," * Cursor"," * "," * @module Cursor"," * @constructor"," * @since 0.0.1"," * "," * @classdesc Cursor class that maps a MongoDB-like cursor"," * "," * @param {MongoPortable} db - Additional options"," * @param {Collection} collection - The collection instance"," * @param {Object|Array|String} [selection={}] - The selection for matching documents"," * @param {Object|Array|String} [fields={}] - The fields of the document to show"," * @param {Object} [options] - Database object"," * "," * @param {Object} [options.pkFactory=null] - Object overriding the basic \"ObjectId\" primary key generation."," * "," */","class Cursor {","    constructor(db, collection, selection, fields, options = {}) {","        this.db = db;","        this.collection = collection;","        this.selector = selection;","        this.skipValue = options.skip || 0;","        this.limitValue = options.limit || 15;","        this.sortValue = options.sort || null;","        this.sorted = false;","        ","        logger = Logger.instance;","    ","        if (Selector.isSelectorCompiled(this.selector)) {","            this.selector_compiled = this.selector;","        } else {","            this.selector_compiled = new Selector(this.selector, Selector.MATCH_SELECTOR);","        }","        ","        for (let i = 0; i < this.selector_compiled.clauses.length; i++) {","            if (this.selector_compiled.clauses[i].key === '_id') {","                this.selector_id = this.selector_compiled.clauses[i].value;","            }","        }","        ","        for (let i = 0; i < this.selector_compiled.clauses.length; i++) {","            if (this.selector_compiled.clauses[i].key === '_id') {","                var _val = this.selector_compiled.clauses[i].value;","                ","                if (_.isString(_val) || _.isNumber(_val)) {","                    this.selector_id = _val;","                }","            }","        }","","        ","        this.fields = new Selector(fields, Selector.FIELD_SELECTOR);","        ","        this.sort_compiled = new Selector(this.sortValue, Selector.SORT_SELECTOR);","    ","        this.db_objects = null;","        this.cursor_pos = 0;","    }","}","","/**"," * Moves a cursor to the begining"," * "," * @method Cursor#rewind"," */","Cursor.prototype.rewind = function() {","    this.db_objects = null;","    this.cursor_pos = 0;","};","","/**"," * Iterates over the cursor, calling a callback function"," * "," * @method Cursor#forEach"," * "," * @param {Function} [callback=null] - Callback function to be called for each document"," */","Cursor.prototype.forEach = function(callback) {","    let docs = this.fetchAll();","    ","    for (let i = 0; i < docs.length; i++) {","        callback(docs[i]);","    }","};","","/**"," * Iterates over the cursor, returning a new array with the documents affected by the callback function"," * "," * @method Cursor#map"," * "," * @param {Function} [callback=null] - Callback function to be called for each document"," * "," * @returns {Array} The documents after being affected with the callback function"," */","Cursor.prototype.map = function(callback) {","    var res = [];","","    this.forEach(function (doc) {","        res.push(callback(doc));","    });","","    return res;","};","","/**"," * Checks if the cursor has one document to be fetched"," * "," * @method Cursor#hasNext"," * "," * @returns {Boolean} True if we can fetch one more document"," */","Cursor.prototype.hasNext = function() {","    return (this.cursor_pos < this.collection.docs.length);","};","","/**"," * Alias for {@link Cursor#fetchOne}"," * "," * @method Cursor#next"," */","Cursor.prototype.next = function() {","    return this.fetchOne();","};","","/**"," * Alias for {@link Cursor#fetchAll}"," * "," * @method Cursor#fetch"," */","Cursor.prototype.fetch = function() {","    return this.fetchAll();","};","","/**"," * Fetch all documents in the cursor"," * "," * @method Cursor#fetchAll"," * "," * @returns {Array} All the documents contained in the cursor"," */","Cursor.prototype.fetchAll = function() {","    return _getDocuments(this, false) || [];","};","","/**"," * Retrieves the next document in the cursor"," * "," * @method Cursor#fetchOne"," * "," * @returns {Object} The next document in the cursor"," */","Cursor.prototype.fetchOne = function() {","    return _getDocuments(this, true);","};","","var _mapFields = function(doc, fields) {","    var _doc = _.cloneDeep(doc);","","    if (!_.isNil(fields) && _.isPlainObject(fields) && !_.isEqual(fields, {})) {","        var showId = true,","            showing = null;","","        // Whether if we showing the _id field","        if (_.hasIn(fields, '_id') && fields._id === -1) {","            showId = false;","        }","","        var tmp = null;","","        for (var field in fields) {","            // Whether if we are showing or hidding fields","            if (field !== '_id' && showing === null) {","                showing = fields[field] === 1 ? true : false;","            }","","            if (showing != null) {","                if (tmp === null) {","                    if (showing) {","                        tmp = {};","                    } else {","                        tmp = _.cloneDeep(doc);","                    }","                }","        ","                // Add or remove the field","                if (showing) {","                    tmp[field] = doc[field];","                } else {","                    delete tmp[field];","                }","            }","        }","","        // Add or remove the _id field","        if (showId) {","            tmp._id = doc._id;","        } else {","            delete tmp._id;","        }","","        _doc = tmp;","    }","","    return _doc;","};","","/**"," * Retrieves one or all the documents in the cursor"," * "," * @method _getDocuments"," * @private"," * "," * @param {Cursor} cursor - The cursor with the documents"," * @param {Boolean} [justOne=false] - Whether it retrieves one or all the documents"," * "," * @returns {Array|Object} If [justOne=true] returns the next document, otherwise returns all the documents"," */","var _getDocuments = function(cursor, justOne = false) {","    if (cursor.selector_id) {","        if (_.hasIn(cursor.collection.doc_indexes, _.toString(cursor.selector_id))) {","            let idx = cursor.collection.doc_indexes[_.toString(cursor.selector_id)];","            ","            return _mapFields(cursor.collection.docs[idx], cursor.fields);","        } else {","            if (justOne) {","                return null;","            } else {","                return [];","            }","        }","    }","    ","    // TODO add warning when sort/skip/limit and fetching one","    // TODO add warning when skip/limit without order","    // TODO index","    while (cursor.cursor_pos < cursor.collection.docs.length) {","        var _doc = cursor.collection.docs[cursor.cursor_pos];","        cursor.cursor_pos++;","        ","        if (cursor.selector_compiled.test(_doc)) {","            if (_.isNil(cursor.db_objects)) cursor.db_objects = [];","            ","            _doc = _mapFields(_doc, cursor.fields);","            ","            cursor.db_objects.push(_doc);","            ","            if (justOne) {","                // Add force sort","                return _doc;","            }","        }","    }","    ","    if (_.isNil(cursor.db_objects)) return null;","    ","    if (!cursor.sorted && hasSorting(cursor)) cursor.sort();","    ","    var idxFrom = cursor.skipValue;","    var idxTo = cursor.limitValue !== -1 ? (cursor.limitValue + idxFrom) : cursor.db_objects.length;","    ","    return cursor.db_objects.slice(idxFrom, idxTo);","    ","};","","/**"," * Obtains the total of documents of the cursor"," * "," * @method Cursor#count"," * "," * @returns {Number} The total of documents in the cursor"," */","Cursor.prototype.count = function() {","    return this.fetchAll().length;","};","","/**"," * Applies a sorting on the cursor"," * "," * @method Cursor#sort"," * "," * @param {Object|Array|String} spec - The sorting specification"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.sort = function(spec) {","    var _sort = this.sort_compiled || null;","    ","    if (spec) {","        _sort = new Selector(spec, Selector.SORT_SELECTOR);","    }","    ","    if (_sort) {","        if (spec) {","            this.sortValue = spec;","            this.sort_compiled = _sort;","        } else {","            // If no spec, do sort","            if (!_.isNil(this.db_objects) && _.isArray(this.db_objects)) {","                this.db_objects = this.db_objects.sort(_sort);","                this.sorted = true;","            }","        }","    }","    ","    return this;","};","","/**"," * Set the number of document to skip when fetching the cursor"," * "," * @method Cursor#skip"," * "," * @param {Number} skip - The number of documents to skip"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.skip = function(skip) {","    if (_.isNil(skip) || _.isNaN(skip)) throw new Error(\"Must pass a number\");","    ","    this.skipValue = skip;","    ","    return this;","};","","/**"," * Set the max number of document to fetch"," * "," * @method Cursor#limit"," * "," * @param {Number} limit - The max number of documents"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.limit = function(limit) {","    if (_.isNil(limit) || _.isNaN(limit)) throw new Error(\"Must pass a number\");","    ","    this.limitValue = limit;","    ","    return this;","};","","/**"," * Checks if a cursor has a sorting defined"," * "," * @method hasSorting"," * @private"," * "," * @param {Cursor} cursor - The cursor"," * "," * @returns {Boolean} Whether the cursor has sorting or not"," */","var hasSorting = function(cursor) {","    if (_.isNil(cursor.sortValue)) return false;","    ","    return true;","};","","/**"," * @todo Implement"," */","Cursor.prototype.batchSize = function() {","    // Controls the number of documents MongoDB will return to the client in a single network message.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.close = function() {","    // Close a cursor and free associated server resources.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.comment = function() {","    // Attaches a comment to the query to allow for traceability in the logs and the system.profile collection.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.explain = function() {","    // Reports on the query execution plan for a cursor.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.hint = function() {","    // Forces MongoDB to use a specific index for a query.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.itcount = function() {","    // Computes the total number of documents in the cursor client-side by fetching and iterating the result set.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.maxScan = function() {","    // Specifies the maximum number of items to scan; documents for collection scans, keys for index scans.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.maxTimeMS = function() {","    // Specifies a cumulative time limit in milliseconds for processing operations on a cursor.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.max = function() {","    // Specifies an exclusive upper index bound for a cursor. For use with cursor.hint()","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.min = function() {","    // Specifies an inclusive lower index bound for a cursor. For use with cursor.hint()","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.noCursorTimeout = function() {","    // Instructs the server to avoid closing a cursor automatically after a period of inactivity.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.objsLeftInBatch = function() {","    // Returns the number of documents left in the current cursor batch.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.pretty = function() {","    // Configures the cursor to display results in an easy-to-read format.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.readConcern = function() {","    // Specifies a read concern for a find() operation.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.readPref = function() {","    // Specifies a read preference to a cursor to control how the client directs queries to a replica set.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.returnKey = function() {","    // Modifies the cursor to return index keys rather than the documents.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.showRecordId = function() {","    // Adds an internal storage engine ID field to each document returned by the cursor.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.size = function() {","    // Returns a count of the documents in the cursor after applying skip() and limit() methods.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.snapshot = function() {","    // Forces the cursor to use the index on the _id field. Ensures that the cursor returns each document, ","    // with regards to the value of the _id field, only once.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.tailable = function() {","    // Marks the cursor as tailable. Only valid for cursors over capped collections.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.toArray = function() {","    // Returns an array that contains all documents returned by the cursor.","    throw new Error(\"Not yet implemented\");","};","","module.exports = Cursor;"],"id":8},{"start":{"row":15,"column":0},"end":{"row":657,"column":24},"action":"insert","lines":["var logger = null;","","/**"," * Cursor"," * "," * @module Cursor"," * @constructor"," * @since 0.0.1"," * "," * @classdesc Cursor class that maps a MongoDB-like cursor"," * "," * @param {MongoPortable} db - Additional options"," * @param {Array} documents - The list of documents"," * @param {Object|Array|String} [selection={}] - The selection for matching documents"," * @param {Object|Array|String} [fields={}] - The fields of the document to show"," * @param {Object} [options] - Database object"," * "," * @param {Object} [options.pkFactory=null] - Object overriding the basic \"ObjectId\" primary key generation."," * "," */","class Cursor {","    constructor(documents, selection, fields, options = {}) {","        this.documents = documents;","        this.selector = selection;","        this.skipValue = options.skip || 0;","        this.limitValue = options.limit || 15;","        this.sortValue = options.sort || null;","        this.sorted = false;","        ","        logger = Logger.instance;","    ","        /** ADD IDX **/","        if (Selector.isSelectorCompiled(this.selector)) {","            this.selector_compiled = this.selector;","        } else {","            this.selector_compiled = new Selector(this.selector, Selector.MATCH_SELECTOR);","        }","        ","        for (let i = 0; i < this.selector_compiled.clauses.length; i++) {","            if (this.selector_compiled.clauses[i].key === '_id') {","                this.selector_id = this.selector_compiled.clauses[i].value;","            }","        }","        ","        for (let i = 0; i < this.selector_compiled.clauses.length; i++) {","            if (this.selector_compiled.clauses[i].key === '_id') {","                var _val = this.selector_compiled.clauses[i].value;","                ","                if (_.isString(_val) || _.isNumber(_val)) {","                    this.selector_id = _val;","                }","            }","        }","","        /** ADD IDX **/","        ","        this.fetch_mode = Cursor.COLSCAN || Cursor.IDXSCAN;","        this.indexex = null;//findUsableIndexes();","        ","        // if (cursor.fetch_mode === Cursor.COLSCAN) {","        //     // COLSCAN, wi will iterate over all documents","        //     docs = _.cloneDeep(cursor.collection.docs);","        // } else if (cursor.fetch_mode === Cursor.IDXSCAN) {","        //     // IDXSCAN, wi will iterate over all needed documents","        //     for (let i = 0; i < cursor.indexes.length; i++) {","        //         let index = cursor.indexes[i];","                ","        //         for (let i = index.start; i < index.end; i++) {","        //             let idx_id = cursor.collection.getIndex(index.name)[i];","                    ","        //             docs.push(cursor.collection.docs[idx_id]);","        //         }","        //     }","        // }","        ","        this.fields = new Selector(fields, Selector.FIELD_SELECTOR);","        ","        this.sort_compiled = new Selector(this.sortValue, Selector.SORT_SELECTOR);","    ","        this.db_objects = null;","        this.cursor_pos = 0;","    }","}","","Cursor.COLSCAN = 'colscan';","Cursor.IDXSCAN = 'idxscan';","","/**"," * Moves a cursor to the begining"," * "," * @method Cursor#rewind"," */","Cursor.prototype.rewind = function() {","    this.db_objects = null;","    this.cursor_pos = 0;","};","","/**"," * Iterates over the cursor, calling a callback function"," * "," * @method Cursor#forEach"," * "," * @param {Function} [callback=null] - Callback function to be called for each document"," */","Cursor.prototype.forEach = function(callback) {","    let docs = this.fetchAll();","    ","    for (let i = 0; i < docs.length; i++) {","        callback(docs[i]);","    }","};","","/**"," * Iterates over the cursor, returning a new array with the documents affected by the callback function"," * "," * @method Cursor#map"," * "," * @param {Function} [callback=null] - Callback function to be called for each document"," * "," * @returns {Array} The documents after being affected with the callback function"," */","Cursor.prototype.map = function(callback) {","    var res = [];","","    this.forEach(function (doc) {","        res.push(callback(doc));","    });","","    return res;","};","","/**"," * Checks if the cursor has one document to be fetched"," * "," * @method Cursor#hasNext"," * "," * @returns {Boolean} True if we can fetch one more document"," */","Cursor.prototype.hasNext = function() {","    return (this.cursor_pos < this.documents.length);","};","","/**"," * Alias for {@link Cursor#fetchOne}"," * "," * @method Cursor#next"," */","Cursor.prototype.next = function() {","    return this.fetchOne();","};","","/**"," * Alias for {@link Cursor#fetchAll}"," * "," * @method Cursor#fetch"," */","Cursor.prototype.fetch = function() {","    return this.fetchAll();","};","","/**"," * Fetch all documents in the cursor"," * "," * @method Cursor#fetchAll"," * "," * @returns {Array} All the documents contained in the cursor"," */","Cursor.prototype.fetchAll = function() {","    return _getDocuments(this, false) || [];","};","","/**"," * Retrieves the next document in the cursor"," * "," * @method Cursor#fetchOne"," * "," * @returns {Object} The next document in the cursor"," */","Cursor.prototype.fetchOne = function() {","    return _getDocuments(this, true);","};","","","","Cursor.sort = function(doc, fields) {","    ","};","","/**"," * Projects the fields of one or several documents, changing the output"," * "," * @method Cursor.project"," * "," * @param {Array|Object} doc - The document/s that will be projected"," * @param {String|Array|Object} spec - Fields projection specification. Can be an space/comma separated list, an array, or an object"," * "," * @returns {Array|Object} The document/s after the projection"," */","Cursor.project = function (doc, spec, aggregation = false) {","    if (_.isNil(doc)) logger.throw('doc param required');","    if (_.isNil(spec)) logger.throw('spec param required');","","    var fields = null;","    if (aggregation) {","        fields = new Selector(spec, Selector.AGG_FIELD_SELECTOR);","    } else {","        fields = new Selector(spec, Selector.FIELD_SELECTOR);","    }","    ","    if (_.isArray(doc)) {","        for (var i = 0; i < doc.length; i++) {","            doc[i] = _mapFields(doc[i], fields);","        }","        ","        return doc;","    } else {","        return _mapFields(doc, fields);","    }","","    ","","};","","var _mapFields = function (doc, fields) {","    var _doc = _.cloneDeep(doc);","","    if (!_.isNil(fields) && _.isPlainObject(fields) && !_.isEqual(fields, {})) {","        var showId = true,","            showing = null;","","        // Whether if we showing the _id field","        if (_.hasIn(fields, '_id') && fields._id === -1) {","            showId = false;","        }","","        for (var field in fields) {","            // Whether if we are showing or hidding fields","            if (field !== '_id') {","                if (fields[field] === 1) {","                    showing = true;","                    break;","                } else if (fields[field] === -1) {","                    showing = false;","                    break;","                }","            }","        }","","        var tmp = null;","","        for (var field in fields) {","            if (tmp === null) {","                if (showing) {","                    tmp = {};","                } else {","                    tmp = _.cloneDeep(doc);","                }","            }","    ","            // Add or remove the field","            if (fields[field] === 1 || fields[field] === -1) {","                // Show the field","                if (showing) {","                    tmp[field] = doc[field];","                } else {","                    // Hide the field","                    delete tmp[field];","                }","            } else {","                // Show the new field (rename)","                tmp[field] = doc[fields[field]];","            }","        }","","        // Add or remove the _id field","        if (showId) {","            tmp._id = doc._id;","        } else {","            delete tmp._id;","        }","","        _doc = tmp;","    }","    ","    return _doc;","};","","/**"," * Retrieves one or all the documents in the cursor"," * "," * @method _getDocuments"," * @private"," * "," * @param {Cursor} cursor - The cursor with the documents"," * @param {Boolean} [justOne=false] - Whether it retrieves one or all the documents"," * "," * @returns {Array|Object} If [justOne=true] returns the next document, otherwise returns all the documents"," */","var _getDocuments = function(cursor, justOne = false) {","    var docs = [];","    ","    if (cursor.fetch_mode === Cursor.COLSCAN) {","        // COLSCAN, wi will iterate over all documents","        docs = _.cloneDeep(cursor.documents);","    } else if (cursor.fetch_mode === Cursor.IDXSCAN) {","        // IDXSCAN, wi will iterate over all needed documents","        for (let i = 0; i < cursor.indexes.length; i++) {","            let index = cursor.indexes[i];","            ","            for (let i = index.start; i < index.end; i++) {","                // let idx_id = cursor.collection.getIndex(index.name)[i];","                let idx_id = index.index[i];","                ","                docs.push(cursor.documents[idx_id]);","            }","        }","    }","    ","    // if (cursor.selector_id) {","    //     if (_.hasIn(cursor.collection.doc_indexes, _.toString(cursor.selector_id))) {","    //         let idx = cursor.collection.doc_indexes[_.toString(cursor.selector_id)];","            ","    //         return Cursor.project(cursor.collection.docs[idx], cursor.fields);","    //     } else {","    //         if (justOne) {","    //             return null;","    //         } else {","    //             return [];","    //         }","    //     }","    // }","    ","    // TODO add warning when sort/skip/limit and fetching one","    // TODO add warning when skip/limit without order","    // TODO index","    while (cursor.cursor_pos < docs.length) {","        var _doc = docs[cursor.cursor_pos];","        cursor.cursor_pos++;","        ","        if (cursor.selector_compiled.test(_doc)) {","            if (_.isNil(cursor.db_objects)) cursor.db_objects = [];","            ","            _doc = Cursor.project(_doc, cursor.fields);","            ","            cursor.db_objects.push(_doc);","            ","            if (justOne) {","                // Add force sort","                return _doc;","            }","        }","    }","    ","    if (_.isNil(cursor.db_objects)) return null;","    ","    if (!cursor.sorted && hasSorting(cursor)) cursor.sort();","    ","    var idxFrom = cursor.skipValue;","    var idxTo = cursor.limitValue !== -1 ? (cursor.limitValue + idxFrom) : cursor.db_objects.length;","    ","    return cursor.db_objects.slice(idxFrom, idxTo);","    ","};","","/**"," * Obtains the total of documents of the cursor"," * "," * @method Cursor#count"," * "," * @returns {Number} The total of documents in the cursor"," */","Cursor.prototype.count = function() {","    return this.fetchAll().length;","};","","/**"," * Set the sorting of the cursor"," * "," * @method Cursor#sort"," * "," * @param {Object|Array|String} spec - The sorting specification"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.setSorting = function(spec) {","    if (_.isNil(spec)) logger.throw(\"You need to specify a sorting\");","    ","    if (spec) {","        this.sortValue = spec;","        this.sort_compiled = (new Selector(spec, Selector.SORT_SELECTOR));","    }","    ","    return this;","};","","/**"," * Applies a sorting on the cursor"," * "," * @method Cursor#sort"," * "," * @param {Object|Array|String} spec - The sorting specification"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.sort = function(spec) {","    var _sort = this.sort_compiled || null;","    ","    if (spec) {","        _sort = new Selector(spec, Selector.SORT_SELECTOR);","    }","    ","    if (_sort) {","        if (!_.isNil(this.db_objects) && _.isArray(this.db_objects)) {","            this.db_objects = this.db_objects.sort(_sort);","            this.sorted = true;","        } else {","            this.setSorting(spec);","        }","    }","    ","    return this;","};","","/**"," * Set the number of document to skip when fetching the cursor"," * "," * @method Cursor#skip"," * "," * @param {Number} skip - The number of documents to skip"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.skip = function(skip) {","    if (_.isNil(skip) || _.isNaN(skip)) throw new Error(\"Must pass a number\");","    ","    this.skipValue = skip;","    ","    return this;","};","","/**"," * Set the max number of document to fetch"," * "," * @method Cursor#limit"," * "," * @param {Number} limit - The max number of documents"," * "," * @returns {Cursor} This instance so it can be chained with other methods"," */","Cursor.prototype.limit = function(limit) {","    if (_.isNil(limit) || _.isNaN(limit)) throw new Error(\"Must pass a number\");","    ","    this.limitValue = limit;","    ","    return this;","};","","/**"," * Checks if a cursor has a sorting defined"," * "," * @method hasSorting"," * @private"," * "," * @param {Cursor} cursor - The cursor"," * "," * @returns {Boolean} Whether the cursor has sorting or not"," */","var hasSorting = function(cursor) {","    if (_.isNil(cursor.sortValue)) return false;","    ","    return true;","};","","/**"," * @todo Implement"," */","Cursor.prototype.batchSize = function() {","    // Controls the number of documents MongoDB will return to the client in a single network message.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.close = function() {","    // Close a cursor and free associated server resources.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.comment = function() {","    // Attaches a comment to the query to allow for traceability in the logs and the system.profile collection.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.explain = function() {","    // Reports on the query execution plan for a cursor.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.hint = function() {","    // Forces MongoDB to use a specific index for a query.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.itcount = function() {","    // Computes the total number of documents in the cursor client-side by fetching and iterating the result set.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.maxScan = function() {","    // Specifies the maximum number of items to scan; documents for collection scans, keys for index scans.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.maxTimeMS = function() {","    // Specifies a cumulative time limit in milliseconds for processing operations on a cursor.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.max = function() {","    // Specifies an exclusive upper index bound for a cursor. For use with cursor.hint()","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.min = function() {","    // Specifies an inclusive lower index bound for a cursor. For use with cursor.hint()","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.noCursorTimeout = function() {","    // Instructs the server to avoid closing a cursor automatically after a period of inactivity.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.objsLeftInBatch = function() {","    // Returns the number of documents left in the current cursor batch.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.pretty = function() {","    // Configures the cursor to display results in an easy-to-read format.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.readConcern = function() {","    // Specifies a read concern for a find() operation.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.readPref = function() {","    // Specifies a read preference to a cursor to control how the client directs queries to a replica set.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.returnKey = function() {","    // Modifies the cursor to return index keys rather than the documents.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.showRecordId = function() {","    // Adds an internal storage engine ID field to each document returned by the cursor.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.size = function() {","    // Returns a count of the documents in the cursor after applying skip() and limit() methods.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.snapshot = function() {","    // Forces the cursor to use the index on the _id field. Ensures that the cursor returns each document, ","    // with regards to the value of the _id field, only once.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.tailable = function() {","    // Marks the cursor as tailable. Only valid for cursors over capped collections.","    throw new Error(\"Not yet implemented\");","};","","/**"," * @todo Implement"," */","Cursor.prototype.toArray = function() {","    // Returns an array that contains all documents returned by the cursor.","    throw new Error(\"Not yet implemented\");","};","","module.exports = Cursor;"]}]]},"ace":{"folds":[],"scrolltop":0,"scrollleft":0,"selection":{"start":{"row":0,"column":0},"end":{"row":0,"column":22},"isBackwards":false},"options":{"guessTabSize":true,"useWrapMode":false,"wrapToView":true},"firstLineState":0},"timestamp":1470298150131,"hash":"7eb8e472367429b3a9d7f4b92f297b5245f19dc3"}