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
|
// Copyright (C) 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef ICING_QUERY_QUERY_PROCESSOR_H_
#define ICING_QUERY_QUERY_PROCESSOR_H_
#include <memory>
#include "icing/text_classifier/lib3/utils/base/statusor.h"
#include "icing/index/index.h"
#include "icing/index/iterator/doc-hit-info-iterator-filter.h"
#include "icing/index/iterator/doc-hit-info-iterator.h"
#include "icing/proto/search.pb.h"
#include "icing/query/query-terms.h"
#include "icing/schema/schema-store.h"
#include "icing/store/document-store.h"
#include "icing/tokenization/language-segmenter.h"
#include "icing/transform/normalizer.h"
namespace icing {
namespace lib {
// Processes SearchSpecProtos and retrieves the specified DocHitInfos that
// satisfies the query and its restrictions. This does not perform any scoring,
// and returns matched documents in a descending DocumentId order.
class QueryProcessor {
public:
// Factory function to create a QueryProcessor which does not take ownership
// of any input components, and all pointers must refer to valid objects that
// outlive the created QueryProcessor instance.
//
// Returns:
// An QueryProcessor on success
// FAILED_PRECONDITION if any of the pointers is null.
static libtextclassifier3::StatusOr<std::unique_ptr<QueryProcessor>> Create(
Index* index, const LanguageSegmenter* language_segmenter,
const Normalizer* normalizer, const DocumentStore* document_store,
const SchemaStore* schema_store);
struct QueryResults {
std::unique_ptr<DocHitInfoIterator> root_iterator;
// A map from section names to sets of terms restricted to those sections.
// Query terms that are not restricted are found at the entry with key "".
SectionRestrictQueryTermsMap query_terms;
// Hit iterators for the text terms in the query. These query_term_iterators
// are completely separate from the iterators that make the iterator tree
// beginning with root_iterator.
std::unordered_map<std::string, std::unique_ptr<DocHitInfoIterator>>
query_term_iterators;
};
// Parse the search configurations (including the query, any additional
// filters, etc.) in the SearchSpecProto into one DocHitInfoIterator.
//
// Returns:
// On success,
// - One iterator that represents the entire query
// - A map representing the query terms and any section restrictions
// INVALID_ARGUMENT if query syntax is incorrect and cannot be tokenized
// INTERNAL_ERROR on all other errors
libtextclassifier3::StatusOr<QueryResults> ParseSearch(
const SearchSpecProto& search_spec);
private:
explicit QueryProcessor(Index* index,
const LanguageSegmenter* language_segmenter,
const Normalizer* normalizer,
const DocumentStore* document_store,
const SchemaStore* schema_store);
// Parse the query into a one DocHitInfoIterator that represents the root of a
// query tree.
//
// Returns:
// On success,
// - One iterator that represents the entire query
// - A map representing the query terms and any section restrictions
// INVALID_ARGUMENT if query syntax is incorrect and cannot be tokenized
// INTERNAL_ERROR on all other errors
libtextclassifier3::StatusOr<QueryResults> ParseRawQuery(
const SearchSpecProto& search_spec);
// Return the options for the DocHitInfoIteratorFilter based on the
// search_spec.
DocHitInfoIteratorFilter::Options getFilterOptions(
const SearchSpecProto& search_spec);
// Not const because we could modify/sort the hit buffer in the lite index at
// query time.
Index& index_;
const LanguageSegmenter& language_segmenter_;
const Normalizer& normalizer_;
const DocumentStore& document_store_;
const SchemaStore& schema_store_;
};
} // namespace lib
} // namespace icing
#endif // ICING_QUERY_QUERY_PROCESSOR_H_
|
