org.compass.core.lucene.engine
Class DefaultLuceneSearchEngineHits

java.lang.Object
  org.compass.core.lucene.engine.DefaultLuceneSearchEngineHits

All Implemented Interfaces:

SearchEngineHits, LuceneDelegatedClose, LuceneSearchEngineHits

public class DefaultLuceneSearchEngineHits
extends Object
implements LuceneSearchEngineHits

Author:

kimchy

Constructor Summary

DefaultLuceneSearchEngineHits(Hits hits, LuceneSearchEngine searchEngine, LuceneSearchEngineQuery query, LuceneSearchEngineInternalSearch internalSearch)

Method Summary

void	close() Closes the hits object.
Explanation	explain(int i) Returns Lucene Explanation for hit number i.
SearchEngineHighlighter	getHighlighter() Returns an highlighter for the hits.
Hits	getHits() Returns the actual Lucene hits.
int	getLength() Returns the number of hits.
Resource	getResource(int i) Returns that maps to the n'th hit.
float	score(int i) Returns the score of the n'th hit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultLuceneSearchEngineHits

public DefaultLuceneSearchEngineHits(Hits hits,
                                     LuceneSearchEngine searchEngine,
                                     LuceneSearchEngineQuery query,
                                     LuceneSearchEngineInternalSearch internalSearch)

Method Detail

getResource

public Resource getResource(int i)
                     throws SearchEngineException

Description copied from interface: SearchEngineHits

Returns that maps to the n'th hit.

Specified by:

getResource in interface SearchEngineHits

Throws:

SearchEngineException

getLength

public int getLength()

Description copied from interface: SearchEngineHits

Returns the number of hits.

Specified by:

getLength in interface SearchEngineHits

score

public float score(int i)
            throws SearchEngineException

Description copied from interface: SearchEngineHits

Returns the score of the n'th hit. Can be a value between 0 and 1, normalised by the highest scoring hit.

Specified by:

score in interface SearchEngineHits

Throws:

SearchEngineException

getHits

public Hits getHits()

Description copied from interface: LuceneSearchEngineHits

Returns the actual Lucene hits.

Specified by:

getHits in interface LuceneSearchEngineHits

getHighlighter

public SearchEngineHighlighter getHighlighter()
                                       throws SearchEngineException

Description copied from interface: SearchEngineHits

Returns an highlighter for the hits.

Specified by:

getHighlighter in interface SearchEngineHits

Throws:

SearchEngineException

explain

public Explanation explain(int i)
                    throws SearchEngineException

Description copied from interface: LuceneSearchEngineHits

Returns Lucene Explanation for hit number i.

Specified by:

explain in interface LuceneSearchEngineHits

Throws:

SearchEngineException

close

public void close()
           throws SearchEngineException

Description copied from interface: SearchEngineHits

Closes the hits object. Note that it is an optional operation since it will be closed transperantly when the transaction is closed.

It is provided for more controlled resource management

Specified by:

close in interface SearchEngineHits

Specified by:

close in interface LuceneDelegatedClose

Throws:

SearchEngineException