lumis.search.lucene

Class LuceneSearchResults

java.lang.Object

lumis.search.SearchResults

lumis.search.lucene.LuceneSearchResults

public class LuceneSearchResults
extends SearchResults

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchAttributes	attributes
protected org.apache.lucene.search.Hits	hits
protected HashMap<Integer,LuceneSearchHit>	searchHits

Constructor Summary

Constructors

Constructor and Description
LuceneSearchResults(org.apache.lucene.search.Hits hits)

Method Summary

Methods

Modifier and Type	Method and Description
SearchAttributes	getAttributes() Returns the result's attributes.
SearchHit	getHit(int hitIndex) Returns a hit of the collection.
int	getHitCount() Returns the number of hits in the collection.

Methods inherited from class java.lang.Object

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

Field Detail

hits

protected org.apache.lucene.search.Hits hits

searchHits

protected HashMap<Integer,LuceneSearchHit> searchHits

attributes

protected SearchAttributes attributes

Constructor Detail

LuceneSearchResults

public LuceneSearchResults(org.apache.lucene.search.Hits hits)

Method Detail

getHitCount

public int getHitCount()

Description copied from class: SearchResults

Returns the number of hits in the collection.

Specified by:

getHitCount in class SearchResults

Returns:

the number of hits in the collection.

getHit

public SearchHit getHit(int hitIndex)
                 throws IndexOutOfBoundsException,
                        PortalException

Description copied from class: SearchResults

Returns a hit of the collection.

Specified by:

getHit in class SearchResults

Parameters:

hitIndex - index of the hit to be returned

Returns:

the hit referent to the given index

Throws:

IndexOutOfBoundsException - if the given index is greater than the hit count

PortalException

IndexOutOfBoundsException

getAttributes

public SearchAttributes getAttributes()

Description copied from class: SearchResults

Returns the result's attributes.

Attributes contain additional information returned by the search engine in a query execution.

Specified by:

getAttributes in class SearchResults

Returns:

the result's attributes.