com.seleniumtests.xmldog

Class XMLUtil

java.lang.Object

com.seleniumtests.xmldog.XMLUtil

All Implemented Interfaces:

XMLDogConstants

public class XMLUtil
extends Object
implements XMLDogConstants

Field Summary

Fields inherited from interface com.seleniumtests.xmldog.XMLDogConstants

APP_NAME, DEBUG, EVENT_NODE_IDENTICAL, EVENT_NODE_MISMATCH, EVENT_NODE_SIMILAR

Constructor Summary

Constructors

Constructor and Description
XMLUtil() Default Constructor

Method Summary

Modifier and Type	Method and Description
static boolean	areNonNullAndEqual(Object obj1, Object obj2) Checks if the input Objects are Non NULL and Equal
static boolean	areNullorEqual(Object obj1, Object obj2, boolean ignoreWhitespace, boolean ignoreCase) Checks if both the Object arguments are equal (including if they are null)
static String	generateXPath(Node node, boolean ignoreWhitespace) Generates XPath expression for the given node, relative to the Root of the Document
static String	generateXPath(Node node, boolean ignoreWhitespace, boolean noValues) Generates XPath expression with the option of the Node values and Node indexes are included
static String	generateXPath(Node node, boolean ignoreWhitespace, boolean includeValues, boolean noIndex) Generates XPath expression with the option of the Node values appended
static String	generateXPath(Node node, String parentXPath, boolean ignoreWhitespace, boolean includeValues, boolean noIndex) Generates XPath expression with the option of the Node values appended
static String	generateXPath(String childXPath) Gets parent XPath from the child XPath XPath string is obtained by stripping all the characters from the last "/" character
static Document	getDocument(String docPath) Gets XML Document for a given document path
static String	getNodeBasics(Node node) Gets Nodes basic information such as Node name, type, value, namespace and local name
static String	getNodeTypeStr(int nodeType) Gets Node type String for a given node type constant
static String	getNoIndexXPath(String xPath) Gets XPath expression without the indexes
static List	getSimilarChildNodes(Node parent, Node testNode, boolean ignoreWhitespace) Gets Nodes identical to a given test Node for a given parent Node
static List	getSimilarChildXNodes(Node parent, Node testNode, boolean ignoreWhitespace) Gets XNodes identical to a given test Node for a given parent Node XNode in this case is used to store the position of the Node under the parent
static String	getText(Node node) � * Return the text that a node contains.
static int	getXPathNodeIndex(Node node, boolean ignoreWhitespace) Gets Node Index value for the XPath expression e.g.
static boolean	isCommentNode(Node node) Checks if the given Node is Comment Node
static boolean	isStrElementNode(String elementName, Node elementNode, boolean ignoreCase) Checks if Element Node is same as a Element name String
static boolean	isWhitespaceTextNode(Node node) Checks if the Node is Text Node and contains Whitespace only
static void	log(String msg) Prints msg to System.out
static void	log(String msg, Throwable t) Prints msg and Exception to System.out
static void	main(String[] args) Main method used for debugging purpose only
static boolean	nodesEqual(Node node1, Node node2, boolean ignoreWhitespace) Checks if two Nodes are equal Compares Nodes just by their Name, Type, Value and Namespace generically
static boolean	nodesSimilar(Node node1, Node node2, boolean ignoreWhitespace) Checks if two Nodes are Similar Compares Nodes just by their Name, Type, local name and Namespace generically
protected static String	normalize(String s, boolean canonical) Normalizes a given string
static String	print(Node node, boolean canonical, boolean normalize) Gets String representation of a given Node
static void	printNodeBasics(Node node) Prints a given Node For debugging purpose only
static Node	removeChildren(Node node) Removes all the children of a given Node
static void	removeLeafNode(Node node) Removes the Leaf Node
static String	replaceElementText(String xmlFile, Map elements, boolean all, boolean overwrite) Replaces Elements subtree with the text value in the XML document IMPORTANT!! This method removes entire subtree of all the Elements and puts the text as a child node.
static String	replaceElementText(String xmlFile, String elementTag, List values, boolean overwrite) Replaces Elements subtree with the text value in the XML document IMPORTANT!! This method removes entire subtree of all the Elements and puts the text as a child node.
static String	replaceElementText(String xmlFile, String tagName, String value, boolean all, boolean overwrite) Replaces Elements subtree with the text value in the XML document IMPORTANT!! This method removes entire subtree of the Element and puts the text as a child node.
protected static Attr[]	sortAttributes(NamedNodeMap attrs) Sorts Attributes of a given Node

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtil

public XMLUtil()

Default Constructor

Method Detail

getSimilarChildNodes

public static List getSimilarChildNodes(Node parent,
                                        Node testNode,
                                        boolean ignoreWhitespace)

Gets Nodes identical to a given test Node for a given parent Node

getSimilarChildXNodes

public static List getSimilarChildXNodes(Node parent,
                                         Node testNode,
                                         boolean ignoreWhitespace)

Gets XNodes identical to a given test Node for a given parent Node

XNode in this case is used to store the position of the Node under the parent

replaceElementText

public static String replaceElementText(String xmlFile,
                                        String tagName,
                                        String value,
                                        boolean all,
                                        boolean overwrite)
                                 throws DOMException

Replaces Elements subtree with the text value in the XML document

IMPORTANT!! This method removes entire subtree of the Element and puts the text as a child node.

Use this method when only one Element tag needs to be changed in the XML file.

Parameters:

xmlFile - the fully qualified name of the XML file

tagName - the element tag whose text needs to be changed

value - the new text value for the Element

all - true if all the matching Elements values needs to be changed, false otherwise

overwrite - true if File needs to be overwritten with the changes, false otherwise

Returns:

the String representation of the new XML document with elements replaced

if successful, null otherwise

Throws:

DOMException

getDocument

public static Document getDocument(String docPath)
                            throws SAXException,
                                   IOException

Gets XML Document for a given document path

Parameters:

docPath - the path to the XML file

Returns:

the XML Document object

Throws:

SAXException

IOException

See Also:

Document

replaceElementText

public static String replaceElementText(String xmlFile,
                                        Map elements,
                                        boolean all,
                                        boolean overwrite)
                                 throws DOMException

Replaces Elements subtree with the text value in the XML document

IMPORTANT!! This method removes entire subtree of all the Elements and puts the text as a child node.

Use this method when multiple Element tags needs to be changed in the XML file.

Parameters:

xmlFile - the fully qualified name of the XML file

elements - the Map containing Element tag names and corresponding Text values

all - true if all the matching Elements values needs to be changed, false otherwise

overwrite - true if File needs to be overwritten with the changes, false otherwise

Returns:

the String representation of the new XML document with all the Elements replaced

Throws:

DOMException

replaceElementText

public static String replaceElementText(String xmlFile,
                                        String elementTag,
                                        List values,
                                        boolean overwrite)
                                 throws DOMException

Replaces Elements subtree with the text value in the XML document

IMPORTANT!! This method removes entire subtree of all the Elements and puts the text as a child node.

Use this method when multiple OCCRENCES of the Element tags needs to be changed with one value each

from the values list in that order in the XML file.

Parameters:

xmlFile - the fully qualified name of the XML file

elementTag - the Element tag whose value is to be changed

values - the List containing values for each occerence of the Element tag

overwrite - true if File needs to be overwritten with the changes, false otherwise

Returns:

the String representation of the new XML document with all the Elements replaced

Throws:

DOMException

removeChildren

public static Node removeChildren(Node node)

Removes all the children of a given Node

Parameters:

node - the Node whose children is to be removed

Returns:

Node after the children removed

getText

public static String getText(Node node)

� * Return the text that a node contains. This routine:

� *

• Ignores comments and processing instructions.

  � *

• Concatenates TEXT nodes, CDATA nodes, and the results of

  � * recursively processing EntityRef nodes.

  � *

• Ignores any element nodes in the sublist.

  � * (Other possible options are to recurse into element sublists

  � * or throw an exception.)

  � *

� * @param node a DOM node

� * @return a String representing its contents

�

print

public static String print(Node node,
                           boolean canonical,
                           boolean normalize)

Gets String representation of a given Node

Parameters:

node - the Node to be converted to string

canonical - the flag to indicate if conversion is canonical or not

normalize - true if normalized document is to be returned, false otherwise

Normalized document means all the special characters in the document are replaced with their

corresponding Entity References

Returns:

the String representation of Node

normalize

protected static String normalize(String s,
                                  boolean canonical)

Normalizes a given string

Parameters:

s - the String to be normalized

sortAttributes

protected static Attr[] sortAttributes(NamedNodeMap attrs)

Sorts Attributes of a given Node

Parameters:

attrs - the NamedNodeMap containing Node Attributes

Returns:

Array containing sorted Attributes

generateXPath

public static String generateXPath(String childXPath)

Gets parent XPath from the child XPath

XPath string is obtained by stripping all the characters from the last

"/" character

Parameters:

childXPath - the child XPath

generateXPath

public static String generateXPath(Node node,
                                   boolean ignoreWhitespace)

Generates XPath expression for the given node, relative to the Root of the Document

generateXPath

public static String generateXPath(Node node,
                                   boolean ignoreWhitespace,
                                   boolean noValues)

Generates XPath expression with the option of the Node values and Node indexes are included

Parameters:

node - the Node whose XPath is to be found

ignoreWhitespace - the flag to indicate if Whitespace will be ignored

noValues - the flag to indicate if Node values will be included

Returns:

the XPath string representation of the Node

generateXPath

public static String generateXPath(Node node,
                                   boolean ignoreWhitespace,
                                   boolean includeValues,
                                   boolean noIndex)

Generates XPath expression with the option of the Node values appended

Parameters:

node - the Node whose XPath is to be found

ignoreWhitespace - the flag to indicate if Whitespace will be ignored

includeValues - the flag to indicate if Node values will be included

noIndex - the flag to indicate if Node indexes are included

Returns:

the XPath string representation of the Node

generateXPath

public static String generateXPath(Node node,
                                   String parentXPath,
                                   boolean ignoreWhitespace,
                                   boolean includeValues,
                                   boolean noIndex)

Generates XPath expression with the option of the Node values appended

Parameters:

node - the Node whose XPath is to be found

parentXPath - the XPath of the parent Node

ignoreWhitespace - the flag to indicate if Whitespace will be ignored

includeValues - the flag to indicate if Node values will be included

noIndex - the flag to indicate if Node indexes are included

Returns:

the XPath string representation of the Node

getNoIndexXPath

public static String getNoIndexXPath(String xPath)

Gets XPath expression without the indexes

Parameters:

xPath - the XPath expression with indexes

getXPathNodeIndex

public static int getXPathNodeIndex(Node node,
                                    boolean ignoreWhitespace)

Gets Node Index value for the XPath expression

e.g. riteshtrivedi calling

getXPathNodeIndex for Node with value

trivedi would return 2

nodesEqual

public static boolean nodesEqual(Node node1,
                                 Node node2,
                                 boolean ignoreWhitespace)

Checks if two Nodes are equal

Compares Nodes just by their Name, Type, Value and Namespace generically

nodesSimilar

public static boolean nodesSimilar(Node node1,
                                   Node node2,
                                   boolean ignoreWhitespace)

Checks if two Nodes are Similar

Compares Nodes just by their Name, Type, local name and Namespace generically

printNodeBasics

public static void printNodeBasics(Node node)

Prints a given Node

For debugging purpose only

getNodeBasics

public static String getNodeBasics(Node node)

Gets Nodes basic information such as Node name, type, value, namespace

and local name

removeLeafNode

public static void removeLeafNode(Node node)

Removes the Leaf Node

getNodeTypeStr

public static String getNodeTypeStr(int nodeType)

Gets Node type String for a given node type constant

isWhitespaceTextNode

public static boolean isWhitespaceTextNode(Node node)

Checks if the Node is Text Node and contains Whitespace only

isCommentNode

public static boolean isCommentNode(Node node)

Checks if the given Node is Comment Node

isStrElementNode

public static boolean isStrElementNode(String elementName,
                                       Node elementNode,
                                       boolean ignoreCase)

Checks if Element Node is same as a Element name String

areNullorEqual

public static boolean areNullorEqual(Object obj1,
                                     Object obj2,
                                     boolean ignoreWhitespace,
                                     boolean ignoreCase)

Checks if both the Object arguments are equal (including if they are null)

areNonNullAndEqual

public static boolean areNonNullAndEqual(Object obj1,
                                         Object obj2)

Checks if the input Objects are Non NULL and Equal

log

public static void log(String msg)

Prints msg to System.out

log

public static void log(String msg,
                       Throwable t)

Prints msg and Exception to System.out

main

public static void main(String[] args)

Main method used for debugging purpose only