lumis.search
Class SearchResults

java.lang.Object
  lumis.search.SearchResults

Direct Known Subclasses:

LuceneSearchResults

@StableMinor(version="4.1",
             sinceVersion="4.0")
public abstract class SearchResults
extends Object

Represents a collection of hits returned by a query execution.

Since:

4.0.4

Constructor Summary

SearchResults()

Method Summary

abstract SearchAttributes	getAttributes() Returns the result's attributes.
abstract SearchHit	getHit(int hitIndex) Returns a hit of the collection.
abstract 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

Constructor Detail

SearchResults

public SearchResults()

Method Detail

getHitCount

public abstract int getHitCount()

Returns the number of hits in the collection.

Returns:

the number of hits in the collection.

Since:

4.0.4

getHit

public abstract SearchHit getHit(int hitIndex)
                          throws IndexOutOfBoundsException,
                                 PortalException

Returns a hit of the collection.

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

Since:

4.0.4

getAttributes

public abstract SearchAttributes getAttributes()

Returns the result's attributes.

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

Returns:

the result's attributes.

Since:

4.0.4