blob: dc506b68702e4395a75a00d3ce2204504e0fdb03 (
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
|
/**
* Copyright (C) 2016 MongoDB 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/bson/bsontypes.h"
namespace mongo {
class BSONElement;
class BSONObjBuilder;
class CollatorInterface;
/**
* Provides functionality related to the mapping of user data to collator-generated comparison keys
* in index keys.
*/
class CollationIndexKey {
public:
/**
* Returns true if type can be affected in comparison or sort order by collation.
*/
static bool isCollatableType(BSONType type) {
return type == BSONType::String || type == BSONType::Object || type == BSONType::Array;
}
/**
* Appends 'elt' to 'out' with an empty field name, converting strings to comparison keys
* generated by 'collator' if necessary.
*/
static void collationAwareIndexKeyAppend(BSONElement elt,
const CollatorInterface* collator,
BSONObjBuilder* out);
};
} // namespace mongo
|
