org.opencms.setup.xml.v8

类 CmsXmlAddADESearch

java.lang.Object

org.opencms.setup.xml.A_CmsSetupXmlUpdate

org.opencms.setup.xml.A_CmsXmlSearch

org.opencms.setup.xml.v8.CmsXmlAddADESearch

所有已实现的接口:

I_CmsSetupXmlUpdate

public class CmsXmlAddADESearch
extends A_CmsXmlSearch

Adds the gallery search nodes.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsXmlAddADESearch.CmsAddGalleryModuleIndexSourceAction Action to add the gallery modules index source.
static class	CmsXmlAddADESearch.CmsAddIndexSourceResourceAction An XML update action which adds the /system/galleries folder to the gallery index source.
static class	CmsXmlAddADESearch.CmsIndexSourceTypeUpdateAction Action for updating the office document types in the index sources.

构造器概要

构造器

构造器和说明
CmsXmlAddADESearch()

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	buildXpathForIndexSource(java.lang.String name) Creates an xpath for an index source.
static org.dom4j.Element	createElementFromXml(java.lang.String xml) Creates a dom4j element from an XML string.
protected boolean	executeUpdate(org.dom4j.Document document, java.lang.String xpath, boolean forReal) Executes the adding/updating changes on the given document.
protected java.lang.String	getCommonPath() Returns a parent path that is common for all nodes to modify.
java.lang.String	getName() Returns the nice name for the change.
protected java.util.List<java.lang.String>	getXPathsToUpdate() Returns a list of xpaths for the nodes to add/update.

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

createAnalyzer, createDocType, createField, createFieldConfig, createFieldMapping, createIndex, createIndexSource, getXmlFilename

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

execute, getCodeToChange, getXPathsToRemove, prepareDoc, updateDoc, validate

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

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

构造器详细资料

CmsXmlAddADESearch

public CmsXmlAddADESearch()

方法详细资料

createElementFromXml

public static org.dom4j.Element createElementFromXml(java.lang.String xml)
                                              throws org.dom4j.DocumentException

Creates a dom4j element from an XML string.

参数:

xml - the xml string

返回:

the dom4j element

抛出:

org.dom4j.DocumentException - if the XML parsing fails

getName

public java.lang.String getName()

从接口复制的说明: I_CmsSetupXmlUpdate

Returns the nice name for the change.

返回:

the nice name

另请参阅:

I_CmsSetupXmlUpdate.getName()

buildXpathForIndexSource

protected java.lang.String buildXpathForIndexSource(java.lang.String name)

Creates an xpath for an index source.

参数:

name - the name of the index source

返回:

the xpath for the index source

executeUpdate

protected boolean executeUpdate(org.dom4j.Document document,
                    java.lang.String xpath,
                    boolean forReal)

从类复制的说明: A_CmsSetupXmlUpdate

Executes the adding/updating changes on the given document.

Only needs to be overriden if A_CmsSetupXmlUpdate.getXPathsToUpdate() is not empty.

覆盖:

executeUpdate 在类中 A_CmsSetupXmlUpdate

参数:

document - the document to apply the changes to

xpath - the xpath to execute the changes for

forReal - is false, it is only on a empty doc to display the changes to the user

返回:

if something was modified

另请参阅:

A_CmsSetupXmlUpdate.executeUpdate(org.dom4j.Document, java.lang.String, boolean)

getCommonPath

protected java.lang.String getCommonPath()

从类复制的说明: A_CmsSetupXmlUpdate

Returns a parent path that is common for all nodes to modify.

覆盖:

getCommonPath 在类中 A_CmsSetupXmlUpdate

返回:

common parent path

另请参阅:

A_CmsSetupXmlUpdate.getCommonPath()

getXPathsToUpdate

protected java.util.List<java.lang.String> getXPathsToUpdate()

从类复制的说明: A_CmsSetupXmlUpdate

Returns a list of xpaths for the nodes to add/update.

覆盖:

getXPathsToUpdate 在类中 A_CmsSetupXmlUpdate

返回:

a list of strings

另请参阅:

A_CmsSetupXmlUpdate.getXPathsToUpdate()