Class CmsSearchController
- java.lang.Object
-
- org.opencms.jsp.search.controller.CmsSearchController
-
- All Implemented Interfaces:
I_CmsSearchController
,I_CmsSearchControllerMain
public class CmsSearchController extends java.lang.Object implements I_CmsSearchControllerMain
The main controller that allows to access all single sub-controllers.
-
-
Field Summary
-
Fields inherited from interface org.opencms.jsp.search.controller.I_CmsSearchController
SET_VARIABLES
-
-
Constructor Summary
Constructors Constructor Description CmsSearchController(I_CmsSearchConfiguration config)
Constructor that sets up the controller with a given configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods 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_CmsSearchControllerCommon
getCommon()
Returns the controller for common search (form) configurations.I_CmsSearchControllerDidYouMean
getDidYouMean()
Returns the controller for "Did you mean ...?".I_CmsSearchControllerFacetsField
getFieldFacets()
Returns the controller for field facets.I_CmsSearchControllerGeoFilter
getGeoFilter()
Returns the controller for the Geo filter.I_CmsSearchControllerHighlighting
getHighlighting()
Returns the controller for highlighting.I_CmsSearchControllerPagination
getPagination()
Returns the controller for pagination.I_CmsSearchControllerFacetQuery
getQueryFacet()
Returns the controller for the query facet.I_CmsSearchControllerFacetsRange
getRangeFacets()
Returns the controller for range facets.I_CmsSearchControllerSorting
getSorting()
Returns the controller for sorting.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 unused)
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
-
CmsSearchController
public CmsSearchController(I_CmsSearchConfiguration config)
Constructor that sets up the controller with a given configuration.- Parameters:
config
- The search configuration handled 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 interfaceI_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 interfaceI_CmsSearchController
- Parameters:
query
- A, possibly empty, query, where further query parts are addedcms
- the current context to resolve context-specific macros.- See Also:
I_CmsSearchController.addQueryParts(CmsSolrQuery, CmsObject)
-
getCommon
public I_CmsSearchControllerCommon getCommon()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for common search (form) configurations.- Specified by:
getCommon
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for common search (form) configurations.
- See Also:
I_CmsSearchControllerMain.getCommon()
-
getDidYouMean
public I_CmsSearchControllerDidYouMean getDidYouMean()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for "Did you mean ...?".- Specified by:
getDidYouMean
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for "Did you mean ...?".
- See Also:
I_CmsSearchControllerMain.getDidYouMean()
-
getFieldFacets
public I_CmsSearchControllerFacetsField getFieldFacets()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for field facets.- Specified by:
getFieldFacets
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for field facets.
- See Also:
I_CmsSearchControllerMain.getFieldFacets()
-
getGeoFilter
public I_CmsSearchControllerGeoFilter getGeoFilter()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for the Geo filter.- Specified by:
getGeoFilter
in interfaceI_CmsSearchControllerMain
- Returns:
- the controller for the Geo filter
- See Also:
I_CmsSearchControllerMain.getGeoFilter()
-
getHighlighting
public I_CmsSearchControllerHighlighting getHighlighting()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for highlighting.- Specified by:
getHighlighting
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for highlighting.
- See Also:
I_CmsSearchControllerMain.getHighlighting()
-
getPagination
public I_CmsSearchControllerPagination getPagination()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for pagination.- Specified by:
getPagination
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for highlighting.
- See Also:
I_CmsSearchControllerMain.getPagination()
-
getQueryFacet
public I_CmsSearchControllerFacetQuery getQueryFacet()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for the query facet.- Specified by:
getQueryFacet
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for the query facet.
- See Also:
I_CmsSearchControllerMain.getQueryFacet()
-
getRangeFacets
public I_CmsSearchControllerFacetsRange getRangeFacets()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for range facets.- Specified by:
getRangeFacets
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for range facets.
- See Also:
I_CmsSearchControllerMain.getRangeFacets()
-
getSorting
public I_CmsSearchControllerSorting getSorting()
Description copied from interface:I_CmsSearchControllerMain
Returns the controller for sorting.- Specified by:
getSorting
in interfaceI_CmsSearchControllerMain
- Returns:
- The controller for sorting.
- See Also:
I_CmsSearchControllerMain.getSorting()
-
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 interfaceI_CmsSearchController
- See Also:
I_CmsSearchController.updateForQueryChange()
-
updateFromRequestParameters
public void updateFromRequestParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters, boolean unused)
Description copied from interface:I_CmsSearchController
Update the controllers state from the given request parameters.- Specified by:
updateFromRequestParameters
in interfaceI_CmsSearchController
- Parameters:
parameters
- The request parameters.unused
- 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)
-
-