net.sf.mmm.search.engine.base

Class SearchResultPageImpl

java.lang.Object

net.sf.mmm.search.engine.base.AbstractSearchResultPage

net.sf.mmm.search.engine.base.SearchResultPageImpl

All Implemented Interfaces:

Iterable<SearchHit>, SearchResultPage

public class SearchResultPageImpl
extends AbstractSearchResultPage

This is the (default) implementation of the SearchResultPage interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private SearchHit[]	hits

Fields inherited from interface net.sf.mmm.search.engine.api.SearchResultPage

DEFAULT_HITS_PER_PAGE

Constructor Summary

Constructors

Constructor and Description
SearchResultPageImpl(String searchQuery, int totalHits, int hitPerPage, int pageNumber, SearchHit[] searchHits) The constructor.

Method Summary

Modifier and Type	Method and Description
SearchHit	getPageHit(int index) This method gets the hit of this page at the given index.
int	getPageHitCount() This method get the number of hits in the page represented by this search result.

Methods inherited from class net.sf.mmm.search.engine.base.AbstractSearchResultPage

getHitEndNumber, getHitsPerPage, getHitStartNumber, getPageCount, getPageIndex, getPagingEndIndex, getPagingStartIndex, getQuery, getTotalHitCount, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

hits

private final SearchHit[] hits

See Also:

getPageHit(int)

Constructor Detail

SearchResultPageImpl

public SearchResultPageImpl(String searchQuery,
                            int totalHits,
                            int hitPerPage,
                            int pageNumber,
                            SearchHit[] searchHits)

The constructor.

Parameters:

searchQuery - is the query that caused this page.

totalHits - is the total number of hits.

hitPerPage - is the number of hits per page.

pageNumber - is the index of this page.

searchHits - are the actual hits of this page.

Method Detail

getPageHit

public SearchHit getPageHit(int index)

This method gets the hit of this page at the given index.
Please note, that the index is relative to this page. The absolute index of the hit is SearchResultPage.getPageIndex()*SearchResultPage.getHitsPerPage()+index.

Parameters:

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

Returns:

the requested hit.

getPageHitCount

public int getPageHitCount()

This method get the number of hits in the page represented by this search result. The value may be less than the number of hits per page if this is the last page. The value will be greater than zero, except for the first page that may have a page hit count of 0 if the search query produced no hits.

Returns:

the number of hits in this page.