Package org.opencms.configuration

Class CmsSearchConfiguration

java.lang.Object

org.opencms.configuration.A_CmsXmlConfiguration

org.opencms.configuration.CmsSearchConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsSearchConfiguration
extends A_CmsXmlConfiguration

Lucene search configuration class.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_ANALYZER	The "analyzer" attribute.
static final String	A_BOOST	The "boost" attribute.
static final String	A_DISPLAY	The "displayName" attribute.
static final String	A_EXCERPT	The "excerpt" attribute.
static final String	A_INDEX	The "index" attribute.
static final String	A_SERVER_URL	The Solr server URL attribute, set if embedded = false.
static final String	A_STORE	The "store" attribute.
static final String	CONFIGURATION_DTD_NAME	The name of the DTD for this configuration.
static final String	DEFAULT_XML_FILE_NAME	The name of the default XML file for this configuration.
static final String	N_ANALYZER	Node name constant.
static final String	N_ANALYZERS	Node name constant.
static final String	N_CLASS	Node name constant.
static final String	N_COMMIT_MS	Node name constant.
static final String	N_CONFIG_FILE	Node name constant.
static final String	N_CONFIGURATION	Node name constant.
static final String	N_DESCRIPTION	Node name constant.
static final String	N_DIRECTORY	Node name constant.
static final String	N_DOCUMENTTYPE	Node name constant.
static final String	N_DOCUMENTTYPES	Node name constant.
static final String	N_DOCUMENTTYPES_INDEXED	Node name constant.
static final String	N_EXCERPT	Node name constant.
static final String	N_EXTRACTION_CACHE_MAX_AGE	Node name constant.
static final String	N_FIELD	Node name constant.
static final String	N_FIELDCONFIGURATION	Node name constant.
static final String	N_FIELDCONFIGURATIONS	Node name constant.
static final String	N_FIELDS	Node name constant.
static final String	N_FORCEUNLOCK	Node name constant.
static final String	N_HIGHLIGHTER	Node name constant.
static final String	N_HOME	Node name constant.
static final String	N_INDEX	Node name constant.
static final String	N_INDEXER	Node name constant.
static final String	N_INDEXES	Node name constant.
static final String	N_INDEXSOURCE	Node name constant.
static final String	N_INDEXSOURCES	Node name constant.
static final String	N_LOCALE	Node name constant.
static final String	N_MAPPING	Node name constant.
static final String	N_MAX_INDEX_WAIT_TIME	Node name constant.
static final String	N_MAX_MODIFICATIONS_BEFORE_COMMIT	Node name constant.
static final String	N_MIMETYPE	Node name constant.
static final String	N_MIMETYPES	Node name constant.
static final String	N_OFFLINE_UPDATE_FREQUENCY	Node name constant.
static final String	N_PROJECT	Node name constant.
static final String	N_REBUILD	Node name constant.
static final String	N_RESOURCES	Node name constant.
static final String	N_RESOURCETYPE	Node name constant.
static final String	N_RESOURCETYPES	Node name constant.
static final String	N_SEARCH	Node name constant.
static final String	N_SOLR	Node name constant.
static final String	N_SOURCE	Node name constant.
static final String	N_SOURCES	Node name constant.
static final String	N_STEMMER	Node name constant.
static final String	N_TIMEOUT	Node name constant.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

A_ALIAS, A_CLASS, A_COUNT, A_DEFAULT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_MODE, A_NAME, A_ORDER, A_PASSWORD, A_PORT, A_PROTOCOL, A_SUFFIX, A_TO, A_TYPE, A_URI, A_USER, A_VALUE, N_EXPORTPOINT, N_EXPORTPOINTS, N_NAME, N_PARAM, N_PROPERTY, N_RESOURCE, N_SITE, N_VALUE

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addXmlDigesterRules(org.apache.commons.digester3.Digester digester)	Digests an XML node and creates an instance of this configurable class.
org.dom4j.Element	generateXml(org.dom4j.Element parent)	Generates the XML element for this configurable class.
String	getDtdFilename()	Returns the name of the DTD file for this XML configuration, e.g.
CmsSearchManager	getSearchManager()	Returns the generated search manager.
void	initializeFinished()	Will be called when configuration of this object is finished.
protected void	initMembers()	Initializes member variables.
void	setSearchManager(CmsSearchManager manager)	Sets the generated search manager.

Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration

addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName

Methods inherited from class java.lang.Object

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

Field Details

A_ANALYZER

public static final String A_ANALYZER

The "analyzer" attribute.

See Also:

• Constant Field Values

A_BOOST

public static final String A_BOOST

The "boost" attribute.

See Also:

• Constant Field Values

A_DISPLAY

public static final String A_DISPLAY

The "displayName" attribute.

See Also:

• Constant Field Values

A_EXCERPT

public static final String A_EXCERPT

The "excerpt" attribute.

See Also:

• Constant Field Values

A_INDEX

public static final String A_INDEX

The "index" attribute.

See Also:

• Constant Field Values

A_SERVER_URL

public static final String A_SERVER_URL

The Solr server URL attribute, set if embedded = false.

See Also:

• Constant Field Values

A_STORE

public static final String A_STORE

The "store" attribute.

See Also:

• Constant Field Values

CONFIGURATION_DTD_NAME

public static final String CONFIGURATION_DTD_NAME

The name of the DTD for this configuration.

See Also:

• Constant Field Values

DEFAULT_XML_FILE_NAME

public static final String DEFAULT_XML_FILE_NAME

The name of the default XML file for this configuration.

See Also:

• Constant Field Values

N_ANALYZER

public static final String N_ANALYZER

Node name constant.

See Also:

• Constant Field Values

N_ANALYZERS

public static final String N_ANALYZERS

Node name constant.

See Also:

• Constant Field Values

N_CLASS

public static final String N_CLASS

Node name constant.

See Also:

• Constant Field Values

N_COMMIT_MS

public static final String N_COMMIT_MS

Node name constant.

See Also:

• Constant Field Values

N_CONFIG_FILE

public static final String N_CONFIG_FILE

Node name constant.

See Also:

• Constant Field Values

N_CONFIGURATION

public static final String N_CONFIGURATION

Node name constant.

See Also:

• Constant Field Values

N_DESCRIPTION

public static final String N_DESCRIPTION

Node name constant.

See Also:

• Constant Field Values

N_DIRECTORY

public static final String N_DIRECTORY

Node name constant.

See Also:

• Constant Field Values

N_DOCUMENTTYPE

public static final String N_DOCUMENTTYPE

Node name constant.

See Also:

• Constant Field Values

N_DOCUMENTTYPES

public static final String N_DOCUMENTTYPES

Node name constant.

See Also:

• Constant Field Values

N_DOCUMENTTYPES_INDEXED

public static final String N_DOCUMENTTYPES_INDEXED

Node name constant.

See Also:

• Constant Field Values

N_EXCERPT

public static final String N_EXCERPT

Node name constant.

See Also:

• Constant Field Values

N_EXTRACTION_CACHE_MAX_AGE

public static final String N_EXTRACTION_CACHE_MAX_AGE

Node name constant.

See Also:

• Constant Field Values

N_FIELD

public static final String N_FIELD

Node name constant.

See Also:

• Constant Field Values

N_FIELDCONFIGURATION

public static final String N_FIELDCONFIGURATION

Node name constant.

See Also:

• Constant Field Values

N_FIELDCONFIGURATIONS

public static final String N_FIELDCONFIGURATIONS

Node name constant.

See Also:

• Constant Field Values

N_FIELDS

public static final String N_FIELDS

Node name constant.

See Also:

• Constant Field Values

N_FORCEUNLOCK

public static final String N_FORCEUNLOCK

Node name constant.

See Also:

• Constant Field Values

N_HIGHLIGHTER

public static final String N_HIGHLIGHTER

Node name constant.

See Also:

• Constant Field Values

N_HOME

public static final String N_HOME

Node name constant.

See Also:

• Constant Field Values

N_INDEX

public static final String N_INDEX

Node name constant.

See Also:

• Constant Field Values

N_INDEXER

public static final String N_INDEXER

Node name constant.

See Also:

• Constant Field Values

N_INDEXES

public static final String N_INDEXES

Node name constant.

See Also:

• Constant Field Values

N_INDEXSOURCE

public static final String N_INDEXSOURCE

Node name constant.

See Also:

• Constant Field Values

N_INDEXSOURCES

public static final String N_INDEXSOURCES

Node name constant.

See Also:

• Constant Field Values

N_LOCALE

public static final String N_LOCALE

Node name constant.

See Also:

• Constant Field Values

N_MAPPING

public static final String N_MAPPING

Node name constant.

See Also:

• Constant Field Values

N_MAX_MODIFICATIONS_BEFORE_COMMIT

public static final String N_MAX_MODIFICATIONS_BEFORE_COMMIT

Node name constant.

See Also:

• Constant Field Values

N_MIMETYPE

public static final String N_MIMETYPE

Node name constant.

See Also:

• Constant Field Values

N_MIMETYPES

public static final String N_MIMETYPES

Node name constant.

See Also:

• Constant Field Values

N_OFFLINE_UPDATE_FREQUENCY

public static final String N_OFFLINE_UPDATE_FREQUENCY

Node name constant.

See Also:

• Constant Field Values

N_MAX_INDEX_WAIT_TIME

public static final String N_MAX_INDEX_WAIT_TIME

Node name constant.

See Also:

• Constant Field Values

N_PROJECT

public static final String N_PROJECT

Node name constant.

See Also:

• Constant Field Values

N_REBUILD

public static final String N_REBUILD

Node name constant.

See Also:

• Constant Field Values

N_RESOURCES

public static final String N_RESOURCES

Node name constant.

See Also:

• Constant Field Values

N_RESOURCETYPE

public static final String N_RESOURCETYPE

Node name constant.

See Also:

• Constant Field Values

N_RESOURCETYPES

public static final String N_RESOURCETYPES

Node name constant.

See Also:

• Constant Field Values

N_SEARCH

public static final String N_SEARCH

Node name constant.

See Also:

• Constant Field Values

N_SOLR

public static final String N_SOLR

Node name constant.

See Also:

• Constant Field Values

N_SOURCE

public static final String N_SOURCE

Node name constant.

See Also:

• Constant Field Values

N_SOURCES

public static final String N_SOURCES

Node name constant.

See Also:

• Constant Field Values

N_STEMMER

public static final String N_STEMMER

Node name constant.

See Also:

• Constant Field Values

N_TIMEOUT

public static final String N_TIMEOUT

Node name constant.

See Also:

• Constant Field Values

Constructor Details

CmsSearchConfiguration

public CmsSearchConfiguration()

Method Details

addXmlDigesterRules

public void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)

Description copied from interface: I_CmsXmlConfiguration

Digests an XML node and creates an instance of this configurable class.

Parameters:

digester - the digester to use

See Also:

• I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester3.Digester)

generateXml

public org.dom4j.Element generateXml(org.dom4j.Element parent)

Description copied from interface: I_CmsXmlConfiguration

Generates the XML element for this configurable class.

Parameters:

parent - the parent element in the XML tree

Returns:

the XML element for this configurable class

See Also:

• I_CmsXmlConfiguration.generateXml(org.dom4j.Element)

getDtdFilename

public String getDtdFilename()

Description copied from interface: I_CmsXmlConfiguration

Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.

Returns:

the name of the DTD file for this XML configuration

See Also:

• I_CmsXmlConfiguration.getDtdFilename()

getSearchManager

public CmsSearchManager getSearchManager()

Returns the generated search manager.

Returns:

the generated search manager

initializeFinished

public void initializeFinished()

Will be called when configuration of this object is finished.

setSearchManager

public void setSearchManager(CmsSearchManager manager)

Sets the generated search manager.

Parameters:

manager - the search manager to set

initMembers

protected void initMembers()

Description copied from class: A_CmsXmlConfiguration

Initializes member variables.

Specified by:

initMembers in class A_CmsXmlConfiguration

See Also:

• A_CmsXmlConfiguration.initMembers()