net.sf.mmm.search.engine.api

Interface SearchResult

All Known Implementing Classes:

AbstractSearchResult

public interface SearchResult

This is the interface for the complete result of a search.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchResultPage

Method Summary

Modifier and Type	Method and Description
SearchHit	getHit(int index) This method gets the hit at the given index.
int	getHitCount() This method gets the total number of hits for this search-result.
SearchResultPage	getPage(int pageIndex) This method gets the page of this search-result at the given pageIndex using the default number of hits per page.
SearchResultPage	getPage(int pageIndex, int hitsPerPage) This method gets the page of this search-result at the given pageIndex using the given hitsPerPage.
int	getPageCount() This method gets the number of pages used to split the total hits using the default number of hits per page.
int	getPageCount(int hitsPerPage) This method gets number of pages used to split the total hits using the given hitsPerPage.
String	getQuery() This method gets the original query string that produced this result.

Method Detail

getQuery

String getQuery()

This method gets the original query string that produced this result.

Returns:

the original query string.

getHitCount

int getHitCount()

This method gets the total number of hits for this search-result.

Returns:

the total number of hits.

getHit

SearchHit getHit(int index)

This method gets the hit at the given index.

Parameters:

index - is the index of the requested hit. It has to be in the range from 0 to getHitCount() - 1.

Returns:

the requested hit.

getPageCount

int getPageCount()

This method gets the number of pages used to split the total hits using the default number of hits per page. An empty search result will have one empty page.

Returns:

the number of pages.

See Also:

getPageCount(int)

getPageCount

int getPageCount(int hitsPerPage)

This method gets number of pages used to split the total hits using the given hitsPerPage. An empty search result will have one empty page.

Parameters:

hitsPerPage - is the desired number of hits per page. This should be a value like 5, 10, 20, 30, ..., 100.

Returns:

the number of pages required to split the total hits.

getPage

SearchResultPage getPage(int pageIndex)

This method gets the page of this search-result at the given pageIndex using the default number of hits per page.

Parameters:

pageIndex - is the page index of the requested search result. This should be in the range from 0 to getPageCount() - 1.
It can NOT be guaranteed that the pageIndex is always valid in the sense as described above (the search index may have been modified in the meantime). An implementation has to be able to handle calls with a pageIndex greater or equal to SearchResultPage.getPageCount(). The recommended strategy is to return the last page in this case.

Returns:

the requested page.

See Also:

SearchEngine.search(SearchQuery, int)

getPage

SearchResultPage getPage(int pageIndex,
                         int hitsPerPage)

This method gets the page of this search-result at the given pageIndex using the given hitsPerPage.

Parameters:

pageIndex - is the page index of the requested search result. This should be in the range from 0 to getPageCount(hitsPerPage) - 1 .
It can NOT be guaranteed that the pageIndex is always valid in the sense as described above (the search index may have been modified in the meantime). An implementation has to be able to handle calls with a pageIndex greater or equal to SearchResultPage.getPageCount(). The recommended strategy is to return the last page in this case.

hitsPerPage - is the number of hits contained in a SearchResultPage.

Returns:

the requested page.

See Also:

SearchEngine.search(SearchQuery, int)