1 /***
2 * Copyright (C) 2008 Jeremy Thomerson (jthomerson@users.sourceforge.net)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.vcaperture.services;
18
19 import net.sf.vcaperture.model.AbstractRepository;
20 import net.sf.vcaperture.model.Revision;
21 import net.sf.vcaperture.model.SearchQuery;
22 import net.sf.vcaperture.model.SearchResults;
23
24 /***
25 * Provides search and indexing functionality for repositories.
26 *
27 * @author Jeremy Thomerson (jthomerson@users.sourceforge.net)
28 */
29 public interface ISearchService {
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 String TYPE_REVISION = "revision";
48 String TYPE_FILE = "file";
49
50 String FIELD_TYPE = "type";
51 String FIELD_NAME = "name";
52 String FIELD_AUTHOR = "author";
53 String FIELD_DATE = "date";
54 String FIELD_MESSAGE = "message";
55 String FIELD_REVISION = "revision";
56 String FIELD_CONTENTS = "contents";
57
58 String getLastProcessedRevision(AbstractRepository repo);
59
60 void indexRevision(AbstractRepository repo, Revision rev);
61
62 SearchResults search(SearchQuery query);
63 }