summaryrefslogtreecommitdiff
path: root/src/mongo/db/matcher/expression.h
blob: 734fb4e75c8431160c2cada08d988083ec5f4602 (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
// expression.h

/**
 *    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 "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/bson/bsonobj.h"

namespace mongo {

    class TreeExpression;
    class MatchDetails;

    class Expression {
        MONGO_DISALLOW_COPYING( Expression );

    public:
        Expression(){}
        virtual ~Expression(){}

        /**
         * determins if the doc matches the expression
         * there could be an expression that looks at fields, or the entire doc
         */
        virtual bool matches( const BSONObj& doc, MatchDetails* details = 0 ) const = 0;

        /**
         * does the element match the expression
         * not valid for all expressions ($where) where this will immediately return false
         */
        virtual bool matchesSingleElement( const BSONElement& e ) const = 0;

        virtual string toString() const;
        virtual void debugString( StringBuilder& debug, int level = 0 ) const = 0;
    protected:
        void _debugAddSpace( StringBuilder& debug, int level ) const;
    };

}