org.opencms.setup.xml

类 A_CmsXmlSearch

java.lang.Object

org.opencms.setup.xml.A_CmsSetupXmlUpdate

org.opencms.setup.xml.A_CmsXmlSearch

所有已实现的接口:

I_CmsSetupXmlUpdate

直接已知子类:

CmsXmlAddADESearch, CmsXmlAddDEHelpSearchIndex, CmsXmlAddSolrSearch, CmsXmlCleanUpSearchConfiguration, CmsXmlRemovePageSearchIndexSource1, CmsXmlRemoveSysSearchIndex

public abstract class A_CmsXmlSearch
extends A_CmsSetupXmlUpdate

Skeleton for handling opencms-search.xml.

从以下版本开始:

8.0.0

构造器概要

构造器

构造器和说明
A_CmsXmlSearch()

方法概要

方法

限定符和类型	方法和说明
protected void	createAnalyzer(org.dom4j.Document document, java.lang.String xpath, java.lang.Class<CmsGallerySearchAnalyzer> clazz, java.lang.String locale) Creates a new analyzer node.
protected void	createDocType(org.dom4j.Document document, java.lang.String xpath, java.lang.String name, java.lang.Class<?> clazz, java.lang.String[] mimetypes, java.lang.String[] restypes) Creates a new document type node.
protected void	createField(org.dom4j.Document document, java.lang.String xpath, CmsLuceneField field) Creates a new field node.
void	createFieldConfig(org.dom4j.Document document, java.lang.String xpath, CmsSearchFieldConfiguration fieldConf, java.lang.Class<?> clazz) Creates a new fieldconfiguration node.
protected void	createFieldMapping(org.dom4j.Document document, java.lang.String xpath, CmsSearchFieldMapping mapping) Creates a new mapping node.
protected void	createIndex(org.dom4j.Document document, java.lang.String xpath, java.lang.Class<?> clazz, java.lang.String name, java.lang.String rebuild, java.lang.String project, java.lang.String locale, java.lang.String configuration, java.lang.String[] sources) Creates a new index node.
protected void	createIndexSource(org.dom4j.Document document, java.lang.String xpath, java.lang.String name, java.lang.Class<CmsVfsIndexer> clazz, java.lang.String[] resources, java.lang.String[] doctypes) Creates a new indexsource node.
java.lang.String	getXmlFilename() Returns the affected xml configuration file name.

从类继承的方法 org.opencms.setup.xml.A_CmsSetupXmlUpdate

createElementFromXml, execute, executeUpdate, getCodeToChange, getCommonPath, getXPathsToRemove, getXPathsToUpdate, prepareDoc, updateDoc, validate

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.setup.xml.I_CmsSetupXmlUpdate

getName

构造器详细资料

A_CmsXmlSearch

public A_CmsXmlSearch()

方法详细资料

createFieldConfig

public void createFieldConfig(org.dom4j.Document document,
                     java.lang.String xpath,
                     CmsSearchFieldConfiguration fieldConf,
                     java.lang.Class<?> clazz)

Creates a new fieldconfiguration node.

参数:

document - the document to modify

xpath - the xpath to the fieldconfiguration, ie opencms/search/fieldconfigurations/fieldconfiguration[name='...']

fieldConf - the field configuration

clazz - the optional class attribute value

getXmlFilename

public java.lang.String getXmlFilename()

从接口复制的说明: I_CmsSetupXmlUpdate

Returns the affected xml configuration file name.

返回:

the xml file name

另请参阅:

I_CmsSetupXmlUpdate.getXmlFilename()

createAnalyzer

protected void createAnalyzer(org.dom4j.Document document,
                  java.lang.String xpath,
                  java.lang.Class<CmsGallerySearchAnalyzer> clazz,
                  java.lang.String locale)

Creates a new analyzer node.

参数:

document - the document to modify

xpath - the xpath to the non-existing index (ie. /opencms/search/analyzers/analyzer[class='...'])

clazz - the class attribute value

locale - the locale attribute value

createDocType

protected void createDocType(org.dom4j.Document document,
                 java.lang.String xpath,
                 java.lang.String name,
                 java.lang.Class<?> clazz,
                 java.lang.String[] mimetypes,
                 java.lang.String[] restypes)

Creates a new document type node.

参数:

document - the document to modify

xpath - the xpath to the index source, ie /opencms/search/documenttypes/documenttype[name='...']

name - the name attribute value

clazz - the class attribute value

mimetypes - the list of mimetypes

restypes - the list of resource types

createField

protected void createField(org.dom4j.Document document,
               java.lang.String xpath,
               CmsLuceneField field)

Creates a new field node.

参数:

document - the document to modify

xpath - the xpath to the field, ie opencms/search/fieldconfigurations/fieldconfiguration[name='...']/fields/field[@name="..."]

field - the field

createFieldMapping

protected void createFieldMapping(org.dom4j.Document document,
                      java.lang.String xpath,
                      CmsSearchFieldMapping mapping)

Creates a new mapping node.

参数:

document - the document to modify

xpath - the xpath to the field mapping, ie opencms/search/fieldconfigurations/fieldconfiguration[name='...']/fields/field[@name="..."]/mappings/mapping[@type='...']

mapping - the field mapping

createIndex

protected void createIndex(org.dom4j.Document document,
               java.lang.String xpath,
               java.lang.Class<?> clazz,
               java.lang.String name,
               java.lang.String rebuild,
               java.lang.String project,
               java.lang.String locale,
               java.lang.String configuration,
               java.lang.String[] sources)

Creates a new index node.

参数:

document - the document to modify

xpath - the xpath to the non-existing index (ie. /opencms/search/indexes/index[name='...'])

clazz - the optional class attribute

name - the name attribute value

rebuild - the rebuild attribute value

project - the project attribute value

locale - the locale attribute value

configuration - the optional configuration attribute value

sources - the list of referenced sources

createIndexSource

protected void createIndexSource(org.dom4j.Document document,
                     java.lang.String xpath,
                     java.lang.String name,
                     java.lang.Class<CmsVfsIndexer> clazz,
                     java.lang.String[] resources,
                     java.lang.String[] doctypes)

Creates a new indexsource node.

参数:

document - the document to modify

xpath - the xpath to the index source, ie /opencms/search/indexsources/indexsource[name='...']

name - the name attribute value

clazz - the class attribute value

resources - the list of resources

doctypes - the list of document types