Package org.opencms.jsp.search.controller

Class CmsSearchControllerCommon

java.lang.Object

org.opencms.jsp.search.controller.CmsSearchControllerCommon

All Implemented Interfaces:

I_CmsSearchController, I_CmsSearchControllerCommon

public class CmsSearchControllerCommon
extends java.lang.Object
implements I_CmsSearchControllerCommon

Search controller for the common search options.

Field Summary

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

SET_VARIABLES

Constructor Summary

Constructors

Constructor	Description
CmsSearchControllerCommon(I_CmsSearchConfigurationCommon config)	Constructor taking the managed configuration.

Method Summary

Modifier and Type	Method	Description
void	addParametersForCurrentState(java.util.Map<java.lang.String,java.lang.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_CmsSearchConfigurationCommon	getConfig()	Returns the configuration.
I_CmsSearchStateCommon	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(java.util.Map<java.lang.String,java.lang.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 Detail

CmsSearchControllerCommon

public CmsSearchControllerCommon(I_CmsSearchConfigurationCommon config)

Constructor taking the managed configuration.

Parameters:

config - The configuration to manage by the controller.

Method Detail

addParametersForCurrentState

public void addParametersForCurrentState(java.util.Map<java.lang.String,java.lang.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_CmsSearchConfigurationCommon getConfig()

Description copied from interface: I_CmsSearchControllerCommon

Returns the configuration.

Specified by:

getConfig in interface I_CmsSearchControllerCommon

Returns:

The configuration.

See Also:

I_CmsSearchControllerCommon.getConfig()

getState

public I_CmsSearchStateCommon getState()

Description copied from interface: I_CmsSearchControllerCommon

Returns the state.

Specified by:

getState in interface I_CmsSearchControllerCommon

Returns:

The state.

See Also:

I_CmsSearchControllerCommon.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(java.util.Map<java.lang.String,java.lang.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)