Package org.opencms.search.solr.spellchecking

Class CmsSolrSpellchecker

java.lang.Object

org.opencms.search.solr.spellchecking.CmsSolrSpellchecker

public final class CmsSolrSpellchecker
extends Object

CmsSolrSpellchecker is used to perform spellchecking in OpenCms by using Solr. The JSON-formatted result of the spellchecking operation contains suggestions for misspelled words and is compatible with the expected structure of the tinyMCE editor.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SPELLCHECKER_INDEX_CORE	The spellcheck core name.

Method Summary

Modifier and Type	Method	Description
static CmsSolrSpellchecker	getInstance()	Return an instance of this class.
static CmsSolrSpellchecker	getInstance(org.apache.solr.core.CoreContainer container)	Return an instance of this class.
void	getSpellcheckingResult(javax.servlet.http.HttpServletResponse res, javax.servlet.ServletRequest servletRequest, CmsObject cms)	Performs spellchecking using Solr and returns the spellchecking results using JSON.
void	parseAndAddDictionaries(CmsObject cms)	Parses and adds dictionaries to the Solr index.

Methods inherited from class java.lang.Object

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

Field Details

SPELLCHECKER_INDEX_CORE

public static final String SPELLCHECKER_INDEX_CORE

The spellcheck core name.

See Also:

• Constant Field Values

Method Details

getInstance

public static CmsSolrSpellchecker getInstance()

Return an instance of this class.

Returns:

instance of CmsSolrSpellchecker

getInstance

public static CmsSolrSpellchecker getInstance(org.apache.solr.core.CoreContainer container)

Return an instance of this class.

Parameters:

container - Solr CoreContainer container object in order to create a server object.

Returns:

instance of CmsSolrSpellchecker

getSpellcheckingResult

public void getSpellcheckingResult(javax.servlet.http.HttpServletResponse res,
 javax.servlet.ServletRequest servletRequest,
 CmsObject cms)
                            throws CmsPermissionViolationException,
IOException

Performs spellchecking using Solr and returns the spellchecking results using JSON.

Parameters:

res - The HttpServletResponse object.

servletRequest - The ServletRequest object.

cms - The CmsObject object.

Throws:

CmsPermissionViolationException - in case of the anonymous guest user

IOException - if writing the response fails

parseAndAddDictionaries

public void parseAndAddDictionaries(CmsObject cms)
                             throws CmsRoleViolationException

Parses and adds dictionaries to the Solr index.

Parameters:

cms - the OpenCms object.

Throws:

CmsRoleViolationException - in case the user does not have the required role ROOT_ADMIN