Package org.opencms.jsp.search.config
Class CmsSearchConfiguration
- java.lang.Object
-
- org.opencms.jsp.search.config.CmsSearchConfiguration
-
- All Implemented Interfaces:
I_CmsSearchConfiguration
public class CmsSearchConfiguration extends java.lang.Object implements I_CmsSearchConfiguration
The main search configuration. It's a collection of all the different parts of a search configuration.
-
-
Constructor Summary
Constructors Constructor Description CmsSearchConfiguration(I_CmsSearchConfigurationParser parser, CmsObject cms)
Constructor to initialize the configuration object via a configuration parser.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description I_CmsSearchConfigurationDidYouMean
getDidYouMeanConfig()
Returns the configuration for "Did you mean ...?".java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetField>
getFieldFacetConfigs()
Returns the configuration for field facets.I_CmsSearchConfigurationCommon
getGeneralConfig()
Returns the common search (form) configuration.I_CmsSearchConfigurationGeoFilter
getGeoFilterConfig()
Returns the Geo filter configuration.I_CmsSearchConfigurationHighlighting
getHighlighterConfig()
Returns the configuration for highlighting.I_CmsSearchConfigurationPagination
getPaginationConfig()
Returns the configuration for pagination.I_CmsSearchConfigurationFacetQuery
getQueryFacetConfig()
Returns the configuration for field facets.java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetRange>
getRangeFacetConfigs()
Returns the configuration for range facets.I_CmsSearchConfigurationSorting
getSortConfig()
Returns the configuration for sorting.
-
-
-
Constructor Detail
-
CmsSearchConfiguration
public CmsSearchConfiguration(I_CmsSearchConfigurationParser parser, CmsObject cms)
Constructor to initialize the configuration object via a configuration parser.- Parameters:
parser
- The configuration parser that's used to read the configuration.cms
- The current context.
-
-
Method Detail
-
getDidYouMeanConfig
public I_CmsSearchConfigurationDidYouMean getDidYouMeanConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for "Did you mean ...?".- Specified by:
getDidYouMeanConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for "Did you mean ...?".
- See Also:
I_CmsSearchConfiguration.getDidYouMeanConfig()
-
getFieldFacetConfigs
public java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetField> getFieldFacetConfigs()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for field facets.- Specified by:
getFieldFacetConfigs
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for field facets.
- See Also:
I_CmsSearchConfiguration.getFieldFacetConfigs()
-
getGeneralConfig
public I_CmsSearchConfigurationCommon getGeneralConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the common search (form) configuration.- Specified by:
getGeneralConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The common search (form) configuration.
- See Also:
I_CmsSearchConfiguration.getGeneralConfig()
-
getGeoFilterConfig
public I_CmsSearchConfigurationGeoFilter getGeoFilterConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the Geo filter configuration.- Specified by:
getGeoFilterConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The Geo filter configuration.
- See Also:
I_CmsSearchConfiguration.getGeoFilterConfig()
-
getHighlighterConfig
public I_CmsSearchConfigurationHighlighting getHighlighterConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for highlighting.- Specified by:
getHighlighterConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for highlighting.
- See Also:
I_CmsSearchConfiguration.getHighlighterConfig()
-
getPaginationConfig
public I_CmsSearchConfigurationPagination getPaginationConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for pagination.- Specified by:
getPaginationConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for pagination.
- See Also:
I_CmsSearchConfiguration.getPaginationConfig()
-
getQueryFacetConfig
public I_CmsSearchConfigurationFacetQuery getQueryFacetConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for field facets.- Specified by:
getQueryFacetConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for field facets.
- See Also:
I_CmsSearchConfiguration.getQueryFacetConfig()
-
getRangeFacetConfigs
public java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetRange> getRangeFacetConfigs()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for range facets.- Specified by:
getRangeFacetConfigs
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for range facets.
- See Also:
I_CmsSearchConfiguration.getRangeFacetConfigs()
-
getSortConfig
public I_CmsSearchConfigurationSorting getSortConfig()
Description copied from interface:I_CmsSearchConfiguration
Returns the configuration for sorting.- Specified by:
getSortConfig
in interfaceI_CmsSearchConfiguration
- Returns:
- The configuration for sorting.
- See Also:
I_CmsSearchConfiguration.getSortConfig()
-
-