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.lucene.engine;
18:
19: import org.apache.lucene.search.Explanation;
20: import org.apache.lucene.search.Hits;
21: import org.compass.core.engine.SearchEngineException;
22: import org.compass.core.engine.SearchEngineHits;
23:
24: /**
25: * A Lucene specific extension to search engine hits. Allows to
26: * get and execute Lucene specific operations.
27: *
28: * @author kimchy
29: */
30: public interface LuceneSearchEngineHits extends SearchEngineHits,
31: LuceneDelegatedClose {
32:
33: /**
34: * Returns the actual Lucene hits.
35: */
36: Hits getHits();
37:
38: /**
39: * Returns Lucene Explanation for hit number i.
40: */
41: Explanation explain(int i) throws SearchEngineException;
42: }
|