org.compass.core.lucene.engine
Class AbstractLuceneSearchEngineHits

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

All Implemented Interfaces:

SearchEngineHits, LuceneDelegatedClose

Direct Known Subclasses:

EmptyLuceneSearchEngineHits, LuceneSearchEngineHits

public abstract class AbstractLuceneSearchEngineHits
extends Object
implements SearchEngineHits, LuceneDelegatedClose

Author:

kimchy

Field Summary

protected boolean	closed
protected List	indexHolders
protected LuceneSearchEngineQuery	query
protected LuceneSearchEngine	searchEngine

Constructor Summary

AbstractLuceneSearchEngineHits()

Method Summary

void	close() Closes the hits object.
SearchEngineHighlighter	getHighlighter() Returns an highlighter for the hits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compass.core.engine.SearchEngineHits

getLength, getResource, score

Field Detail

searchEngine

protected LuceneSearchEngine searchEngine

indexHolders

protected List indexHolders

query

protected LuceneSearchEngineQuery query

closed

protected boolean closed

Constructor Detail

AbstractLuceneSearchEngineHits

public AbstractLuceneSearchEngineHits()

Method Detail

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

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