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

implements I_CmsXmlConfiguration

Lucene search configuration class.

Since:

6.0.0

Version:

$Revision: 1.15 $

Author:

Thomas Weckert

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

A_ALIAS, A_CLASS, A_COUNT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_NAME, A_ORDER, A_PASSWORD, 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

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsSearchConfiguration()
Public constructor, will be called by configuration manager.

Method Summary

void	addXmlDigesterRules(Digester digester) Digests an XML node and creates an instance of this configurable class.
Element	generateXml(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.
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

Methods inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Constructor Detail

CmsSearchConfiguration

public CmsSearchConfiguration()

Public constructor, will be called by configuration manager.

Method Detail

addXmlDigesterRules

public void addXmlDigesterRules(Digester digester)

Description copied from interface: I_CmsXmlConfiguration

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

Specified by:

addXmlDigesterRules in interface I_CmsXmlConfiguration

Parameters:

digester - the digester to use

See Also:

I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester.Digester)

generateXml

public Element generateXml(Element parent)

Description copied from interface: I_CmsXmlConfiguration

Generates the XML element for this configurable class.

Specified by:

generateXml in interface I_CmsXmlConfiguration

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.

Specified by:

getDtdFilename in interface I_CmsXmlConfiguration

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