net.sf.mmm.search.engine.api

Interface SearchResultPage

All Superinterfaces:

Iterable<SearchHit>

All Known Implementing Classes:

AbstractSearchResultPage, SearchResultPageImpl

public interface SearchResultPage
extends Iterable<SearchHit>

This is the interface for a page of a search-result. The total hits are split into pages from 0 to getPageCount() - 1. This instance is the getPageIndex().th page and has getPageHitCount() hits that can be accessed via getPageHit(int). They represent the hits from getPageCount()*getHitsPerPage() to getPageCount()*getHitsPerPage()+getPageHitCount()-1
You can NOT access hits out of the scope the page represented by this search result. To get hits of a previous or next page, you have to perform a new search.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HITS_PER_PAGE The default number of hits per page.

Method Summary

Modifier and Type	Method and Description
int	getHitEndNumber() This method gets the absolute number of the last hit of this page.
int	getHitsPerPage() This method gets the number of hits per page.
int	getHitStartNumber() This method gets the absolute number of the first hit of this page.
int	getPageCount() This method gets the number of pages used to split the total hits.
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.
int	getPageIndex() This method gets the index of the page represented by this search result, where 0 is the first page and getPageCount() - 1 is the last page.
int	getPagingEndIndex(int pagingRange) This method gets the page-index of the end page when a number (pagingRange*2)+1 links should be rendered for paging.
int	getPagingStartIndex(int pagingRange) This method gets the page-index of the start page when a number (pagingRange*2)+1 links should be rendered for paging.
String	getQuery() This method gets the original query string that produced this result.
int	getTotalHitCount() This method gets the total number of hits for this query.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

DEFAULT_HITS_PER_PAGE

static final int DEFAULT_HITS_PER_PAGE

The default number of hits per page.

See Also:

Constant Field Values

Method Detail

getQuery

String getQuery()

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

Returns:

the original query string.

getTotalHitCount

int getTotalHitCount()

This method gets the total number of hits for this query.

Returns:

the total number of hits.

getHitsPerPage

int getHitsPerPage()

This method gets the number of hits per page. The last page may have less hits than this value.

Returns:

the number of hits per page.

See Also:

DEFAULT_HITS_PER_PAGE

getPageCount

int getPageCount()

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

Returns:

the number of pages.

getPageIndex

int getPageIndex()

This method gets the index of the page represented by this search result, where 0 is the first page and getPageCount() - 1 is the last page.

Returns:

the index of the page represented by this result.

getHitStartNumber

int getHitStartNumber()

This method gets the absolute number of the first hit of this page. This is the same as:

 getPageIndex() * getHitsPerPage() + 1
 

Returns:

the number of the first hit of this page.

getHitEndNumber

int getHitEndNumber()

This method gets the absolute number of the last hit of this page. This is the same as:

 getHitStartNumber() + getPageHitCount()
 

Returns:

the number of the last hit of this page.

getPageHitCount

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.

getPageHit

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 getPageIndex()*getHitsPerPage()+index.

Parameters:

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

Returns:

the requested hit.

getPagingStartIndex

int getPagingStartIndex(int pagingRange)

This method gets the page-index of the start page when a number (pagingRange*2)+1 links should be rendered for paging. The pagingRange actually specifies the number of links forward and backwards.
The number of result-pages is potentially NOT limited. To avoid that your GUI layout gets broken by too many paging links, you can use this method to render a fixed number of paging links.
E.g. assume pagingCount is 2 and you would have a page-count of e.g. 10. Then you would render links for visiting the pages from 0 to 4 if your page-index is 0,1 , or 2. For a page-index of 3, you would render the links from 1 to 5 and so on.
The calculation is performed per call so avoid multiple calls of this method if possible.

Parameters:

pagingRange - the number of paging links forward and backwards.

Returns:

the page-index to start paging with.

See Also:

getPagingEndIndex(int)

getPagingEndIndex

int getPagingEndIndex(int pagingRange)

This method gets the page-index of the end page when a number (pagingRange*2)+1 links should be rendered for paging. The pagingRange actually specifies the number of links forward and backwards.
The number of result-pages is potentially NOT limited. To avoid that your GUI layout gets broken by too many paging links, you can use this method to render a fixed number of paging links.
E.g. assume pagingCount is 2 and you would have a page-count of e.g. 10. Then you would render links for visiting the pages from 5 to 9 if your page-index is 7,8 , or 9. For a page-index of 6, you would render the links from 4 to 8 and so on.
The calculation is performed per call so avoid multiple calls of this method if possible.

Parameters:

pagingRange - the number of paging links forward and backwards.

Returns:

the page-index to end paging with.

See Also:

getPagingStartIndex(int)