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

Class CmsPlainQuerySearchConfigurationParser

java.lang.Object

org.opencms.jsp.search.config.parser.CmsPlainQuerySearchConfigurationParser

All Implemented Interfaces:

I_CmsSearchConfigurationParser

public class CmsPlainQuerySearchConfigurationParser
extends Object
implements I_CmsSearchConfigurationParser

Search configuration parser reading a configuration containing a plain Solr query. Only fl might be added additionally.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.commons.logging.Log	LOG	Logger for the class.
protected String	m_queryString	The whole query string.

Constructor Summary

Constructors

Constructor	Description
CmsPlainQuerySearchConfigurationParser(String query)	Constructor taking the JSON as String.
CmsPlainQuerySearchConfigurationParser(String query, I_CmsSearchConfiguration baseConfig)	Constructor taking the JSON as String.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

protected static final org.apache.commons.logging.Log LOG

Logger for the class.

m_queryString

protected String m_queryString

The whole query string.

Constructor Details

CmsPlainQuerySearchConfigurationParser

public CmsPlainQuerySearchConfigurationParser(String query)

Constructor taking the JSON as String.

Parameters:

query - The query that is passed to Solr.

CmsPlainQuerySearchConfigurationParser

public CmsPlainQuerySearchConfigurationParser(String query,
 I_CmsSearchConfiguration baseConfig)

Constructor taking the JSON as String.

Parameters:

query - The query that is passed to Solr (additional Solr params).

baseConfig - A base configuration that is adjusted by the JSON configuration string.

Method Details

parseCommon

public I_CmsSearchConfigurationCommon parseCommon(CmsObject cms)

Description copied from interface: I_CmsSearchConfigurationParser

Returns the common search configuration.

Specified by:

parseCommon in interface I_CmsSearchConfigurationParser

Parameters:

cms - the current context

Returns:

The common search configuration.

See Also:

• I_CmsSearchConfigurationParser.parseCommon(CmsObject)

parseDidYouMean

public I_CmsSearchConfigurationDidYouMean parseDidYouMean()

Description copied from interface: I_CmsSearchConfigurationParser

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

Specified by:

parseDidYouMean in interface I_CmsSearchConfigurationParser

Returns:

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

See Also:

• I_CmsSearchConfigurationParser.parseDidYouMean()

parseFieldFacets

public Map<String,I_CmsSearchConfigurationFacetField> parseFieldFacets()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for the field facets.

Specified by:

parseFieldFacets in interface I_CmsSearchConfigurationParser

Returns:

The configuration for the field facets.

See Also:

• I_CmsSearchConfigurationParser.parseFieldFacets()

parseGeoFilter

public I_CmsSearchConfigurationGeoFilter parseGeoFilter()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for the Geo filter.

Specified by:

parseGeoFilter in interface I_CmsSearchConfigurationParser

Returns:

The configuration for the Geo filter.

See Also:

• I_CmsSearchConfigurationParser.parseGeoFilter()

parseHighlighter

public I_CmsSearchConfigurationHighlighting parseHighlighter()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for the highlighting.

Specified by:

parseHighlighter in interface I_CmsSearchConfigurationParser

Returns:

The configuration for the highlighting.

See Also:

• I_CmsSearchConfigurationParser.parseHighlighter()

parsePagination

public I_CmsSearchConfigurationPagination parsePagination()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for the pagination.

Specified by:

parsePagination in interface I_CmsSearchConfigurationParser

Returns:

The configuration for the pagination.

See Also:

• I_CmsSearchConfigurationParser.parsePagination()

parseQueryFacet

public I_CmsSearchConfigurationFacetQuery parseQueryFacet()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for the query facet.

Specified by:

parseQueryFacet in interface I_CmsSearchConfigurationParser

Returns:

The configuration for the query facet.

See Also:

• I_CmsSearchConfigurationParser.parseQueryFacet()

parseRangeFacets

public Map<String,I_CmsSearchConfigurationFacetRange> parseRangeFacets()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for the range facets.

Specified by:

parseRangeFacets in interface I_CmsSearchConfigurationParser

Returns:

The configuration for the range facets.

See Also:

• I_CmsSearchConfigurationParser.parseRangeFacets()

parseSorting

public I_CmsSearchConfigurationSorting parseSorting()

Description copied from interface: I_CmsSearchConfigurationParser

Returns the configuration for sorting.

Specified by:

parseSorting in interface I_CmsSearchConfigurationParser

Returns:

The configuration for sorting.

See Also:

• I_CmsSearchConfigurationParser.parseSorting()