Package org.opencms.jsp.search.config

Class CmsSearchConfigurationDidYouMean

java.lang.Object

org.opencms.jsp.search.config.CmsSearchConfigurationDidYouMean

All Implemented Interfaces:

I_CmsSearchConfigurationDidYouMean

public class CmsSearchConfigurationDidYouMean
extends Object
implements I_CmsSearchConfigurationDidYouMean

Class keeping the configuration of the "Did you mean ...?" feature of the search form.

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationDidYouMean(String param, Boolean escapeQueryChars, Boolean collate, Integer count)	Constructor setting all the state.

Method Summary

Modifier and Type	Method	Description
boolean	getCollate()	Returns a flag, indicating if collation is turned on or off.
int	getCount()	Returns the maximal number of suggestions.
boolean	getEscapeQueryChars()	Returns a flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.
String	getQueryParam()	Returns the parameter name of the request parameter used to send the current query string for spellchecking.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchConfigurationDidYouMean

public CmsSearchConfigurationDidYouMean(String param,
 Boolean escapeQueryChars,
 Boolean collate,
 Integer count)

Constructor setting all the state.

Parameters:

param - The request parameter used to send the spellcheck query.

escapeQueryChars - Flag, indicating if query characters should be escaped.

collate - Flag, indicating if the results should be collated.

count - The maximal number of suggestions.

Method Details

getCollate

public boolean getCollate()

Description copied from interface: I_CmsSearchConfigurationDidYouMean

Returns a flag, indicating if collation is turned on or off.

Specified by:

getCollate in interface I_CmsSearchConfigurationDidYouMean

Returns:

A flag, indicating if collation is turned on or off.

See Also:

• I_CmsSearchConfigurationDidYouMean.getCollate()

getCount

public int getCount()

Description copied from interface: I_CmsSearchConfigurationDidYouMean

Returns the maximal number of suggestions.

Specified by:

getCount in interface I_CmsSearchConfigurationDidYouMean

Returns:

The maximal number of suggestions.

See Also:

• I_CmsSearchConfigurationDidYouMean.getCount()

getEscapeQueryChars

public boolean getEscapeQueryChars()

Description copied from interface: I_CmsSearchConfigurationDidYouMean

Returns a flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.

Specified by:

getEscapeQueryChars in interface I_CmsSearchConfigurationDidYouMean

Returns:

A flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.

See Also:

• I_CmsSearchConfigurationDidYouMean.getEscapeQueryChars()

getQueryParam

public String getQueryParam()

Description copied from interface: I_CmsSearchConfigurationDidYouMean

Returns the parameter name of the request parameter used to send the current query string for spellchecking.

Specified by:

getQueryParam in interface I_CmsSearchConfigurationDidYouMean

Returns:

The request parameter name used to send the current query string for spellchecking.

See Also:

• I_CmsSearchConfigurationDidYouMean.getQueryParam()