Class CmsSearchControllerFacetsRange
- java.lang.Object
-
- org.opencms.jsp.search.controller.CmsSearchControllerFacetsRange
-
- All Implemented Interfaces:
I_CmsSearchController
,I_CmsSearchControllerFacetsRange
public class CmsSearchControllerFacetsRange extends java.lang.Object implements I_CmsSearchControllerFacetsRange
Search controller as aggregation of all single field facet controllers.
-
-
Field Summary
-
Fields inherited from interface org.opencms.jsp.search.controller.I_CmsSearchController
SET_VARIABLES
-
-
Constructor Summary
Constructors Constructor Description CmsSearchControllerFacetsRange(java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetRange> configs)
Constructor taking the list of field facet controllers that are aggregated.
-
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.java.util.Map<java.lang.String,I_CmsSearchControllerFacetRange>
getRangeFacetController()
Get access to the controllers by the range facet's names.java.util.Collection<I_CmsSearchControllerFacetRange>
getRangeFacetControllers()
Get the collection of all range facet controllers.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
-
CmsSearchControllerFacetsRange
public CmsSearchControllerFacetsRange(java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetRange> configs)
Constructor taking the list of field facet controllers that are aggregated.- Parameters:
configs
- The controllers for single field facets.
-
-
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)
-
getRangeFacetController
public java.util.Map<java.lang.String,I_CmsSearchControllerFacetRange> getRangeFacetController()
Description copied from interface:I_CmsSearchControllerFacetsRange
Get access to the controllers by the range facet's names.- Specified by:
getRangeFacetController
in interfaceI_CmsSearchControllerFacetsRange
- Returns:
- The map with all range facet controllers, where the facet's names are the keys and the facet's controllers are the values.
- See Also:
I_CmsSearchControllerFacetsRange.getRangeFacetController()
-
getRangeFacetControllers
public java.util.Collection<I_CmsSearchControllerFacetRange> getRangeFacetControllers()
Description copied from interface:I_CmsSearchControllerFacetsRange
Get the collection of all range facet controllers.- Specified by:
getRangeFacetControllers
in interfaceI_CmsSearchControllerFacetsRange
- Returns:
- The collection of all range facet controllers.
- See Also:
I_CmsSearchControllerFacetsRange.getRangeFacetControllers()
-
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 isReloaded)
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.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)
-
-