01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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 org.compass.core.engine;
18:
19: import org.compass.core.Resource;
20:
21: /**
22: * Holds hits returned by a find operation of a search engine.
23: *
24: * @see SearchEngineQuery#hits()
25: *
26: * @author kimchy
27: */
28: public interface SearchEngineHits {
29:
30: /**
31: * Returns that maps to the n'th hit.
32: */
33: Resource getResource(int n) throws SearchEngineException;
34:
35: /**
36: * Returns the number of hits.
37: */
38: int getLength();
39:
40: /**
41: * Returns the score of the n'th hit. Can be a value between 0 and 1,
42: * normalised by the highest scoring hit.
43: */
44: float score(int i) throws SearchEngineException;
45:
46: /**
47: * Returns an highlighter for the hits.
48: */
49: SearchEngineHighlighter getHighlighter()
50: throws SearchEngineException;
51:
52: /**
53: * Closes the hits object. Note that it is an optional operation since it
54: * will be closed transperantly when the transaction is closed.
55: * <p>
56: * It is provided for more controlled resource management
57: * </p>
58: */
59: void close() throws SearchEngineException;
60: }
|