summaryrefslogtreecommitdiff
path: root/src/mongo/db/matcher/matcher.h
blob: 55011d766007505467defdab524e43c80d69b89e (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
// matcher.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 <boost/scoped_ptr.hpp>

#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/matcher/match_details.h"

namespace mongo {

    class Matcher2 {
        MONGO_DISALLOW_COPYING( Matcher2 );

        struct IndexSpliceInfo {
            IndexSpliceInfo() {
                hasNullEquality = false;
            }

            bool hasNullEquality;
        };

    public:
        explicit Matcher2( const BSONObj& pattern, bool nested=false /* do not use */ );

        /**
         * Generate a matcher for the provided index key format using the
         * provided full doc matcher.
         * THIS API WILL GO AWAY EVENTUALLY
         */
        explicit Matcher2( const Matcher2 &docMatcher, const BSONObj &constrainIndexKey );


        bool matches(const BSONObj& doc, MatchDetails* details = NULL ) const;

        bool atomic() const;

        bool hasExistsFalse() const;

        /*
         * this is from old mature
         * criteria is 1 equality expression, nothing else
         */
        bool singleSimpleCriterion() const;

        const BSONObj* getQuery() const { return &_pattern; };
        std::string toString() const { return _pattern.toString(); }

        /**
         * @return true if this key matcher will return the same true/false
         * value as the provided doc matcher.
         */
        bool keyMatch( const Matcher2 &docMatcher ) const;

        static MatchExpression* spliceForIndex( const BSONObj& key,
                                                const MatchExpression* full,
                                                IndexSpliceInfo* spliceInfo );

    private:
        BSONObj _pattern;
        BSONObj _indexKey;

        boost::scoped_ptr<MatchExpression> _expression;

        IndexSpliceInfo _spliceInfo;

        static MatchExpression* _spliceForIndex( const set<std::string>& keys,
                                                 const MatchExpression* full,
                                                 IndexSpliceInfo* spliceInfo );

    };

}