blob: 57089ba12910f24bb53f4b6c95a0b27a0d63552a (
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
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
|
<?php
/**
* FullTextSearch - Full text search framework for Nextcloud
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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/>.
*
*/
namespace OCA\FullTextSearch;
use OC\User\NoUserException;
use OCA\FullTextSearch\Model\Index;
use OCA\FullTextSearch\Model\IndexDocument;
use OCA\FullTextSearch\Model\IndexOptions;
use OCA\FullTextSearch\Model\Runner;
use OCA\FullTextSearch\Model\SearchRequest;
use OCA\FullTextSearch\Model\SearchResult;
interface IFullTextSearchProvider {
/**
* return a unique Id of the Provider
*
* @return string
*/
public function getId();
/**
* return a display name of the Provider
*
* @return string
*/
public function getName();
/**
* @return array
*/
public function getConfiguration();
/**
* @return array|string
*/
public function getOptionsTemplate();
/**
* Called when loading the provider
*/
public function loadProvider();
/**
* @param Runner $runner
*/
public function setRunner(Runner $runner);
// /**
// * @param IndexOptions $options
// */
// public function setIndexOptions($options);
/**
* returns all indexable document for a user.
* There is no need to fill the document with content at this point.
*
* @param string $userId
*
* @return IndexDocument[]
*/
public function generateIndexableDocuments($userId);
/**
* fill a chunk of documents with more content, prior to index.
*
* @deprecated
*
* @param IndexDocument[] $chunk
*
* @return IndexDocument[]
*/
public function fillIndexDocuments($chunk);
/**
* fill document with more content, prior to index.
*
* @param IndexDocument $document
*/
// public function fillIndexDocument($document);
/**
* @param IndexDocument $document
*
* @return bool
*/
public function isDocumentUpToDate($document);
/**
* update a document regarding the current Index' status
*
* @param Index $index
*
* @return IndexDocument
* @throws NoUserException
*/
public function updateDocument(Index $index);
/**
* @param IFullTextSearchPlatform $platform
*/
public function onInitializingIndex(IFullTextSearchPlatform $platform);
/**
* @param IFullTextSearchPlatform $platform
*/
public function onResettingIndex(IFullTextSearchPlatform $platform);
/**
* before a search, improve the request
*
* @param SearchRequest $searchRequest
*/
public function improveSearchRequest(SearchRequest $searchRequest);
/**
* after a search, improve the result
*
* @param SearchResult $searchResult
*/
public function improveSearchResult(SearchResult $searchResult);
/**
* not used yet.
*/
public function unloadProvider();
}
|
