org.opencms.setup.xml

类 CmsSetupXmlHelper

java.lang.Object

org.opencms.setup.xml.CmsSetupXmlHelper

public class CmsSetupXmlHelper
extends java.lang.Object

Helper class to modify xml files.

For more info about xpath see:

• http://www.w3.org/TR/xpath.html
• http://www.zvon.org/xxl/XPathTutorial/General/examples.html

从以下版本开始:

6.1.8

构造器概要

构造器

构造器和说明
CmsSetupXmlHelper() Default constructor.
CmsSetupXmlHelper(java.lang.String basePath) Uses an optional base file path.

方法概要

方法

限定符和类型	方法和说明
void	flush(java.lang.String xmlFilename) Discards the changes in the given file.
void	flushAll() Discards the changes in all files.
static java.lang.String	format(java.lang.String xml) Unmarshals (reads) an XML string into a new document.
java.lang.String	getBasePath() Returns the base file Path.
org.dom4j.Document	getDocument(java.lang.String xmlFilename) Returns the document for the given filename.
static java.lang.String	getValue(org.dom4j.Document document, java.lang.String xPath) Returns the value in the given xpath of the given xml file.
java.lang.String	getValue(java.lang.String xmlFilename, java.lang.String xPath) Returns the value in the given xpath of the given xml file.
static boolean	setAttribute(org.dom4j.Document document, java.lang.String xPath, java.lang.String attribute, java.lang.String value) Replaces a attibute's value in the given node addressed by the xPath.
boolean	setAttribute(java.lang.String xmlFilename, java.lang.String xPath, java.lang.String attribute, java.lang.String value) Replaces a attibute's value in the given node addressed by the xPath.
static int	setValue(org.dom4j.Document document, java.lang.String xPath, java.lang.String value) Sets the given value in all nodes identified by the given xpath of the given xml file.
static int	setValue(org.dom4j.Document document, java.lang.String xPath, java.lang.String value, java.lang.String nodeToInsert) Sets the given value in all nodes identified by the given xpath of the given xml file.
int	setValue(java.lang.String xmlFilename, java.lang.String xPath, java.lang.String value) Sets the given value in all nodes identified by the given xpath of the given xml file.
int	setValue(java.lang.String xmlFilename, java.lang.String xPath, java.lang.String value, java.lang.String nodeToInsert) Sets the given value in all nodes identified by the given xpath of the given xml file.
void	write(java.lang.String xmlFilename) Writes the given file back to disk.
void	writeAll() Flushes all cached documents.

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

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

构造器详细资料

CmsSetupXmlHelper

public CmsSetupXmlHelper()

Default constructor.

Uses no base path.

CmsSetupXmlHelper

public CmsSetupXmlHelper(java.lang.String basePath)

Uses an optional base file path.

参数:

basePath - the base file path to use;

方法详细资料

format

public static java.lang.String format(java.lang.String xml)
                               throws CmsXmlException

Unmarshals (reads) an XML string into a new document.

参数:

xml - the XML code to unmarshal

返回:

the generated document

抛出:

CmsXmlException - if something goes wrong

getValue

public static java.lang.String getValue(org.dom4j.Document document,
                        java.lang.String xPath)

Returns the value in the given xpath of the given xml file.

参数:

document - the xml document

xPath - the xpath to read (should select a single node or attribute)

返回:

the value in the given xpath of the given xml file, or null if no matching node

setAttribute

public static boolean setAttribute(org.dom4j.Document document,
                   java.lang.String xPath,
                   java.lang.String attribute,
                   java.lang.String value)

Replaces a attibute's value in the given node addressed by the xPath.

参数:

document - the document to replace the node attribute

xPath - the xPath to the node

attribute - the attribute to replace the value of

value - the new value to set

返回:

true if successful false otherwise

setValue

public static int setValue(org.dom4j.Document document,
           java.lang.String xPath,
           java.lang.String value)

Sets the given value in all nodes identified by the given xpath of the given xml file.

If value is null, all nodes identified by the given xpath will be deleted.

If the node identified by the given xpath does not exists, the missing nodes will be created (if value not null).

参数:

document - the xml document

xPath - the xpath to set

value - the value to set (can be null for deletion)

返回:

the number of successful changed or deleted nodes

setValue

public static int setValue(org.dom4j.Document document,
           java.lang.String xPath,
           java.lang.String value,
           java.lang.String nodeToInsert)

Sets the given value in all nodes identified by the given xpath of the given xml file.

If value is null, all nodes identified by the given xpath will be deleted.

If the node identified by the given xpath does not exists, the missing nodes will be created (if value not null).

参数:

document - the xml document

xPath - the xpath to set

value - the value to set (can be null for deletion)

nodeToInsert - optional, if given it will be inserted after xPath with the given value

返回:

the number of successful changed or deleted nodes

flush

public void flush(java.lang.String xmlFilename)

Discards the changes in the given file.

参数:

xmlFilename - the xml config file (could be relative to the base path)

flushAll

public void flushAll()

Discards the changes in all files.

getBasePath

public java.lang.String getBasePath()

Returns the base file Path.

返回:

the base file Path

getDocument

public org.dom4j.Document getDocument(java.lang.String xmlFilename)
                               throws CmsXmlException

Returns the document for the given filename.

It can be new read or come from the document cache.

参数:

xmlFilename - the filename to read

返回:

the document for the given filename

抛出:

CmsXmlException - if something goes wrong while reading

getValue

public java.lang.String getValue(java.lang.String xmlFilename,
                        java.lang.String xPath)
                          throws CmsXmlException

Returns the value in the given xpath of the given xml file.

参数:

xmlFilename - the xml config file (could be relative to the base path)

xPath - the xpath to read (should select a single node or attribute)

返回:

the value in the given xpath of the given xml file, or null if no matching node

抛出:

CmsXmlException - if something goes wrong while reading

setAttribute

public boolean setAttribute(java.lang.String xmlFilename,
                   java.lang.String xPath,
                   java.lang.String attribute,
                   java.lang.String value)
                     throws CmsXmlException

Replaces a attibute's value in the given node addressed by the xPath.

参数:

xmlFilename - the xml file name to get the document from

xPath - the xPath to the node

attribute - the attribute to replace the value of

value - the new value to set

返回:

true if successful false otherwise

抛出:

CmsXmlException - if the xml document coudn't be read

setValue

public int setValue(java.lang.String xmlFilename,
           java.lang.String xPath,
           java.lang.String value)
             throws CmsXmlException

Sets the given value in all nodes identified by the given xpath of the given xml file.

If value is null, all nodes identified by the given xpath will be deleted.

If the node identified by the given xpath does not exists, the missing nodes will be created (if value not null).

参数:

xmlFilename - the xml config file (could be relative to the base path)

xPath - the xpath to set

value - the value to set (can be null for deletion)

返回:

the number of successful changed or deleted nodes

抛出:

CmsXmlException - if something goes wrong

setValue

public int setValue(java.lang.String xmlFilename,
           java.lang.String xPath,
           java.lang.String value,
           java.lang.String nodeToInsert)
             throws CmsXmlException

Sets the given value in all nodes identified by the given xpath of the given xml file.

If value is null, all nodes identified by the given xpath will be deleted.

If the node identified by the given xpath does not exists, the missing nodes will be created (if value not null).

参数:

xmlFilename - the xml config file (could be relative to the base path)

xPath - the xpath to set

value - the value to set (can be null for deletion)

nodeToInsert - optional, if given it will be inserted after xPath with the given value

返回:

the number of successful changed or deleted nodes

抛出:

CmsXmlException - if something goes wrong

write

public void write(java.lang.String xmlFilename)
           throws CmsXmlException

Writes the given file back to disk.

参数:

xmlFilename - the xml config file (could be relative to the base path)

抛出:

CmsXmlException - if something wrong while writing

writeAll

public void writeAll()
              throws CmsXmlException

Flushes all cached documents.

抛出:

CmsXmlException - if something wrong while writing