blob: 947394f3bf6aaba6353cb9864f8914fda2c40278 (
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
|
<?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 OCA\FullTextSearch\Model\DocumentAccess;
use OCA\FullTextSearch\Model\Index;
use OCA\FullTextSearch\Model\IndexDocument;
use OCA\FullTextSearch\Model\Runner;
use OCA\FullTextSearch\Model\SearchRequest;
use OCA\FullTextSearch\Model\SearchResult;
interface IFullTextSearchPlatform {
/**
* must returns a unique Id
*
* @return string
*/
public function getId();
/**
* @return string
*/
public function getName();
/**
* @return array
*/
public function getConfiguration();
/**
* @param Runner $runner
*/
public function setRunner(Runner $runner);
/**
* Load the search platform
*/
public function loadPlatform();
/**
* test the search platform
*/
public function testPlatform();
/**
* Init an index regarding a provider
*/
public function initializeIndex();
/**
* Reset the indexes
*
* @param string $providerId
*/
public function resetIndex($providerId);
/**
* Reset indexes
*
* @param Index[] $indexes
*/
public function deleteIndexes($indexes);
// DEPRECATED !
// /**
// * $command can be null. instanceof ExtendedBase if the method is called from CLI.
// * Use it to echo whatever and intercept ^C
// *
// * @deprecated
// * @param IFullTextSearchProvider $provider
// * @param IndexDocument[] $documents
// *
// * @return Index[]
// */
// public function indexDocuments(IFullTextSearchProvider $provider, $documents);
/**
* @param IFullTextSearchProvider $provider
* @param IndexDocument $document
*
* @return Index
*/
public function indexDocument(IFullTextSearchProvider $provider, IndexDocument $document);
/**
* @param IFullTextSearchProvider $provider
* @param DocumentAccess $access
* @param SearchRequest $request
*
* @return SearchResult
*/
public function searchDocuments(
IFullTextSearchProvider $provider, DocumentAccess $access, SearchRequest $request
);
// /**
// * @param SearchRequest $request
// * @param DocumentAccess $access
// * @param SearchResult $result
// *
// * @return SearchResult
// */
// public function searchRequest(SearchResult $result, DocumentAccess $access);
// /**
// * @param string $providerId
// * @param string $documentId
// *
// * @return IndexDocument
// */
// public function getDocument($providerId, $documentId);
}
|
