summaryrefslogtreecommitdiff
path: root/src/mongo/db/index/2d_index_cursor.h
blob: c977dcfedec5d96b27272950462208327d301c38 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
*    Copyright (C) 2013 10gen Inc.
*
*    This program is free software: you can redistribute it and/or  modify
*    it under the terms of the GNU Affero General Public License, version 3,
*    as published by the Free Software Foundation.
*
*    This program is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*    GNU Affero General Public License for more details.
*
*    You should have received a copy of the GNU Affero General Public License
*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include <vector>

#include "mongo/base/status.h"
#include "mongo/db/geo/geoquery.h"
#include "mongo/db/index/2d_common.h"
#include "mongo/db/index/index_cursor.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/pdfile.h"
#include "mongo/platform/unordered_map.h"

namespace mongo {

    class TwoDAccessMethod;
    class GeoNearArguments;

    namespace twod_internal {
        class GeoCursorBase;

        class TwoDGeoNearRunner {
        public:
            static bool run2DGeoNear(NamespaceDetails* nsd, int idxNo, const BSONObj& cmdObj,
                                     const GeoNearArguments &parsedArgs, string& errmsg,
                                     BSONObjBuilder& result, unordered_map<string, double>* stats);
        };
    }

    class TwoDIndexCursor : public IndexCursor {
    public:
        TwoDIndexCursor(TwoDAccessMethod* accessMethod);

        /**
         *  Parse the query, figure out if it's a near or a non-near predicate, and create the
         * appropriate sub-cursor.
         */
        virtual Status seek(const BSONObj& position);

        /**
         * We pay attention to the numWanted option.
         */
        virtual Status setOptions(const CursorOptions& options);

        // Implemented:
        virtual bool isEOF() const;
        virtual BSONObj getKey() const;
        virtual DiskLoc getValue() const;
        virtual void next();

        virtual string toString();

        virtual Status savePosition();
        virtual Status restorePosition();

        virtual void explainDetails(BSONObjBuilder* b);

    private:
        TwoDAccessMethod* _accessMethod;
        int _numWanted;

        scoped_ptr<twod_internal::GeoCursorBase> _underlyingCursor;
    };
}  // namespace mongo