summaryrefslogtreecommitdiff
path: root/src/mongo/db/geo/geoquery.h
blob: 79a7c3216734bf6294277ab474ac6b2beccfd89a (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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/**
*    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/>.
*
*    As a special exception, the copyright holders give permission to link the
*    code of portions of this program with the OpenSSL library under certain
*    conditions as described in each individual source file and distribute
*    linked combinations including the program with the OpenSSL library. You
*    must comply with the GNU Affero General Public License in all respects for
*    all of the code used other than as permitted herein. If you modify file(s)
*    with this exception, you may extend this exception to your version of the
*    file(s), but you are not obligated to do so. If you do not wish to do so,
*    delete this exception statement from your version. If you delete this
*    exception statement from all source files in the program, then also delete
*    it in the license file.
*/

#pragma once

#include "mongo/db/geo/geoparser.h"
#include "mongo/db/geo/shapes.h"
#include "mongo/util/mongoutils/str.h"
#include "third_party/s2/s2regionunion.h"

namespace mongo {

    class GeometryContainer {
    public:
        bool parseFrom(const BSONObj &obj);

        /**
         * Is the geometry any of {Point, Line, Polygon}?
         */
        bool isSimpleContainer() const;

        /**
         * To check intersection, we iterate over the otherContainer's geometries, checking each
         * geometry to see if we intersect it.  If we intersect one geometry, we intersect the
         * entire other container.
         */
        bool intersects(const GeometryContainer& otherContainer) const;

        /**
         * To check containment, we iterate over the otherContainer's geometries.  If we don't
         * contain any sub-geometry of the otherContainer, the otherContainer is not contained
         * within us.  If each sub-geometry of the otherContainer is contained within us, we contain
         * the entire otherContainer.
         */
        bool contains(const GeometryContainer& otherContainer) const;

        /**
         * Only polygons (and aggregate types thereof) support contains.
         */
        bool supportsContains() const;

        bool hasS2Region() const;
        bool hasFlatRegion() const;

        // Used by s2cursor only to generate a covering of the query object.
        // One region is not NULL and this returns it.
        const S2Region& getRegion() const;
    // XXX FIXME
    // private:
        // Does 'this' intersect with the provided type?
        bool intersects(const S2Cell& otherPoint) const;
        bool intersects(const S2Polyline& otherLine) const;
        bool intersects(const S2Polygon& otherPolygon) const;
        // These three just iterate over the geometries and call the 3 methods above.
        bool intersects(const MultiPointWithCRS& otherMultiPoint) const;
        bool intersects(const MultiLineWithCRS& otherMultiLine) const;
        bool intersects(const MultiPolygonWithCRS& otherMultiPolygon) const;

        // Used when 'this' has a polygon somewhere, either in _polygon or _multiPolygon or
        // _geometryCollection.
        bool contains(const S2Cell& otherCell, const S2Point& otherPoint) const;
        bool contains(const S2Polyline& otherLine) const;
        bool contains(const S2Polygon& otherPolygon) const;

        // Only one of these shared_ptrs should be non-NULL.  S2Region is a
        // superclass but it only supports testing against S2Cells.  We need
        // the most specific class we can get.
        shared_ptr<PointWithCRS> _point;
        shared_ptr<LineWithCRS> _line;
        shared_ptr<PolygonWithCRS> _polygon;
        shared_ptr<CapWithCRS> _cap;
        shared_ptr<MultiPointWithCRS> _multiPoint;
        shared_ptr<MultiLineWithCRS> _multiLine;
        shared_ptr<MultiPolygonWithCRS> _multiPolygon;
        shared_ptr<GeometryCollection> _geometryCollection;
        shared_ptr<BoxWithCRS> _box;

        shared_ptr<S2RegionUnion> _region;
    };

    // TODO: Make a struct, turn parse stuff into something like
    // static Status parseNearQuery(const BSONObj& obj, NearQuery** out);
    class NearQuery {
    public:
        NearQuery()
            : minDistance(0),
              maxDistance(std::numeric_limits<double>::max()),
              isNearSphere(false) { }

        NearQuery(const string& f)
            : field(f),
              minDistance(0),
              maxDistance(std::numeric_limits<double>::max()),
              isNearSphere(false) { }

        Status parseFrom(const BSONObj &obj);

        // The name of the field that contains the geometry.
        string field;

        // The starting point of the near search.
        PointWithCRS centroid;

        // Min and max distance from centroid that we're willing to search.
        // Distance is in whatever units the centroid's CRS implies.
        // If centroid.crs == FLAT these are radians.
        // If centroid.crs == SPHERE these are meters.
        double minDistance;
        double maxDistance;

        // It's either $near or $nearSphere.
        bool isNearSphere;

        string toString() const {
            stringstream ss;
            ss << " field=" << field;
            ss << " maxdist=" << maxDistance;
            ss << " isNearSphere=" << isNearSphere;
            return ss.str();
        }

    private:
        bool parseLegacyQuery(const BSONObj &obj);
        Status parseNewQuery(const BSONObj &obj);
    };

    // This represents either a $within or a $geoIntersects.
    class GeoQuery {
    public:
        GeoQuery() : field(""), predicate(INVALID) {}
        GeoQuery(const string& f) : field(f), predicate(INVALID) {}

        enum Predicate {
            WITHIN,
            INTERSECT,
            INVALID
        };

        bool parseFrom(const BSONObj &obj);
        bool satisfiesPredicate(const GeometryContainer &otherContainer) const;

        bool hasS2Region() const;
        const S2Region& getRegion() const;
        string getField() const { return field; }

        Predicate getPred() const { return predicate; }
        const GeometryContainer& getGeometry() const { return geoContainer; }

    private:
        // Try to parse the provided object into the right place.
        bool parseLegacyQuery(const BSONObj &obj);
        bool parseNewQuery(const BSONObj &obj);

        // Name of the field in the query.
        string field;
        GeometryContainer geoContainer;
        Predicate predicate;
    };
}  // namespace mongo