com.bmc.arsys.plugins.ftsconfig.helper.shared

Class XMLParser

java.lang.Object

com.bmc.arsys.plugins.ftsconfig.helper.shared.XMLParser

public class XMLParser
extends Object

Gives XML edit and get methods. All needed is the file name and the XPath. Works on the first occurance of the XPath only.
String filename = "c:\\a.xml";
String xpath = "/Domain";
try
{
XMLParser parser = new XMLParser( filename );
parser.addElementToElement( xpath, "component" );
parser.addAttributeToElement( xpath + "/component", "name", "libraryTable" );
parser.addElementToElement( xpath + "/component", "CLASSES" );
parser.addElementToElement( xpath + "/component/CLASSES", "root" );
parser.addAttributeToElement( xpath + "/component/CLASSES/root", "url", "jar://C:/castor.jar!/" );
parser.commit();
}
catch ( Exception e )
{
// handle error
}

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISO_8859_1

Constructor Summary

Constructors

Constructor and Description
XMLParser(File file)
XMLParser(InputStream file) Constructor for XMLParser Use this constructor only for read actions (not for write)
XMLParser(String fileName) Constructor for XMLParser

Method Summary

Modifier and Type	Method and Description
void	addAttributeToElement(String xpathString, String name, String value) Add an Attribute to a node
void	addElementAfterElement(String xpathString, String element, String value) Adds an element after an element
void	addElementAfterElement(String xpathString, String element, String value, String attributeName, String attributeValue) Adds an element after an element
void	addElementToElement(String xpathString, String element) Add an Element to a node
void	addElementToElement(String xpathString, String element, String value) Add an Element to a node
void	addElementToElement(String xpathString, String element, String value, String attributeName, String attributeValue) Adds an element to an element
void	appendNode(String xpathString, Node node) Appends the node to the childList of the node given by the xpath
void	commit() Commit a set operation to the xml file
void	commitWithDTD(String dtdFile) Commits with a DTD
String	getCharset() Gets the character set
Indentation	getIndentation() Gets the indentation
Node	getNode(String xpathString) Gets the Node
List<Node>	getNodeList(String xpathString) Gets the node list
List<String>	getNodesAttributes(String xpathString, String attributeName) Gets attributes matched under xpathString and having name attribute name
List<String>	getNodesValue(String xpathString) Gets the value of a node from an XPath
String	getNodeValue(String xpathString) Get a node value
void	removeNode(String xpathString) Remove a Node
void	setCharset(String charset) Sets the character set
void	setIndentation(Indentation indentation) Sets the indentation
void	updateNodesValue(String xpathString, List<String> values) Updates a node's value
void	updateNodeValue(String xpathString, String value) Update a node value

Methods inherited from class java.lang.Object

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

Field Detail

ISO_8859_1

public static final String ISO_8859_1

See Also:

Constant Field Values

Constructor Detail

XMLParser

public XMLParser(String fileName)
          throws Exception

Constructor for XMLParser

Parameters:

fileName - XML file to parse

Throws:

Exception - for any errors

XMLParser

public XMLParser(File file)
          throws Exception

Throws:

Exception

XMLParser

public XMLParser(InputStream file)
          throws Exception

Constructor for XMLParser Use this constructor only for read actions (not for write)

Parameters:

file - XML file to parse

Throws:

Exception - for any errors

Method Detail

getIndentation

public Indentation getIndentation()

Gets the indentation

Returns:

indentation

setIndentation

public void setIndentation(Indentation indentation)

Sets the indentation

Parameters:

indentation - indentation

getCharset

public String getCharset()

Gets the character set

Returns:

character set

setCharset

public void setCharset(String charset)

Sets the character set

Parameters:

charset - character set

getNodeList

public List<Node> getNodeList(String xpathString)
                       throws Exception

Gets the node list

Parameters:

xpathString - XPath expression

Returns:

node list

Throws:

Exception - for any errors

getNodesValue

public List<String> getNodesValue(String xpathString)
                           throws Exception

Gets the value of a node from an XPath

Parameters:

xpathString - XPath expression

Returns:

value of node pointed to by xpathString

Throws:

Exception - for any errors

getNodesAttributes

public List<String> getNodesAttributes(String xpathString,
                                       String attributeName)
                                throws Exception

Gets attributes matched under xpathString and having name attribute name

Parameters:

xpathString - XPath expression

attributeName - attribute name

Returns:

attributes matched under xpathString and having attribute name

Throws:

Exception - for any errors

getNodeValue

public String getNodeValue(String xpathString)
                    throws Exception

Get a node value

Parameters:

xpathString - XPath expression

Returns:

value of the node

Throws:

Exception - for any errors

updateNodesValue

public void updateNodesValue(String xpathString,
                             List<String> values)
                      throws Exception

Updates a node's value

Parameters:

xpathString - XPath expression

values - values to replace matches returned by xpathString

Throws:

Exception - for any errors

updateNodeValue

public void updateNodeValue(String xpathString,
                            String value)
                     throws Exception

Update a node value

Parameters:

xpathString - XPath expression

value - the new value for the node

Throws:

Exception - for any errors

addAttributeToElement

public void addAttributeToElement(String xpathString,
                                  String name,
                                  String value)
                           throws Exception

Add an Attribute to a node

Parameters:

xpathString - XPath expression

name - attribute name

value - attribute value

Throws:

Exception - for any errors

addElementToElement

public void addElementToElement(String xpathString,
                                String element)
                         throws Exception

Add an Element to a node

Parameters:

xpathString - XPath expression

element - element

Throws:

Exception - for any errors

addElementToElement

public void addElementToElement(String xpathString,
                                String element,
                                String value)
                         throws Exception

Add an Element to a node

Parameters:

xpathString - XPath expression

element - element

value - new value for the new node

Throws:

Exception - for any errors

addElementToElement

public void addElementToElement(String xpathString,
                                String element,
                                String value,
                                String attributeName,
                                String attributeValue)
                         throws Exception

Adds an element to an element

Parameters:

xpathString - XPath expression

element - element

value - value

attributeName - attribute name

attributeValue - attribute value

Throws:

Exception - for any errors

addElementAfterElement

public void addElementAfterElement(String xpathString,
                                   String element,
                                   String value)
                            throws Exception

Adds an element after an element

Parameters:

xpathString - XPath expression

element - element

value - value

Throws:

Exception - for any errors

addElementAfterElement

public void addElementAfterElement(String xpathString,
                                   String element,
                                   String value,
                                   String attributeName,
                                   String attributeValue)
                            throws Exception

Adds an element after an element

Parameters:

xpathString - XPath expression

element - element

value - value

attributeName - attribute name

attributeValue - attribute value

Throws:

Exception - for any errors

appendNode

public void appendNode(String xpathString,
                       Node node)
                throws Exception

Appends the node to the childList of the node given by the xpath

Parameters:

xpathString - XPath expression

node - Node to append

Throws:

Exception - for any errors

getNode

public Node getNode(String xpathString)
             throws Exception

Gets the Node

Parameters:

xpathString - XPath expression

Returns:

Node

Throws:

Exception - for any errors

removeNode

public void removeNode(String xpathString)
                throws Exception

Remove a Node

Parameters:

xpathString - XPath expression

Throws:

Exception - for any errors

commit

public void commit()

Commit a set operation to the xml file

commitWithDTD

public void commitWithDTD(String dtdFile)

Commits with a DTD

Parameters:

dtdFile - DTD file