com.seleniumtests.xmldog

Class Comparator

java.lang.Object

com.seleniumtests.xmldog.Comparator

All Implemented Interfaces:

XMLDogConstants

public class Comparator
extends Object
implements XMLDogConstants

Comparator class containing the Core of XML Comparison Engine.

Comparison Engine takes each Test Document Node and tries and find the Control/Golden

Document Node which is a Best fit

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
Comparator() Default Contructor.
Comparator(Node controlNode, Node testNode, Config config) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addDifferenceListener(DifferenceListener listener) Adds DifferenceListener.
Differences	compare() Compares Control and Test nodes.
Differences	compare(Node controlNode, Node testNode) Compares nodes and its children recursively.
protected NodeResult	compareAttributes(XNode xControl, XNode xTest) FIXME FIXME FIXME!! Refactor above function to reduce the complexity and put compare attributes here Compares Attribute Nodes
protected NodeResult	compareCDATA(XNode xControl, XNode xTest) Compares CDATASECTION Nodes.
protected Differences	compareChildNodes(XNode xControl, XNode xTest) Compares all the Child Nodes for given Control and Test Nodes recursively.
protected NodeResult	compareComments(XNode xControl, XNode xTest) Compares Comment Nodes.
protected NodeResult	compareDocumentType(XNode xControl, XNode xTest) Compares DocumentType Node.
protected NodeResult	compareElements(XNode xControl, XNode xTest) Compares Control and Test Element nodes.
protected NodeResult	compareEntityRefs(XNode xControl, XNode xTest) Compares Entity Reference Nodes.
protected NodeResult	compareSimilarNodes(XNode xControl, XNode xTest, OrderedMap nodeTracker) Compares Nodes similar to the ones which are input and returns the one.
protected NodeResult	compareText(XNode xControl, XNode xTest) Compares Text Nodes.
Node	getControlNode() Gets Control Node.
Node	getTestNode() Gets Test Node.
protected boolean	isIgnoringWhitespace() Convenience method to check if the whitespace is being ignored.
static void	log(String msg) Prints msg to System.out.
static void	log(String msg, Throwable t) Prints msg and Exception to System.out.
void	overrideDifferenceListener(DifferenceListener listener) Overrides DifferenceListener. Method will clear all the DifferenceListeners and put only one DifferenceListener passed as an argument
void	setControlNode(Node controlNode) Sets Control Node.
void	setTestNode(Node testNode) Sets Test Node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Comparator

public Comparator()

Default Contructor.

Comparator

public Comparator(Node controlNode,
                  Node testNode,
                  Config config)

Constructor.

Parameters:

controlDoc - the Control Document to compare test Document against

testDoc - the test Document to be compared for differences

Method Detail

addDifferenceListener

public void addDifferenceListener(DifferenceListener listener)

Adds DifferenceListener.

overrideDifferenceListener

public void overrideDifferenceListener(DifferenceListener listener)

Overrides DifferenceListener.

Method will clear all the DifferenceListeners and put only one

DifferenceListener passed as an argument

setControlNode

public void setControlNode(Node controlNode)

Sets Control Node.

getControlNode

public Node getControlNode()

Gets Control Node.

setTestNode

public void setTestNode(Node testNode)

Sets Test Node.

getTestNode

public Node getTestNode()

Gets Test Node.

isIgnoringWhitespace

protected boolean isIgnoringWhitespace()

Convenience method to check if the whitespace is being ignored.

compare

public Differences compare()

Compares Control and Test nodes.

compare

public Differences compare(Node controlNode,
                           Node testNode)

Compares nodes and its children recursively.

Parameters:

control - the control Node

test - the test Node

Returns:

the Differences between two Nodes

See Also:

Differences

compareSimilarNodes

protected NodeResult compareSimilarNodes(XNode xControl,
                                         XNode xTest,
                                         OrderedMap nodeTracker)

Compares Nodes similar to the ones which are input and returns the one.

that is the BEST fit

OrderedMap is used for information such as which control Nodes are already

visited and which test Nodes match a given control Node

For a given test Node and control Node set, similar Nodes are found using the parent

of the control Node which closely match a given test Node and only the Node matching most

closely to the test Node is returned

Parameters:

control - the control Node

test - the test Node

nodeTracker - the OrderedMap which contains control Nodes already visited as keys and

all the matching test Nodes as the values

Returns:

the NodeResult containing the Differences between two Nodes

See Also:

NodeResult

compareDocumentType

protected NodeResult compareDocumentType(XNode xControl,
                                         XNode xTest)

Compares DocumentType Node.

Parameters:

control - the control DOCTYPE Node

test - the test DOCTYPE Node

Returns:

the NodeResult containing the Differences between two DOCTYPE Nodes

See Also:

NodeResult

compareComments

protected NodeResult compareComments(XNode xControl,
                                     XNode xTest)

Compares Comment Nodes.

Parameters:

control - the control Comment Node

test - the test Comment Node

Returns:

the NodeResult containing the Differences between two Comment Nodes

See Also:

NodeResult

compareCDATA

protected NodeResult compareCDATA(XNode xControl,
                                  XNode xTest)

Compares CDATASECTION Nodes.

Parameters:

control - the control CDATA Node

test - the test CDATA Node

Returns:

the NodeResult containing the Differences between two CDATA Nodes

See Also:

NodeResult

compareEntityRefs

protected NodeResult compareEntityRefs(XNode xControl,
                                       XNode xTest)

Compares Entity Reference Nodes.

Parameters:

control - the control EntityRef Node

test - the test EntityRef Node

Returns:

the NodeResult containing the Differences between two EntityRef Nodes

See Also:

NodeResult

compareText

protected NodeResult compareText(XNode xControl,
                                 XNode xTest)

Compares Text Nodes.

Parameters:

control - the control Text Node

test - the test Text Node

Returns:

the NodeResult containing the Differences between two Text Nodes

See Also:

NodeResult

compareElements

protected NodeResult compareElements(XNode xControl,
                                     XNode xTest)

Compares Control and Test Element nodes.

While comparing Element nodes, all the Attributes as well as Children of the Element nodes

are compared recursively

Parameters:

control - the control Element Node

test - the test Element Node

Returns:

the NodeResult containing the Differences between two Element Node subtree

See Also:

NodeResult

compareAttributes

protected NodeResult compareAttributes(XNode xControl,
                                       XNode xTest)

FIXME FIXME FIXME!!

Refactor above function to reduce the complexity and put compare attributes here

Compares Attribute Nodes

compareChildNodes

protected Differences compareChildNodes(XNode xControl,
                                        XNode xTest)

Compares all the Child Nodes for given Control and Test Nodes recursively.

Reports differences between the entire subtree till the leaf nodes for

control and test Nodes

Parameters:

controlNode - the control Node

testNode - the test Node

Returns:

the Differences between control Node and test Node

See Also:

Differences

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.