net.sf.mmm.search.engine.base

Class AbstractSearchResultPage

java.lang.Object

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

All Implemented Interfaces:

Iterable<SearchHit>, SearchResultPage

Direct Known Subclasses:

SearchResultPageImpl

public abstract class AbstractSearchResultPage
extends Object
implements SearchResultPage

This is the abstract base implementation of the SearchResultPage interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractSearchResultPage.HitIterator This inner class is used to iterate the hits.

Field Summary

Fields

Modifier and Type	Field and Description
private int	hitsPerPage
private int	pageCount
private int	pageIndex
private String	query
private int	totalHitCount

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

DEFAULT_HITS_PER_PAGE

Constructor Summary

Constructors

Constructor and Description
AbstractSearchResultPage(String searchQuery, int totalHits, int hitPerPage, int pageNumber) The constructor.

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.
int	getPageIndex() This method gets the index of the page represented by this search result, where 0 is the first page and SearchResultPage.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.
Iterator<SearchHit>	iterator()

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

getPageHit, getPageHitCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

query

private final String query

See Also:

getQuery()

totalHitCount

private final int totalHitCount

See Also:

getTotalHitCount()

hitsPerPage

private final int hitsPerPage

See Also:

getHitsPerPage()

pageCount

private final int pageCount

See Also:

getPageCount()

pageIndex

private final int pageIndex

See Also:

getPageIndex()

Constructor Detail

AbstractSearchResultPage

public AbstractSearchResultPage(String searchQuery,
                                int totalHits,
                                int hitPerPage,
                                int pageNumber)

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.

Method Detail

getHitsPerPage

public int getHitsPerPage()

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

Specified by:

getHitsPerPage in interface SearchResultPage

Returns:

the number of hits per page.

See Also:

SearchResultPage.DEFAULT_HITS_PER_PAGE

getPageCount

public int getPageCount()

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

Specified by:

getPageCount in interface SearchResultPage

Returns:

the number of pages.

getPageIndex

public int getPageIndex()

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

Specified by:

getPageIndex in interface SearchResultPage

Returns:

the index of the page represented by this result.

getQuery

public String getQuery()

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

Specified by:

getQuery in interface SearchResultPage

Returns:

the original query string.

getTotalHitCount

public int getTotalHitCount()

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

Specified by:

getTotalHitCount in interface SearchResultPage

Returns:

the total number of hits.

getHitStartNumber

public int getHitStartNumber()

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

 SearchResultPage.getPageIndex() * SearchResultPage.getHitsPerPage() + 1
 

Specified by:

getHitStartNumber in interface SearchResultPage

Returns:

the number of the first hit of this page.

getHitEndNumber

public int getHitEndNumber()

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

 SearchResultPage.getHitStartNumber() + SearchResultPage.getPageHitCount()
 

Specified by:

getHitEndNumber in interface SearchResultPage

Returns:

the number of the last hit of this page.

getPagingStartIndex

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

Specified by:

getPagingStartIndex in interface SearchResultPage

Parameters:

pagingRange - the number of paging links forward and backwards.

Returns:

the page-index to start paging with.

See Also:

SearchResultPage.getPagingEndIndex(int)

getPagingEndIndex

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

Specified by:

getPagingEndIndex in interface SearchResultPage

Parameters:

pagingRange - the number of paging links forward and backwards.

Returns:

the page-index to end paging with.

See Also:

SearchResultPage.getPagingStartIndex(int)

iterator

public Iterator<SearchHit> iterator()

Specified by:

iterator in interface Iterable<SearchHit>