net.sf.mmm.search.view.base

Class SearchViewRequestParametersBean

java.lang.Object

net.sf.mmm.search.view.base.SearchViewRequestParametersBean

All Implemented Interfaces:

SearchViewRequestParameters

public class SearchViewRequestParametersBean
extends Object
implements SearchViewRequestParameters

This class contains represents the context of a search-request.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private int	hitsPerPage
private int	pageNumber
private javax.servlet.ServletRequest	servletRequest
private int	totalHitCount

Fields inherited from interface net.sf.mmm.search.view.api.SearchViewRequestParameters

PARAMETER_CREATOR, PARAMETER_HITS_PER_PAGE, PARAMETER_ID, PARAMETER_PAGE, PARAMETER_QUERY, PARAMETER_SOURCE, PARAMETER_TITLE, PARAMETER_TOTAL_HIT_COUNT, PARAMETER_TYPE

Constructor Summary

Constructors

Constructor and Description
SearchViewRequestParametersBean(javax.servlet.ServletRequest request) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCreator() This method gets the creator from the request parameters.
int	getHitsPerPage() This method gets the number of hits per page from the request parameters.
String	getId() This method gets the ID from the request parameters.
int	getPageNumber() This method gets the page-index from the request parameters.
private String	getParameter(String name) This method gets the parameter with the given name from the request.
private int	getParameterAsInt(String name, int defaultValue, int minimum, int maximum) This method gets the parameter with the given name from the request.
String	getQuery() This method gets the query from the request parameters.
javax.servlet.ServletRequest	getServletRequest() This method gets the ServletRequest.
String	getSource() This method gets the source from the request parameters.
String	getTitle() This method gets the title from the request parameters.
int	getTotalHitCount() This method gets the total number of hits from the request parameters.
String	getType() This method gets the type from the request parameters.

Methods inherited from class java.lang.Object

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

Field Detail

servletRequest

private final javax.servlet.ServletRequest servletRequest

See Also:

getServletRequest()

pageNumber

private int pageNumber

See Also:

getPageNumber()

hitsPerPage

private int hitsPerPage

See Also:

getHitsPerPage()

totalHitCount

private int totalHitCount

See Also:

getTotalHitCount()

Constructor Detail

SearchViewRequestParametersBean

public SearchViewRequestParametersBean(javax.servlet.ServletRequest request)

The constructor.

Parameters:

request - is the servlet request.

Method Detail

getParameter

private String getParameter(String name)

This method gets the parameter with the given name from the request.

Parameters:

name - is the name of the requested parameter.

Returns:

the parameter as trimmed string. If the parameter is NOT set, the empty string is returned.

getParameterAsInt

private int getParameterAsInt(String name,
                              int defaultValue,
                              int minimum,
                              int maximum)

This method gets the parameter with the given name from the request.

Parameters:

name - is the name of the requested parameter.

defaultValue - is returned if the parameter is NOT set or invalid.

minimum - is the minimum allowed value.

maximum - is the maximum allowed value.

Returns:

the parameter as integer. If the parameter is NOT set, the defaultValue is returned.

getServletRequest

public javax.servlet.ServletRequest getServletRequest()

This method gets the ServletRequest.
NOTE:
This method is only for very specific cases.

Returns:

the servletRequest

getPageNumber

public int getPageNumber()

This method gets the page-index from the request parameters.

Specified by:

getPageNumber in interface SearchViewRequestParameters

Returns:

the pageNumber. Will be 0 if NOT set in request.

getHitsPerPage

public int getHitsPerPage()

This method gets the number of hits per page from the request parameters.

Specified by:

getHitsPerPage in interface SearchViewRequestParameters

Returns:

the hitsPerPage. Will be SearchResultPage.DEFAULT_HITS_PER_PAGE if NOT set in request.

getTotalHitCount

public int getTotalHitCount()

This method gets the total number of hits from the request parameters.

Specified by:

getTotalHitCount in interface SearchViewRequestParameters

Returns:

the totalHitCount or -1 if NOT set in request.

getQuery

public String getQuery()

This method gets the query from the request parameters.

Specified by:

getQuery in interface SearchViewRequestParameters

Returns:

the query. Will be the empty string if NOT set in request.

getSource

public String getSource()

This method gets the source from the request parameters.

Specified by:

getSource in interface SearchViewRequestParameters

Returns:

the source. Will be the empty string if NOT set in request.

getCreator

public String getCreator()

This method gets the creator from the request parameters.

Specified by:

getCreator in interface SearchViewRequestParameters

Returns:

the creator. Will be the empty string if NOT set in request.

getTitle

public String getTitle()

This method gets the title from the request parameters.

Specified by:

getTitle in interface SearchViewRequestParameters

Returns:

the title. Will be the empty string if NOT set in request.

getType

public String getType()

This method gets the type from the request parameters.

Specified by:

getType in interface SearchViewRequestParameters

Returns:

the type. Will be the empty string if NOT set in request.

getId

public String getId()

This method gets the ID from the request parameters.

Specified by:

getId in interface SearchViewRequestParameters

Returns:

the id. Will be the empty string if NOT set in request.