org.opencms.setup.xml

类 A_CmsSetupXmlUpdate

java.lang.Object

org.opencms.setup.xml.A_CmsSetupXmlUpdate

所有已实现的接口:

I_CmsSetupXmlUpdate

直接已知子类:

A_CmsXmlSearch, A_CmsXmlVfs, A_CmsXmlWorkplace, CmsXmlAddAdeConfig, CmsXmlAddContentNotification, CmsXmlAddImmutables, CmsXmlAddImportVersions, CmsXmlAddMultiContextMenu, CmsXmlAddResourceHandlers, CmsXmlAddResourceHandlers, CmsXmlAddResourcesToRender, CmsXmlAddSharedFolderConfiguration, CmsXmlAddSitemapConfig, CmsXmlAddTimezone, CmsXmlRemoveImmutables, CmsXmlRemoveImportHandlers, CmsXmlRemoveImportVersions, CmsXmlRemoveResourceHandlers, CmsXmlRemoveResourcesToRender, CmsXmlUpdateDefaultProperties, CmsXmlUpdateFlexcache, CmsXmlUpdateHistoryContextMenu

public abstract class A_CmsSetupXmlUpdate
extends java.lang.Object
implements I_CmsSetupXmlUpdate

Skeleton for xml update plugins.

从以下版本开始:

6.1.8

构造器概要

构造器

构造器和说明
A_CmsSetupXmlUpdate()

方法概要

方法

限定符和类型	方法和说明
static org.dom4j.Element	createElementFromXml(java.lang.String xml) Creates a dom4j element from an XML string.
void	execute(CmsSetupBean setupBean) Execute the change.
protected boolean	executeUpdate(org.dom4j.Document document, java.lang.String xpath, boolean forReal) Executes the adding/updating changes on the given document.
java.lang.String	getCodeToChange(CmsSetupBean setupBean) Returns the code to be added OR removed in the xml file.
protected java.lang.String	getCommonPath() Returns a parent path that is common for all nodes to modify.
protected java.util.List<java.lang.String>	getXPathsToRemove() Returns a list of xpaths for the nodes to remove.
protected java.util.List<java.lang.String>	getXPathsToUpdate() Returns a list of xpaths for the nodes to add/update.
protected org.dom4j.Document	prepareDoc(org.dom4j.Document doc) Prepares a new document.
protected void	updateDoc(org.dom4j.Document document, org.dom4j.Document newDoc, java.lang.String xpath) Updates the given doc inserting the given node corresponding to the given xpath.
boolean	validate(CmsSetupBean setupBean) Validates the need to apply this change.

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

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

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

getName, getXmlFilename

构造器详细资料

A_CmsSetupXmlUpdate

public A_CmsSetupXmlUpdate()

方法详细资料

execute

public void execute(CmsSetupBean setupBean)
             throws java.lang.Exception

从接口复制的说明: I_CmsSetupXmlUpdate

Execute the change.

指定者:

execute 在接口中 I_CmsSetupXmlUpdate

参数:

setupBean - the setup bean

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

I_CmsSetupXmlUpdate.execute(org.opencms.setup.CmsSetupBean)

getCodeToChange

public java.lang.String getCodeToChange(CmsSetupBean setupBean)
                                 throws java.lang.Exception

从接口复制的说明: I_CmsSetupXmlUpdate

Returns the code to be added OR removed in the xml file.

指定者:

getCodeToChange 在接口中 I_CmsSetupXmlUpdate

参数:

setupBean - the setup bean

返回:

the code to be changed

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

I_CmsSetupXmlUpdate.getCodeToChange(org.opencms.setup.CmsSetupBean)

validate

public boolean validate(CmsSetupBean setupBean)
                 throws java.lang.Exception

从接口复制的说明: I_CmsSetupXmlUpdate

Validates the need to apply this change.

指定者:

validate 在接口中 I_CmsSetupXmlUpdate

参数:

setupBean - the setup bean

返回:

true if needed

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

I_CmsSetupXmlUpdate.validate(org.opencms.setup.CmsSetupBean)

executeUpdate

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

Executes the adding/updating changes on the given document.

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

参数:

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

getCommonPath

protected java.lang.String getCommonPath()

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

返回:

common parent path

getXPathsToRemove

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

Returns a list of xpaths for the nodes to remove.

返回:

a list of strings

getXPathsToUpdate

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

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

返回:

a list of strings

prepareDoc

protected org.dom4j.Document prepareDoc(org.dom4j.Document doc)

Prepares a new document.

参数:

doc - the original document

返回:

a new document

updateDoc

protected void updateDoc(org.dom4j.Document document,
             org.dom4j.Document newDoc,
             java.lang.String xpath)

Updates the given doc inserting the given node corresponding to the given xpath.

参数:

document - the original document to update

newDoc - the document to update

xpath - the corresponding xpath

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