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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
use crate::core::index::index_reader::{
IndexReader, IndexReaderContextKind, IndexReaderContextType,
};
use crate::core::search::index_searcher::IndexSearcher;
use crate::core::util::error::lucene_error::Result;
use std::marker::PhantomData;
use std::sync::Arc;
#[cfg(test)]
use crate::test_framework::core::search::test_lru_query_cache::CachingSearcherFactory;
#[cfg(test)]
use crate::test_framework::core::search::test_searcher_manager::{
BlockingSearcherFactory, EvilSearcherFactory, TrackingSearcherFactory, WarmingSearcherFactory,
};
/// Factory used by [`SearcherManager`](crate::core::search::searcher_manager::SearcherManager) to create new [`IndexSearcher`] instances. The default
/// implementation just creates an [`IndexSearcher`] with no custom behavior:
///
/// ```text
/// fn new_searcher<IR>(
/// reader: Arc<IR>,
/// _previous_reader: Option<&Arc<IR>>,
/// ) -> Result<IndexSearcher<IndexReaderContextType<Arc<IR>>>>
/// where
/// IR: IndexReader + 'static,
/// IR::ContextKind: IndexReaderContextKind<Arc<IR>>,
/// IndexReaderContextType<Arc<IR>>: Sync + 'static,
/// {
/// IndexSearcher::new(reader.get_context()?)
/// }
/// ```
///
/// You can pass your own factory instead if you want custom behavior, such as:
///
/// - Setting a custom scoring model: [`IndexSearcher::set_similarity`]
/// - Parallel per-segment search
/// - Returning custom subclasses of [`IndexSearcher`], for example for distributed scoring
/// - Running queries to warm your [`IndexSearcher`] before it is used. Note: when using
/// near-realtime search you may also want to warm newly merged segments in the background,
/// outside of the reopen path.
///
/// @lucene.experimental
pub struct SearcherFactory<IR> {
hook: SearcherFactoryHook<IR>,
}
pub(crate) enum SearcherFactoryHook<IR> {
Default(PhantomData<fn() -> IR>),
#[cfg(test)]
Warming(WarmingSearcherFactory),
#[cfg(test)]
Blocking(BlockingSearcherFactory),
#[cfg(test)]
Evil(EvilSearcherFactory<Arc<IR>>),
#[cfg(test)]
Tracking(TrackingSearcherFactory<IR>),
#[cfg(test)]
CachingRandom(CachingSearcherFactory),
}
impl<IR> Default for SearcherFactoryHook<IR> {
fn default() -> Self {
Self::Default(PhantomData)
}
}
pub(crate) struct SearcherFactoryDefaults;
pub(crate) trait SearcherFactoryBase<IR>
where
IR: IndexReader + 'static,
IR::ContextKind: IndexReaderContextKind<Arc<IR>>,
IndexReaderContextType<Arc<IR>>: Sync + 'static,
{
fn new_searcher(
&self,
reader: Arc<IR>,
previous_reader: Option<&Arc<IR>>,
) -> Result<IndexSearcher<IndexReaderContextType<Arc<IR>>>> {
SearcherFactoryDefaults::new_searcher(reader, previous_reader)
}
}
impl<IR> SearcherFactoryBase<IR> for SearcherFactoryHook<IR>
where
IR: IndexReader + 'static,
IR::ContextKind: IndexReaderContextKind<Arc<IR>>,
IndexReaderContextType<Arc<IR>>: Sync + 'static,
{
fn new_searcher(
&self,
reader: Arc<IR>,
previous_reader: Option<&Arc<IR>>,
) -> Result<IndexSearcher<IndexReaderContextType<Arc<IR>>>> {
match self {
Self::Default(_) => SearcherFactoryDefaults::new_searcher(reader, previous_reader),
#[cfg(test)]
Self::Warming(factory) => factory.new_searcher(reader, previous_reader),
#[cfg(test)]
Self::Blocking(factory) => factory.new_searcher(reader, previous_reader),
#[cfg(test)]
Self::Evil(factory) => factory.new_searcher(reader, previous_reader),
#[cfg(test)]
Self::Tracking(factory) => factory.new_searcher(reader, previous_reader),
#[cfg(test)]
Self::CachingRandom(factory) => factory.new_searcher(reader, previous_reader),
}
}
}
impl<IR> Default for SearcherFactory<IR> {
fn default() -> Self {
Self::new()
}
}
impl<IR> SearcherFactory<IR> {
pub fn new() -> Self {
Self::with_hook(SearcherFactoryHook::default())
}
pub(crate) fn with_hook(hook: SearcherFactoryHook<IR>) -> Self {
Self { hook }
}
/// Returns a new [`IndexSearcher`] over the given reader.
///
/// `previous_reader` is the reader previously used to create a new searcher. It is `None` if
/// unknown or if `reader` is the initially opened reader. When it is present, it can be used to
/// find newly opened segments compared to the new reader and warm the searcher before returning.
pub fn new_searcher(
&self,
reader: Arc<IR>,
previous_reader: Option<&Arc<IR>>,
) -> Result<IndexSearcher<IndexReaderContextType<Arc<IR>>>>
where
IR: IndexReader + 'static,
IR::ContextKind: IndexReaderContextKind<Arc<IR>>,
IndexReaderContextType<Arc<IR>>: Sync + 'static,
{
<SearcherFactoryHook<IR> as SearcherFactoryBase<IR>>::new_searcher(
&self.hook,
reader,
previous_reader,
)
}
}
impl SearcherFactoryDefaults {
/// Returns a new [`IndexSearcher`] over the given reader.
///
/// # Parameters
/// - `reader`: the reader to create a new searcher for.
/// - `_previous_reader`: the reader previously used to create a new searcher. It is `None` if
/// unknown or if `reader` is the initially opened reader. When it is present, it can be used to
/// find newly opened segments compared to the new reader and warm the searcher before
/// returning.
pub(crate) fn new_searcher<IR>(
reader: Arc<IR>,
_previous_reader: Option<&Arc<IR>>,
) -> Result<IndexSearcher<IndexReaderContextType<Arc<IR>>>>
where
IR: IndexReader + 'static,
IR::ContextKind: IndexReaderContextKind<Arc<IR>>,
IndexReaderContextType<Arc<IR>>: 'static,
{
IndexSearcher::new(reader.get_context()?)
}
}