summaryrefslogtreecommitdiff
path: root/src/mongo/db/fts/fts_query.h
blob: 10e0cd2faaf44f887716922ba0a324df5c14d9bc (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
// fts_query.h

/**
*    Copyright (C) 2012 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 <string>
#include <vector>

#include "mongo/base/status.h"
#include "mongo/db/fts/stemmer.h"
#include "mongo/db/fts/stop_words.h"
#include "mongo/util/stringutils.h"

namespace mongo {

namespace fts {

class FTSQuery {
public:
    // Initializes an FTSQuery.  Note that the parsing of "language" depends on the text
    // index version, since a query which doesn't specify a language and is against a
    // version 1 text index with a version 1 default language string needs to be parsed as
    // version 1 (see fts_language.cpp for a list of language strings specific to version
    // 1).
    Status parse(const std::string& query,
                 StringData language,
                 bool caseSensitive,
                 TextIndexVersion textIndexVersion);

    const std::set<std::string>& getPositiveTerms() const {
        return _positiveTerms;
    }
    const std::set<std::string>& getNegatedTerms() const {
        return _negatedTerms;
    }
    const std::vector<std::string>& getPositivePhr() const {
        return _positivePhrases;
    }
    const std::vector<std::string>& getNegatedPhr() const {
        return _negatedPhrases;
    }

    const std::set<std::string>& getTermsForBounds() const {
        return _termsForBounds;
    }

    const FTSLanguage& getLanguage() const {
        return *_language;
    }
    bool getCaseSensitive() const {
        return _caseSensitive;
    }

    std::string toString() const;

    std::string debugString() const;

    BSONObj toBSON() const;

    /**
     * Lowercases "str" if _caseSensitive is set, else returns a copy of "str" unchanged.
     */
    std::string normalizeString(StringData str) const;

    static const bool caseSensitiveDefault;

private:
    void _addTerms(FTSTokenizer* tokenizer, const std::string& tokens, bool negated);

    const FTSLanguage* _language;
    bool _caseSensitive;

    // Positive terms.
    std::set<std::string> _positiveTerms;

    // Negated terms.
    std::set<std::string> _negatedTerms;

    // Positive phrases.
    std::vector<std::string> _positivePhrases;

    // Negated phrases.
    std::vector<std::string> _negatedPhrases;

    // Terms for bounds.
    std::set<std::string> _termsForBounds;
};
}
}