Package org.opencms.jsp.search.config.parser

Interface I_CmsSearchConfigurationParser

All Known Implementing Classes:

CmsJSONSearchConfigurationParser, CmsPlainQuerySearchConfigurationParser, CmsSimpleSearchConfigurationParser, CmsXMLSearchConfigurationParser

public interface I_CmsSearchConfigurationParser

The interface that must be implemented by search (form) configuration parsers.

Method Summary

Modifier and Type	Method	Description
I_CmsSearchConfigurationCommon	parseCommon(CmsObject cms)	Returns the common search configuration.
I_CmsSearchConfigurationDidYouMean	parseDidYouMean()	Returns the configuration for the "Did you mean ...?" feature.
Map<String,I_CmsSearchConfigurationFacetField>	parseFieldFacets()	Returns the configuration for the field facets.
I_CmsSearchConfigurationGeoFilter	parseGeoFilter()	Returns the configuration for the Geo filter.
I_CmsSearchConfigurationHighlighting	parseHighlighter()	Returns the configuration for the highlighting.
I_CmsSearchConfigurationPagination	parsePagination()	Returns the configuration for the pagination.
I_CmsSearchConfigurationFacetQuery	parseQueryFacet()	Returns the configuration for the query facet.
Map<String,I_CmsSearchConfigurationFacetRange>	parseRangeFacets()	Returns the configuration for the range facets.
I_CmsSearchConfigurationSorting	parseSorting()	Returns the configuration for sorting.

Method Details

parseCommon

I_CmsSearchConfigurationCommon parseCommon(CmsObject cms)

Returns the common search configuration.

Parameters:

cms - the current context

Returns:

The common search configuration.

parseDidYouMean

I_CmsSearchConfigurationDidYouMean parseDidYouMean()

Returns the configuration for the "Did you mean ...?" feature.

Returns:

The configuration for the "Did you mean ...?" feature.

parseFieldFacets

Map<String,I_CmsSearchConfigurationFacetField> parseFieldFacets()

Returns the configuration for the field facets.

Returns:

The configuration for the field facets.

parseGeoFilter

I_CmsSearchConfigurationGeoFilter parseGeoFilter()

Returns the configuration for the Geo filter.

Returns:

The configuration for the Geo filter.

parseHighlighter

I_CmsSearchConfigurationHighlighting parseHighlighter()

Returns the configuration for the highlighting.

Returns:

The configuration for the highlighting.

parsePagination

I_CmsSearchConfigurationPagination parsePagination()

Returns the configuration for the pagination.

Returns:

The configuration for the pagination.

parseQueryFacet

I_CmsSearchConfigurationFacetQuery parseQueryFacet()

Returns the configuration for the query facet.

Returns:

The configuration for the query facet.

parseRangeFacets

Map<String,I_CmsSearchConfigurationFacetRange> parseRangeFacets()

Returns the configuration for the range facets.

Returns:

The configuration for the range facets.

parseSorting

I_CmsSearchConfigurationSorting parseSorting()

Returns the configuration for sorting.

Returns:

The configuration for sorting.