//////////////////////////////////////////////////////////////////////////////// /// @brief Avocado Simple Query Language /// /// @file /// /// DISCLAIMER /// /// Copyright 2012 triagens GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (the "License"); /// you may not use this file except in compliance with the License. /// You may obtain a copy of the License at /// /// http://www.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2012, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// var internal = require("internal"); var AvocadoCollection = internal.AvocadoCollection; var AvocadoEdgesCollection = internal.AvocadoEdgesCollection; //////////////////////////////////////////////////////////////////////////////// /// @page SimpleQueriesTOC /// ///
    ///
  1. @ref SimpleQueriesQueries ///
      ///
    1. @ref SimpleQueryDocument "db.@FA{collection}.document(@FA{document-reference})"
      2. ///
    2. @ref SimpleQueryAll "db.@FA{collection}.all()"
      3. ///
    3. @ref SimpleQueryCount "@FA{query}.count()"
      4. ///
    ///
    2. ///
  2. @ref SimpleQueriesGeoQueries ///
      ///
    1. @ref SimpleQueryNear "db.@FA{collection}.near()"
      2. ///
    2. @ref SimpleQueryWithin "db.@FA{collection}.within()"
      3. ///
    3. @ref SimpleQueryGeo "db.@FA{collection}.geo()"
      4. ///
    ///
    3. ///
  3. @ref SimpleQueriesEdgesQueries ///
      ///
    1. @ref SimpleQueryEdges "edges.@FA{collection}.edges()"
      2. ///
    2. @ref SimpleQueryInEdges "edges.@FA{collection}.inEdges()"
      3. ///
    3. @ref SimpleQueryOutEdges "edges.@FA{collection}.outEdges()"
      4. ///
    ///
    4. ///
  4. @ref SimpleQueriesPagination ///
      ///
    1. @ref SimpleQueryLimit "@FA{query}.limit(@FA{limit})"
      2. ///
    2. @ref SimpleQuerySkip "@FA{query}.skip(@FA{skip})"
      3. ///
    ///
    5. ///
  5. @ref SimpleQueriesSequentialAccess ///
      ///
    1. @ref SimpleQueryHasNext "@FA{query}.hasNext()"
      2. ///
    2. @ref SimpleQueryNext "@FA{query}.next()"
      3. ///
    3. @ref SimpleQueryNextRef "@FA{query}.nextRef()"
      4. ///
    ///
    6. ///
//////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @page SimpleQueries Simple Queries /// /// Simple queries can be used if the query condition is very simple, i. e., a /// document reference, all documents, a query-by-example, or a simple geo /// query. In a simple query you can specify exactly one collection and one /// condition. The result can then be sorted and result can be split into pages. /// ///
/// @copydoc SimpleQueriesTOC ///
/// /// @section SimpleQueriesQueries Queries ///////////////////////////////////////// /// /// @anchor SimpleQueryDocument /// @copydetails JS_DocumentQuery ///
/// /// @anchor SimpleQueryAll /// @copydetails JSF_AvocadoCollection_prototype_all ///
/// /// @anchor SimpleQueryCount /// @copydetails JSF_SimpleQuery_prototype_count /// /// @section SimpleQueriesGeoQueries Geo Queries //////////////////////////////////////////////// /// /// The AvocadoDB allows to selects documents based on geographic /// coordinates. In order for this to work, a geo-spatial index must be defined. /// This index will use a very elaborate algorithm to lookup neighbours that is /// a magnitude faster than a simple R* index. /// /// In general a geo coordinate is a pair of latitude and longitude. This can /// either be an list with two elements like @CODE{[ -10\, +30 ]} (latitude /// first, followed by longitude) or an object like @CODE{{ lon: -10\, lat: +30 /// }}. In order to find all documents within a given radius around a /// coordinate use the @FN{within} operator. In order to find all /// documents near a given document use the @FN{near} operator. /// /// It is possible to define more than one geo-spatial index per collection. In /// this case you must give a hint using the @FN{geo} operator which of indexes /// should be used in a query. /// ///
/// /// @anchor SimpleQueryNear /// @copydetails JSF_AvocadoCollection_prototype_near ///
/// /// @anchor SimpleQueryWithin /// @copydetails JSF_AvocadoCollection_prototype_within ///
/// /// @anchor SimpleQueryGeo /// @copydetails JSF_AvocadoCollection_prototype_geo /// /// @section SimpleQueriesEdgesQueries Edges Queries //////////////////////////////////////////////////// /// /// @anchor SimpleQueryEdges /// @copydetails JS_EdgesQuery ///
/// /// @anchor SimpleQueryInEdges /// @copydetails JS_InEdgesQuery ///
/// /// @anchor SimpleQueryOutEdges /// @copydetails JS_OutEdgesQuery /// /// @section SimpleQueriesPagination Pagination /////////////////////////////////////////////// /// /// If, for example, you display the result of a user search, then you are in /// general not interested in the completed result set, but only the first 10 or /// so documents. Or maybe the next 10 documents for the second page. In this /// case, you can the @FN{skip} and @FN{limit} operators. These operators works /// like LIMIT in MySQL. /// /// @FN{skip} used together with @FN{limit} can be used to implement pagination. /// The @FN{skip} operator skips over the first n documents. So, in order to /// create result pages with 10 result documents per page, you can use /// @CODE{skip(n * 10).limit(10)} to access the 10 documents on the n.th page. /// This result should be sorted, so that the pagination works in a predicable /// way. /// /// @anchor SimpleQueryLimit /// @copydetails JSF_SimpleQuery_prototype_limit ///
/// /// @anchor SimpleQuerySkip /// @copydetails JSF_SimpleQuery_prototype_skip /// /// @section SimpleQueriesSequentialAccess Sequential Access //////////////////////////////////////////////////////////// /// /// @anchor SimpleQueryHasNext /// @copydetails JSF_SimpleQuery_prototype_hasNext ///
/// /// @anchor SimpleQueryNext /// @copydetails JSF_SimpleQuery_prototype_next ///
/// /// @anchor SimpleQueryNextRef /// @copydetails JSF_SimpleQuery_prototype_nextRef //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- AVOCADO COLLECTION // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief constructs an all query for a collection /// /// @FUN{all()} /// /// Selects all documents of a collection. You can use @FN{toArray}, @FN{next}, /// @FN{nextRef}, or @FN{hasNext} to access the result. The result can be /// limited using the @FN{skip} and @FN{limit} operator. /// /// @EXAMPLES /// /// Use @FN{toArray} to get all documents at once: /// /// @verbinclude simple3 /// /// Use @FN{next} to loop over all documents: /// /// @verbinclude simple4 //////////////////////////////////////////////////////////////////////////////// AvocadoCollection.prototype.all = function () { return new SimpleQueryAll(this); } AvocadoEdgesCollection.prototype.all = AvocadoCollection.prototype.all; //////////////////////////////////////////////////////////////////////////////// /// @brief constructs a near query for a collection /// /// @FUN{near(@FA{latitiude}, @FA{longitude})} /// /// The default will find at most 100 documents near the coordinate /// (@FA{latitiude}, @FA{longitude}). The returned list is sorted according to /// the distance, with the nearest document coming first. If there are near /// documents of equal distance, documents are chosen randomly from this set /// until the limit is reached. It is possible to change the limit using the /// @FA{limit} operator. /// /// In order to use the @FN{near} operator, a geo index must be defined for the /// collection. This index also defines which attribute holds the coordinates /// for the document. If you have more then one geo-spatial index, you can use /// the @FN{geo} operator to select a particular index. /// /// @FUN{near(@FA{latitiude}, @FA{longitude}).limit(@FA{limit})} /// /// Limits the result to @FA{limit} documents. Note that @FA{limit} can be more /// than 100, this will raise the default limit. /// /// @FUN{near(@FA{latitiude}, @FA{longitude}).distance()} /// /// This will add an attribute @LIT{distance} to all documents returned, which /// contains the distance between the given point and the document in meter. /// /// @FUN{near(@FA{latitiude}, @FA{longitude}).distance(@FA{name})} /// /// This will add an attribute @FA{name} to all documents returned, which /// contains the distance between the given point and the document in meter. /// /// @EXAMPLES /// /// To get the nearst two locations: /// /// @verbinclude simple14 /// /// If you need the distance as well, then you can use: /// /// @verbinclude simple15 //////////////////////////////////////////////////////////////////////////////// AvocadoCollection.prototype.near = function (lat, lon) { return new SimpleQueryNear(this, lat, lon); } AvocadoEdgesCollection.prototype.near = AvocadoCollection.prototype.near; //////////////////////////////////////////////////////////////////////////////// /// @brief constructs a within query for a collection /// /// @FUN{within(@FA{latitiude}, @FA{longitude}, @FA{radius})} /// /// This will find all documents with in a given radius around the coordinate /// (@FA{latitiude}, @FA{longitude}). The returned list is sorted by distance. /// /// In order to use the @FN{within} operator, a geo index must be defined for the /// collection. This index also defines which attribute holds the coordinates /// for the document. If you have more then one geo-spatial index, you can use /// the @FN{geo} operator to select a particular index. /// /// @FUN{within(@FA{latitiude}, @FA{longitude}, @FA{radius}).distance()} /// /// This will add an attribute @LIT{_distance} to all documents returned, which /// contains the distance between the given point and the document in meter. /// /// @FUN{within(@FA{latitiude}, @FA{longitude}, @FA{radius}).distance(@FA{name})} /// /// This will add an attribute @FA{name} to all documents returned, which /// contains the distance between the given point and the document in meter. /// /// @EXAMPLES /// /// To find all documents within a radius of 2000 km use: /// /// @verbinclude simple17 //////////////////////////////////////////////////////////////////////////////// AvocadoCollection.prototype.within = function (lat, lon, radius) { return new SimpleQueryWithin(this, lat, lon, radius); } AvocadoEdgesCollection.prototype.within = AvocadoCollection.prototype.within; //////////////////////////////////////////////////////////////////////////////// /// @brief constructs a geo index selection /// /// @FUN{geo(@FA{location})} /// /// The next @FN{near} or @FN{within} operator will use the specific geo-spatial /// index. /// /// @FUN{geo(@FA{location}, @LIT{true})} /// /// The next @FN{near} or @FN{within} operator will use the specific geo-spatial /// index. /// /// @FUN{geo(@FA{latitiude}, @FA{longitude})} /// /// The next @FN{near} or @FN{within} operator will use the specific geo-spatial /// index. /// /// @EXAMPLES /// /// Assume you have a location stored as list in the attribute @LIT{home} /// and a destination stored in the attribute @LIT{work}. Than you can use the /// @FN{geo} operator to select, which coordinates to use in a near query. /// /// @verbinclude simple16 //////////////////////////////////////////////////////////////////////////////// AvocadoCollection.prototype.geo = function(loc, order) { var idx; var locateGeoIndex1 = function(collection, loc, order) { var inds = collection.getIndexes(); for (var i = 0; i < inds.length; ++i) { var index = inds[i]; if (index.type == "geo") { if (index.location == loc && index.geoJson == order) { return index; } } } return null; }; var locateGeoIndex2 = function(collection, lat, lon) { var inds = collection.getIndexes(); for (var i = 0; i < inds.length; ++i) { var index = inds[i]; if (index.type == "geo") { if (index.latitude == lat && index.longitude == lon) { return index; } } } return null; }; if (order === undefined) { idx = locateGeoIndex1(this, loc, false); } else if (typeof order === "boolean") { idx = locateGeoIndex1(this, loc, order); } else { idx = locateGeoIndex2(this, loc, order); } if (idx == null) { throw "cannot find a suitable geo index"; } return new SimpleQueryGeo(this, idx.iid); } AvocadoEdgesCollection.prototype.geo = AvocadoCollection.geo; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- SIMPLE QUERY // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief simple query //////////////////////////////////////////////////////////////////////////////// function SimpleQuery () { this._execution = null; this._skip = 0; this._limit = null; this._countQuery = null; this._countTotal = null; } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief join limits //////////////////////////////////////////////////////////////////////////////// function JoinLimits (query, limit) { var q; // original limit is 0, keep it if (query._limit == 0) { query = query.clone(); } // new limit is 0, use it else if (limit == 0) { query = query.clone(); query._limit = 0; } // no old limit, use new limit else if (query._limit == null) { query = query.clone(); query._limit = limit } // both are positive, use the smaller one else if (0 < query._limit && 0 < limit) { query = query.clone(); if (limit < query._limit) { query._limit = limit; } } // both are negative, use the greater one else if (query._limit < 0 && limit < 0) { query = query.clone(); if (query._limit < limit) { query._limit = limit; } } // different sign else { q = query.toArray(); q = new SimpleQueryArray(q); q._limit = limit; q._countTotal = query._countTotal; query = q; } return query; } //////////////////////////////////////////////////////////////////////////////// /// @brief clones a query //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.clone = function () { throw "cannot clone abstract query"; } //////////////////////////////////////////////////////////////////////////////// /// @brief executes a query //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.execute = function () { throw "cannot execute abstract query"; } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief limit /// /// @FUN{limit(@FA{number})} /// /// Limits a result to the first @FA{number} documents. Specifying a limit of /// @CODE{0} returns no documents at all. If you do not need a limit, just do /// not add the limit operator. If you specifiy a negtive limit of @CODE{-n}, /// this will return the last @CODE{n} documents instead. /// /// In general the input to @FN{limit} should be sorted. Otherwise it will be /// unclear which documents are used in the result set. /// /// @EXAMPLES /// /// @verbinclude simple2 //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.limit = function (limit) { if (this._execution != null) { throw "query is already executing"; } return JoinLimits(this, limit); } //////////////////////////////////////////////////////////////////////////////// /// @brief skip /// /// @FUN{skip(@FA{number})} /// /// Skips the first @FA{number} documents. /// /// In general the input to @FN{limit} should be sorted. Otherwise it will be /// unclear which documents are used in the result set. /// /// @EXAMPLES /// /// @verbinclude simple8 //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.skip = function (skip) { var query; var documents; if (skip == null) { skip = 0; } if (skip < 0) { throw "skip must be non-negative"; } if (this._execution != null) { throw "query is already executing"; } // no limit set, use or add skip if (this._limit == null) { query = this.clone(); if (this._skip == null || this._skip == 0) { query._skip = skip; } else { query._skip += skip; } } // limit already skip else { documents = this.clone(); query = new SimpleQueryArray(documents.toArray()); query._skip = skip; query._countTotal = documents._countTotal; } return query; } //////////////////////////////////////////////////////////////////////////////// /// @brief converts into an array //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.toArray = function () { var cursor; var result; this.execute(); result = []; while (this.hasNext()) { result.push(this.next()); } return result; } //////////////////////////////////////////////////////////////////////////////// /// @brief counts the number of documents /// /// @FUN{count()} /// /// The @FN{count} operator counts the number of document in the result set and /// returns that number. The @FN{count} operator ignores any limits and returns /// the total number of documents found. /// /// @FUN{count(@LIT{true})} /// /// If the result set was limited by the @FN{limit} operator or documents were /// skiped using the @FN{skip} operator, the @FN{count} operator with argument /// @LIT{true} will use the number of elements in the final result set - after /// applying @FN{limit} and @FN{skip}. /// /// @EXAMPLES /// /// Ignore any limit: /// /// @verbinclude simple9 /// /// Counting any limit or skip: /// /// @verbinclude simple10 //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.count = function (applyPagination) { this.execute(); if (applyPagination === undefined || ! applyPagination) { return this._countTotal; } else { return this._countQuery; } } //////////////////////////////////////////////////////////////////////////////// /// @brief checks if the cursor is exhausted /// /// @FUN{hasNext()} /// /// The @FN{hasNext} operator returns @LIT{true}, then the cursor still has /// documents. In this case the next document can be accessed using the /// @FN{next} operator, which will advance the cursor. /// /// @verbinclude simple7 //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.hasNext = function () { this.execute(); return this._execution.hasNext(); } //////////////////////////////////////////////////////////////////////////////// /// @brief returns the next result document /// /// @FUN{next()} /// /// If the @FN{hasNext} operator returns @LIT{true}, then the underlying /// cursor of the simple query still has documents. In this case the /// next document can be accessed using the @FN{next} operator, which /// will advance the underlying cursor. If you use @FN{next} on an /// exhausted cursor, then @LIT{undefined} is returned. /// /// @verbinclude simple5 //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.next = function() { this.execute(); return this._execution.next(); } //////////////////////////////////////////////////////////////////////////////// /// @brief returns the next result document reference /// /// @FUN{nextRef()} /// /// If the @FN{hasNext} operator returns @LIT{true}, then the underlying cursor /// of the simple query still has documents. In this case the next document /// reference can be accessed using the @FN{nextRef} operator, which will /// advance the cursor. If you use @FN{next} on an exhausted cursor, then /// @LIT{undefined} is returned. /// /// @verbinclude simple6 //////////////////////////////////////////////////////////////////////////////// SimpleQuery.prototype.nextRef = function() { this.execute(); return this._execution.nextRef(); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- SIMPLE QUERY ALL // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief all query //////////////////////////////////////////////////////////////////////////////// function SimpleQueryAll (collection) { this._collection = collection; } SimpleQueryAll.prototype = new SimpleQuery(); SimpleQueryAll.prototype.constructor = SimpleQueryAll; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief clones an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryAll.prototype.clone = function () { var query; query = new SimpleQueryAll(this._collection); query._skip = this._skip; query._limit = this._limit; return query; } //////////////////////////////////////////////////////////////////////////////// /// @brief executes an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryAll.prototype.execute = function () { var documents; if (this._execution == null) { if (this._skip == null || this._skip <= 0) { this._skip = 0; } documents = this._collection.ALL(this._skip, this._limit); this._execution = new SimpleQueryArray(documents.documents); this._countQuery = documents.count; this._countTotal = documents.total; } } //////////////////////////////////////////////////////////////////////////////// /// @brief print an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryAll.prototype._PRINT = function () { var text; text = "SimpleQueryAll(" + this._collection._name + ")"; if (this._skip != null && this._skip != 0) { text += ".skip(" + this._skip + ")"; } if (this._limit != null) { text += ".limit(" + this._limit + ")"; } internal.output(text); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- SIMPLE QUERY ARRAY // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief array query //////////////////////////////////////////////////////////////////////////////// function SimpleQueryArray (documents) { this._documents = documents; this._current = 0; this._countTotal = documents.length; } SimpleQueryArray.prototype = new SimpleQuery(); SimpleQueryArray.prototype.constructors = SimpleQueryArray; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief clones an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype.clone = function () { var query; query = new SimpleQueryArray(this._documents); query._skip = this._skip; query._limit = this._limit; query._countTotal = this._countTotal; return query; } //////////////////////////////////////////////////////////////////////////////// /// @brief executes an array query //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype.execute = function () { if (this._execution == null) { this._execution = true; if (this._skip == null || this._skip <= 0) { this._skip = 0; } if (this._skip != 0 && this._limit == null) { this._current = this._skip; this._countQuery = this._documents.length - this._skip; if (this._countQuery < 0) { this._countQuery = 0; } } else if (this._limit != null) { var documents; var start; var end; if (0 == this._limit) { start = 0; end = 0; } else if (0 < this._limit) { start = this._skip; end = this._skip + this._limit; } else { start = this._documents.length + this._limit - this._skip; end = this._documents.length - this._skip; } if (start < 0) { start = 0; } if (this._documents.length < end) { end = this._documents.length; } documents = []; for (var i = start; i < end; ++i) { documents.push(this._documents[i]); } this._documents = documents; this._skip = 0; this._limit = null; this._countQuery = this._documents.length; } } } //////////////////////////////////////////////////////////////////////////////// /// @brief print an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype._PRINT = function () { var text; text = "SimpleQueryArray([.. " + this._documents.length + " docs ..])"; if (this._skip != null && this._skip != 0) { text += ".skip(" + this._skip + ")"; } if (this._limit != null) { text += ".limit(" + this._limit + ")"; } internal.output(text); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief counts the number of documents //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype.count = function (applyPagination) { this.execute(); if (applyPagination === undefined || ! applyPagination) { return this._countTotal; } else { return this._countQuery; } } //////////////////////////////////////////////////////////////////////////////// /// @brief checks if the cursor is exhausted //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype.hasNext = function () { this.execute(); return this._current < this._documents.length; } //////////////////////////////////////////////////////////////////////////////// /// @brief returns the next result document //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype.next = function() { this.execute(); if (this._current < this._documents.length) { return this._documents[this._current++]; } else { return undefined; } } //////////////////////////////////////////////////////////////////////////////// /// @brief returns the next result document reference //////////////////////////////////////////////////////////////////////////////// SimpleQueryArray.prototype.nextRef = function() { this.execute(); if (this._current < this._documents.length) { return this._documents[this._current++]._id; } else { return undefined; } } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- SIMPLE QUERY GEO // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief geo index //////////////////////////////////////////////////////////////////////////////// function SimpleQueryGeo (collection, index) { this._collection = collection; this._index = index; } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief print a geo index //////////////////////////////////////////////////////////////////////////////// SimpleQueryGeo.prototype._PRINT = function () { var text; text = "GeoIndex(" + this._collection._name + ", " + this._index + ")"; internal.output(text); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief constructs a near query for an index //////////////////////////////////////////////////////////////////////////////// SimpleQueryGeo.prototype.near = function (lat, lon) { return new SimpleQueryNear(this._collection, lat, lon, this._index); } //////////////////////////////////////////////////////////////////////////////// /// @brief constructs a within query for an index //////////////////////////////////////////////////////////////////////////////// SimpleQueryGeo.prototype.within = function (lat, lon, radius) { return new SimpleQueryWithin(this._collection, lat, lon, radius, this._index); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- SIMPLE QUERY NEAR // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief all query //////////////////////////////////////////////////////////////////////////////// function SimpleQueryNear (collection, latitiude, longitude, iid) { var idx; this._collection = collection; this._latitude = latitiude; this._longitude = longitude; this._index = (iid === undefined ? null : iid); this._distance = null; if (iid == null) { idx = collection.getIndexes(); for (var i = 0; i < idx.length; ++i) { var index = idx[i]; if (index.type == "geo") { if (this._index == null) { this._index = index.iid; } else if (index.iid < this._index) { this._index = index.iid; } } } } if (this._index == null) { throw "an geo-index must be known"; } } SimpleQueryNear.prototype = new SimpleQuery(); SimpleQueryNear.prototype.constructor = SimpleQueryNear; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief clones an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryNear.prototype.clone = function () { var query; query = new SimpleQueryNear(this._collection, this._latitude, this._longitude, this._index); query._skip = this._skip; query._limit = this._limit; query._distance = this._distance; return query; } //////////////////////////////////////////////////////////////////////////////// /// @brief executes an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryNear.prototype.execute = function () { var result; var documents; var distances; var limit; if (this._execution == null) { if (this._skip == null || this._skip <= 0) { this._skip = 0; } if (this._limit == null) { limit = this._skip + 100; } else { limit = this._skip + this._limit; } result = this._collection.NEAR(this._index, this._latitude, this._longitude, limit); documents = result.documents; distances = result.distances; if (this._distance != null) { for (var i = this._skip; i < documents.length; ++i) { documents[i][this._distance] = distances[i]; } } this._execution = new SimpleQueryArray(result.documents); this._execution._skip = this._skip; this._countQuery = result.documents.length - this._skip; this._countTotal = result.documents.length; } } //////////////////////////////////////////////////////////////////////////////// /// @brief print a near query //////////////////////////////////////////////////////////////////////////////// SimpleQueryNear.prototype._PRINT = function () { var text; text = "SimpleQueryNear(" + this._collection._name + ", " + this._latitude + ", " + this._longitude + ", " + this._index + ")"; if (this._skip != null && this._skip != 0) { text += ".skip(" + this._skip + ")"; } if (this._limit != null) { text += ".limit(" + this._limit + ")"; } internal.output(text); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief //////////////////////////////////////////////////////////////////////////////// SimpleQueryNear.prototype.distance = function (attribute) { var clone; clone = this.clone(); if (attribute) { clone._distance = attribute; } else { clone._distance = "distance"; } return clone; } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- SIMPLE QUERY WITHIN // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief all query //////////////////////////////////////////////////////////////////////////////// function SimpleQueryWithin (collection, latitiude, longitude, radius, iid) { var idx; this._collection = collection; this._latitude = latitiude; this._longitude = longitude; this._index = (iid === undefined ? null : iid); this._radius = radius; this._distance = null; if (iid == null) { idx = collection.getIndexes(); for (var i = 0; i < idx.length; ++i) { var index = idx[i]; if (index.type == "geo") { if (this._index == null) { this._index = index.iid; } else if (index.iid < this._index) { this._index = index.iid; } } } } if (this._index == null) { throw "an geo-index must be known"; } } SimpleQueryWithin.prototype = new SimpleQuery(); SimpleQueryWithin.prototype.constructor = SimpleQueryWithin; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief clones an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryWithin.prototype.clone = function () { var query; query = new SimpleQueryWithin(this._collection, this._latitude, this._longitude, this._radius, this._index); query._skip = this._skip; query._limit = this._limit; query._distance = this._distance; return query; } //////////////////////////////////////////////////////////////////////////////// /// @brief executes an all query //////////////////////////////////////////////////////////////////////////////// SimpleQueryWithin.prototype.execute = function () { var result; var documents; var distances; var limit; if (this._execution == null) { result = this._collection.WITHIN(this._index, this._latitude, this._longitude, this._radius); documents = result.documents; distances = result.distances; if (this._distance != null) { for (var i = this._skip; i < documents.length; ++i) { documents[i][this._distance] = distances[i]; } } this._execution = new SimpleQueryArray(result.documents); this._execution._skip = this._skip; this._execution._limit = this._limit; this._countQuery = result.documents.length - this._skip; this._countTotal = result.documents.length; } } //////////////////////////////////////////////////////////////////////////////// /// @brief print a within query //////////////////////////////////////////////////////////////////////////////// SimpleQueryWithin.prototype._PRINT = function () { var text; text = "SimpleQueryWithin(" + this._collection._name + ", " + this._latitude + ", " + this._longitude + ", " + this._radius + ", " + this._index + ")"; if (this._skip != null && this._skip != 0) { text += ".skip(" + this._skip + ")"; } if (this._limit != null) { text += ".limit(" + this._limit + ")"; } internal.output(text); } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup SimpleQuery /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief //////////////////////////////////////////////////////////////////////////////// SimpleQueryWithin.prototype.distance = function (attribute) { var clone; clone = this.clone(); if (attribute) { clone._distance = attribute; } else { clone._distance = "distance"; } return clone; } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- MODULE EXPORTS // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup AvocadoGraph /// @{ //////////////////////////////////////////////////////////////////////////////// exports.AvocadoCollection = AvocadoCollection; exports.AvocadoEdgesCollection = AvocadoEdgesCollection; exports.SimpleQuery = SimpleQuery; exports.SimpleQueryAll = SimpleQueryAll; exports.SimpleQueryArray = SimpleQueryArray; exports.SimpleQueryGeo = SimpleQueryGeo; exports.SimpleQueryNear = SimpleQueryNear; exports.SimpleQueryWithin = SimpleQueryWithin; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // Local Variables: // mode: outline-minor // outline-regexp: "^\\(/// @brief\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @}\\)" // End: