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.17 $

Author:

Thomas Weckert

Field Summary

static String	CONFIGURATION_DTD_NAME The name of the DTD for this configuration.
static String	DEFAULT_XML_FILE_NAME The name of the default XML file for this configuration.
static String	N_ANALYZER Node name constant.
static String	N_ANALYZERS Node name constant.
static String	N_CACHE Node name constant.
static String	N_CLASS Node name constant.
static String	N_DIRECTORY Node name constant.
static String	N_DOCUMENTTYPE Node name constant.
static String	N_DOCUMENTTYPES Node name constant.
static String	N_DOCUMENTTYPES_INDEXED Node name constant.
static String	N_EXCERPT Node name constant.
static String	N_HIGHLIGHTER Node name constant.
static String	N_INDEX Node name constant.
static String	N_INDEXER Node name constant.
static String	N_INDEXES Node name constant.
static String	N_INDEXSOURCE Node name constant.
static String	N_INDEXSOURCES Node name constant.
static String	N_LOCALE Node name constant.
static String	N_MIMETYPE Node name constant.
static String	N_MIMETYPES Node name constant.
static String	N_PROJECT Node name constant.
static String	N_REBUILD Node name constant.
static String	N_RESOURCES Node name constant.
static String	N_RESOURCETYPE Node name constant.
static String	N_RESOURCETYPES Node name constant.
static String	N_SEARCH Node name constant.
static String	N_SOURCE Node name constant.
static String	N_SOURCES Node name constant.
static String	N_STEMMER Node name constant.
static String	N_TIMEOUT Node name constant.

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

Field Detail

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_CACHE

public static final String N_CACHE

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_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_HIGHLIGHTER

public static final String N_HIGHLIGHTER

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_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_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_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 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