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
|
/*
* 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.
*/
package org.apache.tuscany.sca.domain.search;
import java.io.IOException;
import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.search.Query;
import org.apache.tuscany.sca.contribution.Contribution;
import org.osoa.sca.annotations.Remotable;
/**
* This is the interface that must be implemented by the service that provides
* the functionality index/search and search contribution data.
*
* @version $Rev$ $Date$
*/
@Remotable
public interface DomainSearch {
/**
* Returns <code>true</code> if the index is somehow created already, otherwise <code>false</code>.
*
* @return <code>true</code> if the index is somehow created already, otherwise <code>false</code>
*/
boolean indexExists();
/**
* Parse a query string, execute it against the index and return the results.
*
* @param searchQuery the string containing the search query
* @param highlight <code>true</code> if the results should be highlighted
*
* @return an array containing the search results
*
* @throws CorruptIndexException
* @throws IOException
* @throws ParseException
*/
Result[] parseAndSearch(String searchQuery, boolean highlight) throws IndexException, ParseException;
/**
* Executes a search query against the index and return the results.
*
* @param searchQuery the search query
* @param hightlight highlight <code>true</code> if the results should be highlighted
*
* @return an array containing the search results
*
* @throws CorruptIndexException
* @throws IOException
*/
Result[] search(Query searchQuery, boolean hightlight) throws IndexException;
/**
* Highlights in the specified text strings that matches the specified search query. The matches can be filtered by field.
*
* @param field the field to filter
* @param text the text to be highlighted
* @param searchQuery the search query
*
* @return the text highlighted
*
* @throws ParseException
* @throws IOException
*/
String highlight(String field, String text, String searchQuery) throws ParseException;
/**
* Adds a contribution to the index.
*
* @param contribution the contribution to be added
*/
void addContribution(Contribution contribution) throws IndexException;
/**
* Removes a contribution from the index.
*
* @param contribution the contribution to be removed
*/
void removeContribution(Contribution contribution) throws IndexException;
/**
* Updates a contribution in the index.
*
* @param oldContribution the old contribution state
* @param contribution the new contribution state
*/
void updateContribution(Contribution oldContribution, Contribution contribution) throws IndexException;
}
|
