net.sf.mmm.search.engine.base

Class AbstractSearchResult

java.lang.Object

net.sf.mmm.search.engine.base.AbstractSearchResult

All Implemented Interfaces:

SearchResult

public abstract class AbstractSearchResult
extends Object
implements SearchResult

This is the abstract base implementation of the SearchResult interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	query

Constructor Summary

Constructors

Constructor and Description
AbstractSearchResult(String searchQuery) The constructor.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.search.engine.api.SearchResult

getHit, getHitCount

Field Detail

query

private final String query

See Also:

getQuery()

Constructor Detail

AbstractSearchResult

public AbstractSearchResult(String searchQuery)

The constructor.

Parameters:

searchQuery - is the query that caused this result.

Method Detail

getQuery

public String getQuery()

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

Specified by:

getQuery in interface SearchResult

Returns:

the original query string.

getPageCount

public 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.

Specified by:

getPageCount in interface SearchResult

Returns:

the number of pages.

See Also:

SearchResult.getPageCount(int)

getPageCount

public 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.

Specified by:

getPageCount in interface SearchResult

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

public 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.

Specified by:

getPage in interface SearchResult

Parameters:

pageIndex - is the page index of the requested search result. This should be in the range from 0 to SearchResult.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

public SearchResultPage getPage(int pageIndex,
                                int hitsPerPage)

This method gets the page of this search-result at the given pageIndex using the given hitsPerPage. This method is a simple implementation of this method. Please override if there is a more efficient way to do this.

Specified by:

getPage in interface SearchResult

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)