org.mdiutil.xml.tree

Class XMLTreeReplacer

java.lang.Object

org.mdiutil.xml.tree.XMLTreeReplacer

public class XMLTreeReplacer
extends Object

This class allows to change the attributes of some nodes in a XML document.

• The XMLTreeReplacer.NodePath element represent one path in the XML tree
• The XMLTreeReplacer.Node element represent one element in the XML tree. A node can specify one or several attribute change for this element

Examples

Suppose the following XML file:

 <root desc="example">
   <element name="first">
     <element name="second"/>
     <element name="third"/>
   </element>
 </root>
 

And the NodePath:

 NodePath path = new NodePath();
 path.addNode("root");
 path.addNode("element");
 Node node = path.addNode("element", 1);
 node.setAttribute("name", "changed");
 

Then the result of the replace(java.io.File, java.io.File, org.mdiutil.xml.tree.XMLTreeReplacer.NodePath...) with the NodePath will be:

 <root desc="example">
   <element name="first">
     <element name="second"/>
     <element name="changed"/>
   </element>
 </root>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLTreeReplacer.Node A node in an XML document.
static class	XMLTreeReplacer.NodePath A path in an XML document.

Constructor Summary

Constructors

Constructor and Description
XMLTreeReplacer()

Method Summary

Modifier and Type	Method and Description
int	getTab() Return the tabulation for the XML file for each child node
boolean	replace(File inputFile, File outputFile, XMLTreeReplacer.NodePath... paths) Replace the attributes of some nodes in a XML document.
boolean	replace(URL inputURL, URL outputURL, XMLTreeReplacer.NodePath... paths) Replace the attributes of some nodes in a XML document.
boolean	replace(XMLNode root, File outputFile, XMLTreeReplacer.NodePath... paths) Replace the attributes of some nodes in a XML document.
boolean	replace(XMLNode root, URL outputURL, XMLTreeReplacer.NodePath... paths) Replace the attributes of some nodes in a XML document.
XMLNode	replace(XMLNode root, XMLTreeReplacer.NodePath... paths) Replace the attributes of some nodes in a XML document.
void	setTab(int tab) Set the tabulation for the XML file for each child node

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLTreeReplacer

public XMLTreeReplacer()

Method Detail

setTab

public void setTab(int tab)

Set the tabulation for the XML file for each child node

Parameters:

tab - the tabulation

getTab

public int getTab()

Return the tabulation for the XML file for each child node

Returns:

the tabulation

replace

public boolean replace(XMLNode root,
                       File outputFile,
                       XMLTreeReplacer.NodePath... paths)
                throws IOException

Replace the attributes of some nodes in a XML document.

Parameters:

root - the root of the XML document

outputFile - the ouput file

paths - the list of paths to change

Returns:

true if the replacement could be performed

Throws:

IOException

replace

public boolean replace(File inputFile,
                       File outputFile,
                       XMLTreeReplacer.NodePath... paths)
                throws IOException

Replace the attributes of some nodes in a XML document.

Parameters:

inputFile - the input XML document

outputFile - the ouput file

paths - the list of paths to change

Returns:

true if the replacement could be performed

Throws:

IOException

replace

public boolean replace(URL inputURL,
                       URL outputURL,
                       XMLTreeReplacer.NodePath... paths)
                throws IOException

Replace the attributes of some nodes in a XML document.

Parameters:

inputURL - the input XML document

outputURL - the ouput URL

paths - the list of paths to change

Returns:

true if the replacement could be performed

Throws:

IOException

replace

public boolean replace(XMLNode root,
                       URL outputURL,
                       XMLTreeReplacer.NodePath... paths)
                throws IOException

Replace the attributes of some nodes in a XML document.

Parameters:

root - the root of the XML document

outputURL - the ouput URL

paths - the list of paths to change

Returns:

true if the replacement could be performed

Throws:

IOException

replace

public XMLNode replace(XMLNode root,
                       XMLTreeReplacer.NodePath... paths)
                throws IOException

Replace the attributes of some nodes in a XML document. The initial root will not be modified, but the result will be a copy of the input root with the changed attributes.

Parameters:

root - the root of the XML document

paths - the list of paths to change

Returns:

true if the replacement could be performed

Throws:

IOException