Package org.opencms.jsp.search.controller

Class CmsSearchControllerPagination

java.lang.Object

org.opencms.jsp.search.controller.CmsSearchControllerPagination

All Implemented Interfaces:

I_CmsSearchController, I_CmsSearchControllerPagination

public class CmsSearchControllerPagination
extends Object
implements I_CmsSearchControllerPagination

Controller for the pagination.

Field Summary

Fields inherited from interface org.opencms.jsp.search.controller.I_CmsSearchController

SET_VARIABLES

Constructor Summary

Constructors

Constructor	Description
CmsSearchControllerPagination(I_CmsSearchConfigurationPagination config)	Constructor taking a pagination configuration.

Method Summary

Modifier and Type	Method	Description
void	addParametersForCurrentState(Map<String,String[]> parameters)	Add the request parameters that reflect the controllers current state (useful for link generation outside of a form).
void	addQueryParts(CmsSolrQuery query, CmsObject cms)	Generate the Solr query part specific for the controller, e.g., the part for a field facet.
I_CmsSearchConfigurationPagination	getConfig()	Returns the configuration.
int	getCurrentPageSize()	Returns the size of the current page.
int	getCurrentPageStart()	Returns the first item to show on the current page.
I_CmsSearchStatePagination	getState()	Returns the state.
void	updateForQueryChange()	Update the controllers state in case the term that is search for (the query as given by the user) has changed.
void	updateFromRequestParameters(Map<String,String[]> parameters, boolean isReloaded)	Update the controllers state from the given request parameters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.jsp.search.controller.I_CmsSearchController

addQueryParts

Constructor Details

CmsSearchControllerPagination

public CmsSearchControllerPagination(I_CmsSearchConfigurationPagination config)

Constructor taking a pagination configuration.

Parameters:

config - The pagination configuration.

Method Details

addParametersForCurrentState

public void addParametersForCurrentState(Map<String,String[]> parameters)

Description copied from interface: I_CmsSearchController

Add the request parameters that reflect the controllers current state (useful for link generation outside of a form).

Specified by:

addParametersForCurrentState in interface I_CmsSearchController

Parameters:

parameters - The request parameters reflecting the controllers currents state.

See Also:

• I_CmsSearchController.addParametersForCurrentState(java.util.Map)

addQueryParts

public void addQueryParts(CmsSolrQuery query,
 CmsObject cms)

Description copied from interface: I_CmsSearchController

Generate the Solr query part specific for the controller, e.g., the part for a field facet.

Specified by:

addQueryParts in interface I_CmsSearchController

Parameters:

query - A, possibly empty, query, where further query parts are added

cms - the current context to resolve context-specific macros.

See Also:

• I_CmsSearchController.addQueryParts(CmsSolrQuery, CmsObject)

getConfig

public I_CmsSearchConfigurationPagination getConfig()

Description copied from interface: I_CmsSearchControllerPagination

Returns the configuration.

Specified by:

getConfig in interface I_CmsSearchControllerPagination

Returns:

The configuration.

See Also:

• I_CmsSearchControllerPagination.getConfig()

getCurrentPageSize

public int getCurrentPageSize()

Description copied from interface: I_CmsSearchControllerPagination

Returns the size of the current page.

Specified by:

getCurrentPageSize in interface I_CmsSearchControllerPagination

Returns:

the size of the current page.

See Also:

• I_CmsSearchControllerPagination.getCurrentPageSize()

getCurrentPageStart

public int getCurrentPageStart()

Description copied from interface: I_CmsSearchControllerPagination

Returns the first item to show on the current page.

Specified by:

getCurrentPageStart in interface I_CmsSearchControllerPagination

Returns:

the first item to show on the current page.

See Also:

• I_CmsSearchControllerPagination.getCurrentPageStart()

getState

public I_CmsSearchStatePagination getState()

Description copied from interface: I_CmsSearchControllerPagination

Returns the state.

Specified by:

getState in interface I_CmsSearchControllerPagination

Returns:

The state.

See Also:

• I_CmsSearchControllerPagination.getState()

updateForQueryChange

public void updateForQueryChange()

Description copied from interface: I_CmsSearchController

Update the controllers state in case the term that is search for (the query as given by the user) has changed.

Specified by:

updateForQueryChange in interface I_CmsSearchController

See Also:

• I_CmsSearchController.updateForQueryChange()

updateFromRequestParameters

public void updateFromRequestParameters(Map<String,String[]> parameters,
 boolean isReloaded)

Description copied from interface: I_CmsSearchController

Update the controllers state from the given request parameters.

Specified by:

updateFromRequestParameters in interface I_CmsSearchController

Parameters:

parameters - The request parameters.

isReloaded - a flag, indicating, if the search is performed repeatedly, opposed to entering the search page for the first time.

See Also:

• I_CmsSearchController.updateFromRequestParameters(java.util.Map, boolean)